README.md

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