Introduction

What is this?

This is the complete API reference for an original game, Spooky Epic Linux Platform Hour, written in C++ using the SDL2 API. Contained within are the specifications for each namespace/module/class and the methods from those which you can refer to when writing code which uses headers found within. As the engine that supports this game evolves the game will be updated to fit the engine specification.

Building

To build the game and engine run the makefile with command "all" from the game directory. To build the game from source you will need to have the sdl development libraries installed.

Launching the game

Spooky Epic Linux Platform Hour is the only game implemented using this engine so far, but it is possible to create many different and unique platformers with our versitile component system and helpful manager system. To launch the game navigate to the Game/game directory and run ./bin/platformer.

Gameplay

Quitting: Click the x close window button to exit the game

Controls: Use the arrow keys to move the player left or right and jump. Dodge the ghosts for 100 seconds to win the game. You may get hit three times before you lose and the game is over. Additionaly, you can press left shift to freeze all the ghosts on the screen for a short period of time and this ability comes with a cooldown.

Custom Game Building

To create your own game using our engine read the documentation on our component system and create an implementation the Enginge class that contains your own MainGameLoop which will run until the user exits the program.

Credits

Braid's Tim character sprite. All other sprites are custom made and allowed for free reuse.

Contact

The creators of this engine are Matthew Salomon, Ryan Mitchell, Ryan Gelheim, and Sophie Uldry and can be contacted at matthew.h.salomon@gmail.com, thermitchellman@gmail.com, ryan.gehrlein@gmail.com, and uldrylavergne.s@northeastern.edu respectively.