mirror of https://github.com/minetest/irrlicht.git synced 2024-11-13 14:00:27 +01:00

Minetest's fork of Irrlicht

Go to file

jordan4ibanez 08d226cdb5 Fix indices, inverted models, & multiple models failing to load Fix embedded textures causing a model not to load Add todo Add another todo Push current (broken) prototyping Fix missing bracket Make a single array object work Convert hard array into dynamic vector Simplify semantics Remove "new" Add blocker for vscode environment changes Disable non-dynamic prototyping Add comment Add more informative debug & disable it Add additional items to gitignore Add debug info for scalar value Output even more debug info Make textures render correctly Insert the indices properly Update .gitignore Disable y flip Make a reusable vertex buffer :) Disallow embedded textures More disable Set up implementation for contiguous model Add a note More automation & framework Final framework before stepping into function overhaul Hold track of current_index Integrate iterators More integration Rename, it's going to need 2 counters Correctly offset the count to the right Sync normals with positions Time to use a tuple Set up other counters Do return value Do input passing Make (somewhat) working contiguous model Add getter for translation data Add debug info for future utilization Update .gitignore More debug Update .gitignore Update .gitignore Remove all debug info & clean up Delete this thing Automate everything & put it into spec Spaces into tabs Remove array include as build test Fix the gitignore		2024-04-18 07:21:59 -05:00
.github/workflows	Update to latest branch of lukka/get-cmake	2024-04-18 07:21:59 -05:00
cmake	Add CMake as new build system	2021-03-06 21:40:05 +01:00
examples	Replace non-leading tabs with spaces, using:	2024-03-21 22:08:26 +01:00
include	Add GLTF mesh file loader	2024-04-18 07:14:20 -05:00
media	Remove now unused legacy OGLES2 driver	2024-02-23 21:31:33 +01:00
scripts	Move source/Irrlicht/ to src/	2024-03-21 22:08:26 +01:00
source	Fix indices, inverted models, & multiple models failing to load	2024-04-18 07:21:59 -05:00
src	Test invalid JSON	2024-04-18 07:19:30 -05:00
test	Reformat test/image_loader_test.cpp manually	2024-03-21 22:08:26 +01:00
.editorconfig	Mark the repo as root in the editorconfig	2023-04-02 21:50:56 +02:00
.gitignore	Add a file to gitignore	2023-12-13 12:17:04 +01:00
CMakeLists.txt	Add test file for glTF mesh loading	2024-04-18 07:16:20 -05:00
Config.cmake.in	Do CMake right	2024-04-18 07:10:56 -05:00
LICENSE	Cleanup line endings (#245 )	2023-10-03 20:37:00 +02:00
README.md	Update README for new SDL status	2024-02-17 22:15:02 +01:00

README.md

IrrlichtMt version 1.9

IrrlichtMt is the 3D engine of Minetest. It is based on the Irrlicht Engine but is now developed independently. It is intentionally not compatible to upstream and is planned to be eventually absorbed into Minetest.

Build

The build system is CMake.

The following libraries are required to be installed:

zlib, libPNG, libJPEG
OpenGL
- or on mobile: OpenGL ES (can be optionally enabled on desktop too)
on Unix: X11
SDL2 (see below)

Aside from standard search options (ZLIB_INCLUDE_DIR, ZLIB_LIBRARY, ...) the following options are available:

BUILD_SHARED_LIBS (default: ON) - Build IrrlichtMt as a shared library
BUILD_EXAMPLES (default: OFF) - Build example applications
ENABLE_OPENGL - Enable OpenGL driver
ENABLE_OPENGL3 (default: OFF) - Enable OpenGL 3+ driver
ENABLE_GLES1 - Enable OpenGL ES driver, legacy
ENABLE_GLES2 - Enable OpenGL ES 2+ driver
USE_SDL2 (default: platform-dependent, usually ON) - Use SDL2 instead of older native device code

e.g. on a Linux system you might want to build for local use like this:

git clone https://github.com/minetest/irrlicht
cd irrlicht
cmake . -DBUILD_SHARED_LIBS=OFF
make -j$(nproc)

This will put an IrrlichtMtTargets.cmake file into the cmake directory in the current build directory, and it can then be imported from another project by pointing find_package() to the build directory, or by setting the CMAKE_PREFIX_PATH variable to that same path.

on Windows system:

It is highly recommended to use vcpkg as package manager.

After you successfully built vcpkg you can easily install the required libraries:

vcpkg install zlib libjpeg-turbo libpng sdl2 --triplet x64-windows

Run the following script in PowerShell:

git clone https://github.com/minetest/irrlicht
cd irrlicht
cmake -B build -G "Visual Studio 17 2022" -A "Win64" -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake -DBUILD_SHARED_LIBS=OFF
cmake --build build --config Release

Platforms

We aim to support these platforms:

Windows via MinGW
Linux (GL or GLES)
macOS
Android

This doesn't mean other platforms don't work or won't be supported, if you find something that doesn't work contributions are welcome.

License

The license of the Irrlicht Engine is based on the zlib/libpng license and applies to this fork, too.

The Irrlicht Engine License
===========================

Copyright (C) 2002-2012 Nikolaus Gebhardt

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
 claim that you wrote the original software. If you use this software
 in a product, an acknowledgement in the product documentation would be
 appreciated but is not required.
2. Altered source versions must be clearly marked as such, and must not be
 misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.