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 contains features, customizations and fixes specifically for use in Minetest.
   7
   8 Build
   9 -----
  10
  11 The build system is CMake.
  12
  13 The following libraries are required to be installed:
  14 * zlib, libPNG, libJPEG
  15 * OpenGL
  16   * or on mobile: OpenGL ES (can be optionally enabled on desktop too)
  17 * on Unix: X11
  18
  19 Aside from standard search options (`ZLIB_INCLUDE_DIR`, `ZLIB_LIBRARY`, ...) the following options are available:
  20 * `BUILD_SHARED_LIBS` (default: `ON`) - Build IrrlichtMt as a shared library
  21
  22 e.g. on a Linux system you might want to build for local use like this:
  23
  24         git clone https://github.com/minetest/irrlicht
  25         cd irrlicht
  26         cmake . -DBUILD_SHARED_LIBS=OFF
  27         make -j$(nproc)
  28
  29 Platforms
  30 ---------
  31
  32 We aim to support these platforms:
  33 * Windows via MinGW
  34 * Linux (GL or GLES)
  35 * macOS
  36 * Android
  37
  38 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.
  39
  40 License
  41 -------
  42
  43 The license of the Irrlicht Engine is based on the zlib/libpng license and applies to this fork, too.
  44
  45         The Irrlicht Engine License
  46         ===========================
  47
  48         Copyright (C) 2002-2012 Nikolaus Gebhardt
  49
  50         This software is provided 'as-is', without any express or implied
  51         warranty.  In no event will the authors be held liable for any damages
  52         arising from the use of this software.
  53
  54         Permission is granted to anyone to use this software for any purpose,
  55         including commercial applications, and to alter it and redistribute it
  56         freely, subject to the following restrictions:
  57
  58         1. The origin of this software must not be misrepresented; you must not
  59          claim that you wrote the original software. If you use this software
  60          in a product, an acknowledgement in the product documentation would be
  61          appreciated but is not required.
  62         2. Altered source versions must be clearly marked as such, and must not be
  63          misrepresented as being the original software.
  64         3. This notice may not be removed or altered from any source distribution.