Irrsimple 3.1.0

Irrsimple is protected by the GNU license. See license.txt for more details.

If you use irrsimple, please send me a mail to say what you do think about it.

Made by phrounz

Irrsimple is a sort of outline of a game engine, based on C++ programming. However, it's currently far from usable to create a full great game which support 3D, sound, and network. It's only a version beta, and you cannot do more than a small game with it. But if you want to create a great game, you can add yourself features to irrsimple.

Irrsimple is based on Irrlicht (for 3D rendering), Audiere (for sound), and POSIX threads (for network). It works on Windows (95 to XP) and Linux operating systems.

Main part of irrsimple have been initially written for my game Ursus 6.

Irrsimple doesn't hide Irrlicht interface, so when you use irrsimple, you use also Irrlicht functions and methods. However, Irrsimple hide Audiere interface, so you don't need to know how works Audiere if you use Irrsimple.

The full irrsimple documentation is available in the "doc/html" folder.

Nb : The "source/test" folder contains an example program which uses irrsimple as sources files, whenever the "tutorial/1.HelloWorld" folder contains an example program which uses irrsimple as a static library.

Installation for Windows users :

The Windows version of irrsimple uses Dev-C++ with MingW and GNU g++ compiler.

You need to install :

• Dev-C++ with MinGW
• MingW Windows 32 API (should be already installed with Dev-C++ 4.9.9.1 or later. If you don't have it, install Dev-C++ package version 3.1)
• Irrlicht 0.14.0 (additionnally recompiled with Direct3D8 and Direct3D9 support, if you want to use Direct3D instead of OpenGL) (Seems that no recent devpack exists. Do NOT install Irrlicht with version smaller than 0.14.)
• Audiere SDK (advice : install Dev-C++ package version 1.9.3)
• MingW POSIX threads library (advice : install Dev-C++ package)

Open "libirrsimple.dev" (in the source folder) with Dev-C++.

Compile all (key to use : Ctrl + F11).

Now you should have the static library libirrsimple.a in the "source" folder.

Installation for Linux users :

You need :

• Linux API (nothing to install, should be already here)
• POSIX threads library (nothing to install, should be already here)
• Irrlicht 0.14.0
• Audiere 1.9.3

Open a console. Go to the "source" folder and execute : "make clean;make".

Now you should have the static library libirrsimple.a in the "source" folder.

When you create a new program :

You'll need to add the following libraries in each new program using irrsimple (For Dev-C++, Alt + P, Parameters, Link editor) :

• On Windows : -lirrsimple -laudiere -lIrrlicht -ljpeg -lz -lm -lwsock32 -lws2_32 -lwinmm -lpthreadGC
• On Linux : -lirrsimple -laudiere -lIrrlicht -ljpeg -lz -lm -lpthread -lGLU -lGL -lX11 -lXmu -lXi -lXxf86vm

You'll need to say where irrsimple headers and library can be found (For Dev-C++, use Alt + P, Directories ; for Linux, use -I and -L makefile commands) :

• For headers : Add the directory where irrsimple include files (all <file>.h except useful_cpp.h) are located (Default location = "source" folder).
• For the library : Add the directory where libirrsimple.a is located (Default location = "source" folder).

And of course, you must add #include <irrsimple.h> in you files.

Also don't forget to copy the following files in every folder where you want to execute an application using irrsimple (this is also important for tutorials) :

For Windows and Dev-C++ :

• pthreadGC.dll (Should be located in "<Dev-Cpp folder>\redist")
• audiere.dll (Should be in "<Dev-Cpp folder>\DLL")
• Irrlicht.dll (You should have put it in "<Dev-Cpp folder>\DLL")
• d3dx8.dll and d3dx9.dll, only if you recompiled Irrlicht with Direct3D support

For Linux :

• libaudiere-1.9.3.so (Should be located somewhere in the "/usr" folder. To know where, execute "find /usr -name libaudiere-1.9.3.so")
• libXxf86vm.so.1 which should be useful only for some debian-like systems. Seems that Irrlicht have some problems sometimes when it's launched without this file. (I found it for you. It's located in the "bonus" folder)
• The script "launcher.sh" which allows you to execute the program you've compiled, saying to Linux that the libraries must also be searched in the current folder. Execute it with the program name, for example : "./launcher 1.out".(launcher.sh is located in the "bonus" folder)

History & bugs

New in 1.1.0 version : Sprite management system added in system module.

New in 1.2.0 version : Corrected mouse scroll. Settings management has changed.

New in 2.0.0 version : Added Camera, Player, Stuff. Changed a LOT of things. Now the modules are object-oriented i.e. they are classes, and must be instanciated (they are not just functions).

New in 2.1.0 version : World3d has been added. Except World3d, Camera and Player, classes are now automatically instanciated.

New in 3.0.0 version : A LOT of things again. I just say that it's more object-oriented, that it is a real library, that there are a lot of other modules ...

New in 3.1.0 version : Bug corrected : sound works now on Linux.

Current bugs and to do list:

• You cannot load more than 500 sounds (nb : you can change this value with the #define NB_SOUNDS_MAX in Soundbank.cpp).
• Network is not currently useful.
• Some functions are in "BETA VERSION" i.e. they probably don't work.