An open API service indexing awesome lists of open source software.

https://github.com/vimichael/sengine


https://github.com/vimichael/sengine

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# Sphere's SDL2 Engine (Version 0.1)

A simple, game engine written on top of SDL and other SDL tools. Designed to make game development easier through a management systems and object-oriented design.

## Dependencies
- SDL2
- SDL_image
- SDL_TTF
- SDL_mixer

## Compatibility

As of writing this, the engine has only been tested on Windows. However, assuming there are no issues with SDL2 on other operating systems, none of the code here is platform specific. This **should** work on MacOS and Linux, but it is not at all guaranteed. Use at your own risk!

## Install

Clone this repository to your device.
Execute `make library` or `make debug` (for debug build).
This will produce a "libse.a" file in "build".
I strongly recommend using a debug build when writing your game.
Download all the dependencies and set them up accordingly.

A typical folder structure would look like:

```
.
├── build/
│ └──
├── headers/
│ └──
├── include/
│ ├──
│ └──
├── lib/
│ ├──
│ └──
├── src/
│ └──
└── Makefile
```

## Compiling your program

Execute this command:

```
g++ main.cpp -o projectname -Iinclude -Llib -lmingw32 -lSDL2main -lSDL2 -lSDL2_image -lSDL2_ttf -lSDL2_mixer
```

Depending on your project structure, this command can vary quite a bit. As long as it looks something like this:

```
-o
```

**NOTE** Link against the static lib `libse.a` **first**, before any of the other libraries.

# Documentation (WIP)

The documentation can be found [here](documentation/table-of-contents.md).