mirror of https://github.com/minetest/minetest.git synced 2024-12-02 04:23:45 +01:00

History

JosiahWI c3db9492a7 Update CMakeLists to use `add_compile_definitions` (#15483 ) This is a newer feature introduced in CMake 3.12, which is now our minimum version. It supercedes `add_definitions`. I've also replaced some calls to set `CMAKE_<LANG>_FLAGS` that were used to set definitions. This is a fairly trivial routine build maintenance that is not intended to have any behavioral effects.		2024-11-29 12:02:48 +01:00
..
cmake	Copy irrlichtmt to <root>/irr/	2024-03-26 21:39:02 +01:00
include	Get rid of `definitelyIdentityMatrix` (#15480 )	2024-11-29 12:00:09 +01:00
scripts	Cleanup headers in irr/include/ (#15181 )	2024-10-18 10:58:32 +02:00
src	Update CMakeLists to use `add_compile_definitions` (#15483 )	2024-11-29 12:02:48 +01:00
.editorconfig	Copy irrlichtmt to <root>/irr/	2024-03-26 21:39:02 +01:00
.gitignore	Copy irrlichtmt to <root>/irr/	2024-03-26 21:39:02 +01:00
CMakeLists.txt	[no sq] Move shaders & remove dead Irrlicht tests (#15006 )	2024-08-19 09:17:52 +02:00
LICENSE	Copy irrlichtmt to <root>/irr/	2024-03-26 21:39:02 +01:00
README.md	IrrlichtMt: Document Driver/Device compatibility	2024-11-15 12:18:48 +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:

ENABLE_OPENGL - Enable OpenGL driver
ENABLE_OPENGL3 (default: OFF) - Enable OpenGL 3+ driver
ENABLE_GLES2 - Enable OpenGL ES 2+ driver
USE_SDL2 (default: platform-dependent, usually ON) - Use SDL2 instead of older native device code

However, IrrlichtMt cannot be built or installed separately.

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.

Compatibility matrix

Driver (rows) vs Device (columns)

	SDL [1]	Linux [2]	OSX [3]	Win32 [4]
OpenGL 1.2 (to 2.1)	Works	Works (GLX)	Works (NSOpenGL)	Works (WGL)
OpenGL 3.2+	Works	Testing (GLX)	Not implemented	Testing (WGL)
OpenGL ES 2.x	Works	Untested (EGL)	Not implemented	Untested (EGL)
WebGL 1	Untested	Untested (EGL)	Not implemented	Not implemented
Null (no graphics output)	Works	Works	Works	Works

Notes:

[1] CIrrDeviceSDL: supports Android, Linux, macOS, Windows
[2] CIrrDeviceLinux: supports Linux
[3] CIrrDeviceOSX: supports macOS
[4] CIrrDeviceWin32: supports Windows

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.