4 The Irrlicht Engine is an open source realtime 3D engine written in C++.
6 This is a fork by the [Minetest](https://github.com/minetest) developers that was stripped-down and customized specifically for use in Minetest.
7 It is intentionally not compatible to upstream and is planned to be eventually absorbed into Minetest.
12 The build system is CMake.
14 The following libraries are required to be installed:
15 * zlib, libPNG, libJPEG
17 * or on mobile: OpenGL ES (can be optionally enabled on desktop too)
20 Aside from standard search options (`ZLIB_INCLUDE_DIR`, `ZLIB_LIBRARY`, ...) the following options are available:
21 * `BUILD_SHARED_LIBS` (default: `ON`) - Build IrrlichtMt as a shared library
22 * `BUILD_EXAMPLES` (default: `OFF`) - Build example applications
24 e.g. on a Linux system you might want to build for local use like this:
26 git clone https://github.com/minetest/irrlicht
28 cmake . -DBUILD_SHARED_LIBS=OFF
31 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.
35 It is highly recommended to use vcpkg as package manager.
37 After you successfully built vcpkg you can easily install the required libraries:
39 vcpkg install zlib libjpeg-turbo libpng opengl-registry --triplet x64-windows
41 Run the following script in PowerShell:
43 git clone https://github.com/minetest/irrlicht
45 cmake -B build -G "Visual Studio 17 2022" -A "Win64" -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake -DBUILD_SHARED_LIBS=OFF
46 cmake --build build --config Release
51 We aim to support these platforms:
57 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.
62 The license of the Irrlicht Engine is based on the zlib/libpng license and applies to this fork, too.
64 The Irrlicht Engine License
65 ===========================
67 Copyright (C) 2002-2012 Nikolaus Gebhardt
69 This software is provided 'as-is', without any express or implied
70 warranty. In no event will the authors be held liable for any damages
71 arising from the use of this software.
73 Permission is granted to anyone to use this software for any purpose,
74 including commercial applications, and to alter it and redistribute it
75 freely, subject to the following restrictions:
77 1. The origin of this software must not be misrepresented; you must not
78 claim that you wrote the original software. If you use this software
79 in a product, an acknowledgement in the product documentation would be
80 appreciated but is not required.
81 2. Altered source versions must be clearly marked as such, and must not be
82 misrepresented as being the original software.
83 3. This notice may not be removed or altered from any source distribution.