Introduction

This is the API documentation of the SDL Game Engine sge2d.

sge2d is a platform independent 2d game programming framework for c/c++ programmers with least possible dependencies for easy porting and with focus on easy api calls and the requirement of commercial programmers. It was started 2007 by the founder of Agnostic Entertainment.

It is a open source project under MIT license, so it is free for commercial use, you don't have to publish your source, if you use it. you may even alter the sge2d source for your needs and don't have to publish it.

Demos

There are a number of demos in the 'demo' folder. They are well documented and the recommendet start for learning how to develop your games with sge2d.

Build

To build the engine, change to the main directory and type:

./configure

In most cases this should configure the build system. There are platforms that require the platform specified as parameter to ./configure. Type in

./configure --help

to get a list of possible parameters, if you run into problems with the build system.

After configuring the build system, type in:

make

to start building the SDL game engine.

There are two optional build steps:

make demos make test

make demos builds the demos, they are well documented and the suggested way to learn sge2d

make test builds the developers test environment, this is usually a good point to see whats going on with sge2d, but its a developers playground, so it might be a mess and might even not work at all, you have been warned.

Own projects

The recomended way to develop own projects is to create a folder within the sge2d base directory named

projects/myproject

and copy over a make file from one of the demos.

These folders will be excluded from the sge2d cvs and can be set up under your own version control.

Platform specific notes

Amiga OS derivates

You usually have to start the configure script with:

sh ./configure

Windows

You do require a MSYS/MinGW installation and run sge from inside a MinGW shell.

You also require SDL, SDL_image and SDL_mixer installed from source which itself require several libraries. To prevent trouble with compiling, configure all libraries with:

./configure --prefix=/mingw