Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/randoragon/space-etcher

An action platformer game focused on speed and mobility.
https://github.com/randoragon/space-etcher

game sdl2 side-scrolling-platformer

Last synced: 10 days ago
JSON representation

An action platformer game focused on speed and mobility.

Awesome Lists containing this project

README

        

# Space Etcher

## WORK IN PROGRESS

This game is in very early stages of development, it is not ready to be played yet.

---

Space Etcher is a game project I started to learn the ropes of SDL2.
The aim of the game is to provide a good real-time action-puzzle experience with
focus on speed, great mobility and a wide array of player abilities. The game should
offer a lot of content due to its complexity, while remaining feather-weight, running
fast and using system resources sparingly.

## Documentation

I try to maintain a [Doxygen](https://www.doxygen.nl) documentation in the comments.
Things may be outdated here and there, but it is generally the best way of examining
the code base without actually looking at source code. The Doxyfile contains configuration
for the doxygen utility, to generate a `docs` directory containing the documentation
simply run

doxygen

from the project's root directory. Then you can open the `docs/html/index.html` file
in your web browser.

## Dependencies

- [SDL2](https://libsdl.org)
- [SDL2\_gfx](https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/)
- [SDL2\_image](https://www.libsdl.org/projects/SDL_image/)
- [RND\_Game](https://github.com/randoragon/rnd-libs/tree/master/game)
- [RND\_BitArray](https://github.com/randoragon/rnd-libs/tree/master/bitarray)
- [RND\_HashMap](https://github.com/randoragon/rnd-libs/tree/master/hashmap)
- [Chipmunk](https://chipmunk-physics.net/)

## Installation

Run the following (if necessary, as root):

make install

The executable will be copied to `/usr/local/bin/space-etcher`.