forked from Mirrorlandia_minetest/irrlicht

Minetest's fork of Irrlicht

Go to file

sfan5 593103a261 Refactor SDL device to use the same abstraction as other devices In particular this makes the OpenGL procedure stuff work. fixes https://github.com/minetest/minetest/issues/12265		2022-05-21 15:26:38 +02:00
.github/workflows	Properly strip windows binaries produced by CI	2022-05-06 14:08:45 +02:00
bin	Delete more old files	2022-02-26 12:11:27 +01:00
cmake	Add CMake as new build system	2021-03-06 21:40:05 +01:00
doc	Delete more old files	2022-02-26 12:11:27 +01:00
examples	Unit tests for irrArray (#103 )	2022-05-07 11:21:41 +02:00
include	Remove irrMap and use std::map instead	2022-05-18 13:12:47 +02:00
lib	Delete more old files	2022-02-26 12:11:27 +01:00
media	Remove more unused code (#87 )	2021-12-29 13:12:09 +01:00
scripts	Properly strip windows binaries produced by CI	2022-05-06 14:08:45 +02:00
source	Refactor SDL device to use the same abstraction as other devices	2022-05-21 15:26:38 +02:00
.editorconfig	Clone .editorconfig from minetest/master	2021-07-12 18:03:15 +02:00
.gitignore	Add a unified cross platform OpenGL core profile binding (#52 )	2021-08-07 21:56:00 +02:00
changes.txt	IBillboardSceneNode got functions to access meshbuffers.	2022-02-09 19:09:04 +01:00
CMakeLists.txt	Fix version variable bug	2021-08-23 17:10:23 +02:00
Config.cmake.in	CMake Config and Version exports (#22 )	2021-04-13 21:08:16 +02:00
irr-readme.txt	Add README	2021-03-07 13:25:24 +01:00
ogles-readme.txt	Merging r5975 through r6036 from trunk to ogl-es branch.	2020-01-03 19:05:16 +00:00
README.md	Fix incorrect documentation in README	2021-08-01 11:39:28 +02:00

README.md

IrrlichtMt version 1.9

The Irrlicht Engine is an open source realtime 3D engine written in C++.

This is a fork by the Minetest developers that contains features, customizations and fixes specifically for use in 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

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

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.

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.