README.md

   1 IrrlichtMt version 1.9
   2 ======================
   3
   4 The Irrlicht Engine is an open source realtime 3D engine written in C++.
   5
   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.
   8
   9 Build
  10 -----
  11
  12 The build system is CMake.
  13
  14 The following libraries are required to be installed:
  15 * zlib, libPNG, libJPEG
  16 * OpenGL
  17   * or on mobile: OpenGL ES (can be optionally enabled on desktop too)
  18 * on Unix: X11
  19
  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
  23 * `ENABLE_OPENGL` - Enable OpenGL driver
  24 * `ENABLE_OPENGL3` (default: `OFF`) - Enable OpenGL 3+ driver
  25 * `ENABLE_GLES1` - Enable OpenGL ES driver, legacy
  26 * `ENABLE_GLES2` - Enable OpenGL ES 2+ driver
  27 * `USE_SDL2` (default: `OFF`) - Use SDL2 instead of native platform device
  28
  29 e.g. on a Linux system you might want to build for local use like this:
  30
  31         git clone https://github.com/minetest/irrlicht
  32         cd irrlicht
  33         cmake . -DBUILD_SHARED_LIBS=OFF
  34         make -j$(nproc)
  35
  36 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.
  37
  38 on Windows system:
  39
  40 It is highly recommended to use vcpkg as package manager.
  41
  42 After you successfully built vcpkg you can easily install the required libraries:
  43
  44         vcpkg install zlib libjpeg-turbo libpng opengl-registry --triplet x64-windows
  45
  46 Run the following script in PowerShell:
  47
  48         git clone https://github.com/minetest/irrlicht
  49         cd irrlicht
  50         cmake -B build -G "Visual Studio 17 2022" -A "Win64" -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake -DBUILD_SHARED_LIBS=OFF
  51         cmake --build build --config Release
  52
  53 Platforms
  54 ---------
  55
  56 We aim to support these platforms:
  57 * Windows via MinGW
  58 * Linux (GL or GLES)
  59 * macOS
  60 * Android
  61
  62 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.
  63
  64 License
  65 -------
  66
  67 The license of the Irrlicht Engine is based on the zlib/libpng license and applies to this fork, too.
  68
  69         The Irrlicht Engine License
  70         ===========================
  71
  72         Copyright (C) 2002-2012 Nikolaus Gebhardt
  73
  74         This software is provided 'as-is', without any express or implied
  75         warranty.  In no event will the authors be held liable for any damages
  76         arising from the use of this software.
  77
  78         Permission is granted to anyone to use this software for any purpose,
  79         including commercial applications, and to alter it and redistribute it
  80         freely, subject to the following restrictions:
  81
  82         1. The origin of this software must not be misrepresented; you must not
  83          claim that you wrote the original software. If you use this software
  84          in a product, an acknowledgement in the product documentation would be
  85          appreciated but is not required.
  86         2. Altered source versions must be clearly marked as such, and must not be
  87          misrepresented as being the original software.
  88         3. This notice may not be removed or altered from any source distribution.