netrinjo Documentation

0.1

Welcome to the documentation of the Netrinjo game engine!

About Netrinjo

Summary

Netrinjo is a game engine, designed to minimize the programming effort, concerning the basic application development. One should be able to start implementing the game without the need to deal a lot with things that are required in every game: menus, loading data, ....

Furthermore there are classes for networking and the GUI (sound, input, graphics).

Netrinjo's homepage is at http://netrinjo.sourceforge.net/ .

Overview of abilities

• 2D graphics
• (3D graphics, after implementing a class "OglManager")
• mouse and keyboard input
• 2D graphical user interface (3D planned)
• sound (wav)
• music (ogg)
• network: TCP, UDP
• Compiles on Linux and probably Windows

Dependencies

Netrinjo depends on the following libraries:

• SDL
• SDL-ttf
• SDL-image
• SDL-gfx
• SDL-mixer
• SDL-net
• SDL-websrv
• TinyXml (included)

License

Netrinjo may be used and distributed under the terms of the GNU Lesser General Public License (version 2.1 or later)

How-To

There are two examples of "main.cpp"-files included in this documentation. One uses a class "GameApp" (must be derived from BasicApp) for basic application handling, see An example of a main.cpp-file with a class "GameApp". The other one uses the class XmlApp to manage the basic things (using this method is recommended to minimize programming effort), see An example of a main.cpp-file with the class XmlApp.

General information

Environment variables

The following environment strings are set by the application:

• DATAPATH (contains the path to the application's data directory, see BasicApp::getDataPath(), but does not end with '/')
• USERPATH (contains the path to the user's data directory, see BasicApp::getUserdataPath(), but does not end with '/')
• EXEPATH (the absolute path to the folder, in which the executable is, see BasicApp::getExePath(), but does not end with '/')

When using the method makeEnvPath(), it is simple to specify filenames relative to these data-paths. Example:

 $(DATAPATH)/subpath/filename.txt 

Avoid using paths relative to the current working directory, because it can change sometimes.

---