irr-readme.txt

   1 ==========================================================================\r
   2 The Irrlicht Engine SDK version 1.9\r
   3 ==========================================================================\r
   4 \r
   5   Welcome to the Irrlicht Engine SDK.\r
   6 \r
   7   Content of this file:\r
   8 \r
   9   1. Directory Structure Overview\r
  10   2. How To Start\r
  11   3. Requirements\r
  12   4. Release Notes\r
  13   5. License\r
  14   6. Contact\r
  15 \r
  16 \r
  17 ==========================================================================\r
  18 1. Directory Structure Overview\r
  19 ==========================================================================\r
  20 \r
  21   You will find some directories after uncompressing the archive of the\r
  22   SDK. These are:\r
  23 \r
  24   \bin         The compiled library Irrlicht.DLL and some compiled demo\r
  25                and example applications, just start them to see the\r
  26                Irrlicht Engine in action. Windows only.\r
  27   \doc         Documentation of the Irrlicht Engine.\r
  28   \examples    Examples and tutorials showing how to use the engine with\r
  29                C++.\r
  30   \include     Header files to include when programming with the engine.\r
  31   \lib         Libs to link with your programs when using the engine.\r
  32   \media       Graphics and sound resources for the demo applications and\r
  33                examples.\r
  34   \source      The source code of the Irrlicht Engine. This code is\r
  35                not needed to develop applications with the engine,\r
  36                but it is included to enable recompilation and\r
  37                debugging, if necessary.\r
  38   \tools       Useful tools (with sourcecode) for the engine.\r
  39 \r
  40 \r
  41 \r
  42 ==========================================================================\r
  43 2. How to start\r
  44 ==========================================================================\r
  45 \r
  46   To see the engine in action in Windows, just go to the \bin\Win32-VisualStudio\r
  47   directory, and start some applications. There should also be an\r
  48   application named Demo.exe which should show the most\r
  49   interesting features of Irrlicht.\r
  50 \r
  51   To start developing own applications and games with the engine take\r
  52   a look at the 01.HelloWorld example in the \examples directory.\r
  53   There is also a .html file with a tutorial which should be\r
  54   easily comprehensible.\r
  55 \r
  56   The Irrlicht Engine is a static lib under linux. A precompiled version can be\r
  57   generated from the sources using the Makefile in source/Irrlicht. Run 'make' in \r
  58   that subfolder. After this you should be able to 'make' all\r
  59   example applications in /examples by calling the buildAllExamples script. You \r
  60   can run the examples then from the bin folder.\r
  61 \r
  62   It is also possible to use Irrlicht as shared object\r
  63   (libIrrlicht.so.versionNumber). Use the proper makefile target for this by\r
  64   running 'make sharedlib' in the source folder. See the Makefile for details.\r
  65 \r
  66   For OSX you can find an XCode project file in source/Irrlicht/MacOSX. This will\r
  67   build the libIrrlicht.a library necessary to create the apps.\r
  68 \r
  69 ==========================================================================\r
  70 3. Requirements\r
  71 ==========================================================================\r
  72 \r
  73   You can use one of the following compilers/IDEs to develop applications\r
  74   with Irrlicht or recompile the engine. However, other compilers/IDEs may\r
  75   work as well, we simply didn't test them.\r
  76 \r
  77   * gcc 4.x\r
  78   * Visual Studio 2010(10.0)-2013(12.0)\r
  79   * Code::Blocks (& gcc or visual studio toolkit)\r
  80   \r
  81   If you ever want to (re)compile the engine yourself (which means you don't\r
  82   want to use the precompiled version) you need the following:\r
  83 \r
  84   * Windows:\r
  85         * Needed: PlatformSDK (which usually comes with all IDEs, download\r
  86                         it separately for MSVC Express 2005)\r
  87         * Optional: DirectX SDK, for D3D9 support\r
  88         * Optional: DirectX SDK prior to May 2006, for D3D8 support\r
  89 \r
  90   * Linux:\r
  91         * Needed: XServer with include files\r
  92         * Optional: OpenGL headers and libraries (libGL.so) for OpenGL support\r
  93                 GLX +\r
  94                 XF86VidMode [package x11proto-xf86vidmode-dev] or XRandr\r
  95                 (X11 support libraries, the latter two for fullscreen mode)\r
  96 \r
  97   * OSX:\r
  98         * Needed: XCode and Cocoa framework\r
  99         * Needed: OpenGL headers and libraries\r
 100 \r
 101 ==========================================================================\r
 102 4. Release Notes\r
 103 ==========================================================================\r
 104 \r
 105   Informations about changes in this new version of the engine can be\r
 106   found in changes.txt.\r
 107 \r
 108   Please note that the textures, 3D models and levels are copyright\r
 109   by their authors and not covered by the Irrlicht engine license.\r
 110 \r
 111 ==========================================================================\r
 112 5. License\r
 113 ==========================================================================\r
 114 \r
 115   The license of the Irrlicht Engine is based on the zlib/libpng license.\r
 116   Even though this license does not require you to mention that you are\r
 117   using the Irrlicht Engine in your product, an acknowledgement\r
 118   would be highly appreciated.\r
 119 \r
 120   Please note that the Irrlicht Engine is based in part on the work of\r
 121   the Independent JPEG Group, the zlib, and libpng. This means that if you use\r
 122   the Irrlicht Engine in your product, you must acknowledge somewhere\r
 123   in your documentation that you've used the IJG code and libpng. It would\r
 124   also be nice to mention that you use the Irrlicht Engine and the zlib.\r
 125   See the README files in the jpeglib and the zlib for\r
 126   further informations.\r
 127 \r
 128 \r
 129   The Irrlicht Engine License\r
 130   ===========================\r
 131 \r
 132   Copyright (C) 2002-2012 Nikolaus Gebhardt\r
 133 \r
 134   This software is provided 'as-is', without any express or implied\r
 135   warranty.  In no event will the authors be held liable for any damages\r
 136   arising from the use of this software.\r
 137 \r
 138   Permission is granted to anyone to use this software for any purpose,\r
 139   including commercial applications, and to alter it and redistribute it\r
 140   freely, subject to the following restrictions:\r
 141 \r
 142   1. The origin of this software must not be misrepresented; you must not\r
 143      claim that you wrote the original software. If you use this software\r
 144      in a product, an acknowledgement in the product documentation would be\r
 145      appreciated but is not required.\r
 146   2. Altered source versions must be clearly marked as such, and must not be\r
 147      misrepresented as being the original software.\r
 148   3. This notice may not be removed or altered from any source distribution.\r
 149 \r
 150 \r
 151 ==========================================================================\r
 152 6. Contact\r
 153 ==========================================================================\r
 154 \r
 155   If you have problems, questions or suggestions, please visit the\r
 156   official homepage of the Irrlicht Engine:\r
 157 \r
 158   http://irrlicht.sourceforge.net\r
 159 \r
 160   You will find forums, bugtrackers, patches, tutorials, and other stuff\r
 161   which will help you out.\r
 162 \r
 163   If want to contact the team of the engine, please send an email to\r
 164   Nikolaus Gebhardt:\r
 165 \r
 166   irrlicht@users.sourceforge.net\r
 167 \r
 168   Please also not that parts of the engine have been written or contributed\r
 169   by other people. Especially: (There are probably more people, sorry if I forgot one.\r
 170   See http://irrlicht.sourceforge.net/author.html for more informations)\r
 171 \r
 172   Christian Stehno (hybrid)   Contribution Coordinator/Developer\r
 173   Michael Zeilfelder (cutealien) Developer\r
 174   Patryk Nadrowski (Nadro)    Developer  \r
 175   Yoran Bosman (Yoran)        Webserver administrator\r
 176   Gareth Davidson (bitplane)  Developer/ Forum admin\r
 177   Thomas Alten (burningwater) Wrote the burningsvideo software rasterizer\r
 178   Luke P. Hoschke (luke)      Wrote the b3d loader, the new animation system, VBOs and other things\r
 179   Colin MacDonald (rogerborg) All hands person\r
 180   Ahmed Hilali (blindside)    The shader and advanced effects man\r
 181   Dean Wadsworth (varmint)    OSX port maintainer and game developer\r
 182   Alvaro F. Celis (afecelis)  Lots of work in the community, for example video tutorials about Irrlicht, forum admin\r
 183   John Goewert (Saigumi)      Wrote some tutorials for the Irrlicht Engine and doing admin stuff\r
 184   Jam                         Takes care of moderating the forums and keeps them clean from those evil spammers.\r
 185 \r
 186   Many others (this list hasn't been updated in a while, but they are often mentioned in changes.txt)\r
 187   Etienne Petitjean wrote the MacPort of the engine\r
 188   Mark Jeacocke Wrote lots of helpful comments and ideas in the forums and per email.\r
 189   Julio Gorgé   Created the 'Unofficial DirectX 9.0 Driver for the Irrlicht Engine'\r
 190   Andy Spurgeon Wrote the Dev-Cpp tutorial.\r
 191   André Simon   Wrote the Codewarrior tutorial.\r
 192   KnightToFlight        Created the unoffical terrain renderer addon for the Irrlicht Engine.\r
 193   Jon Pry       Wrote the code to load compressed TGA files.\r
 194   Matthew Couch Wrote the tokamak integration tutorial.\r
 195   Max Winkel    Wrote the splitscreen tutorial.\r
 196   Gorgon Zola   Wrote the ODE integration tutorial.\r
 197   Dean P. Macri Sent in code for curved surfaces and PCX Loading.\r
 198   Sirshane      Made several bug fixes, sent in code for making the mouse cursor invisible in Linux.\r
 199   Matthias Gall Sent in code for a spline scene node animator and reported lots of bugs.\r
 200   Mario Gruber  Suggested triangle fan drawing and sent in code for this.\r
 201   Ariaci        Spotted out a bug in the ATI driver.\r
 202   Dr Andros C Bragianos Improved texture mapping in cube scene node.\r
 203   Philipp Dortmann      Sent in code for stencil buffer support for OpenGL.\r
 204   Jerome Nichols        Created the Irrlicht/Ruby interface located at irr.rubyforge.org\r
 205   Vash TheStampede      Sent code for missing Draw2DLine() implementations\r
 206   MattyBoy      XBOX support suggestions\r
 207   Oliver Klems  createImageFromData() method suggestion/implementation\r
 208   Jox   really, really a lot of bug fixes, and the LMTS file loader\r
 209   Zola  Quaternion method additions\r
 210   Tomasz Nowakowski     various bug fixes\r
 211   Nicholas Bray stencil shadow bug fixes with OpenGL\r
 212   REAPER        mouswheel events for scrollbar\r
 213   Calimero      various bug fixes like vector2d operators\r
 214   Haddock       bugfix in the linked list\r
 215   G.o.D XML parser fix\r
 216   Erik Zilli    Translated some of the tutorials from my stuttering english into real english. :)\r
 217   Martin Piskernig      Linux bugfixing and testing\r
 218   Soconne       Wrote the original terrain renderer were Irrlichts terrain renderer of Irrlicht is based on it.\r
 219   Spintz        GeoMipMap scene node, terrain renderer of Irrlicht is based on it.\r
 220   Murphy McCauley       OCT file loader, MIM tools\r
 221   Saurav Mohapatra      IrrCSM, and lots of addons, suggestions and bug reports\r
 222   Zhuck Dimitry My3D Tools\r
 223   Terry Welsh   Allowed me to use the textures of his 'Parallax Mapping with Offset Limiting' paper for the parallax demo of Irrlicht\r
 224   rt    Wrote the original .png loader for Irrlicht\r
 225   Salvatore Russo       Wrote the original .dmf loader for Irrlicht\r
 226   Vox   Various bug reports and fixes\r
 227   atomice       Contributed code for a ms3d loader enhancement\r
 228   William Finlayson     OpenGL RTT, GLSL support and the reflection 2 layer material for OpenGL.\r
 229   Delight       Various code contributions for Irrlicht.NET (particle system, basic shader support and more)\r
 230   Michael Zoech Improved GLSL support\r
 231   Jean-loup Gailly, Mark Adler  Created the zlib and libpng\r
 232   Guy Eric Schalnat, Andreas Dilger, Glenn Randers-Pehrson and others   Created libpng\r
 233   The Independent JPEG Group    Created JPEG lib\r
 234   Dr Brian Gladman AES Created aesGladman\r
 235   \r