Minetest's fork of Irrlicht
Go to file
celeron55 7173c2c629
Update README.md: Add notice about IrrlichtMt having been moved into the main repo
2024-05-13 15:29:27 +03:00
.github/workflows Restore buildability with SDL 2.0.10 2024-03-21 22:48:22 +01: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 Replace non-leading tabs with spaces, using: 2024-03-21 22:08:26 +01: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
src Restore buildability with SDL 2.0.10 2024-03-21 22:48:22 +01: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 Move source/Irrlicht/ to src/ 2024-03-21 22:08:26 +01:00
Config.cmake.in Adjust package config dependency again 2024-01-30 14:23:33 +01:00
LICENSE Cleanup line endings (#245) 2023-10-03 20:37:00 +02:00
README.md Update README.md: Add notice about IrrlichtMt having been moved into the main repo 2024-05-13 15:29:27 +03:00

IrrlichtMt version 1.9

Notice

IrrlichtMt has been moved into the main Minetest repository during Minetest 5.9 development. This repository is an archive useful for building older versions of Minetest.

About

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.