Introduction

What is this?

This is the complete API reference for SDL2 Breakout version 0.1.0. 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. Version 1.0.0 will be the first engine version.

Building

To build the game and engine run python3 build.py within the Game directory. To build the game from source you will need to have the sdl development libraries installed.

Launching the game

Breakout ships with 3 predefined levels locatable in Game/Assets/levels but you are welcome to define more. To run the game run the executable /bin/breakout like so:

/bin/breakout

You can also pass which level like so:

/bin/breakout level2.txt

You can also pass which language to use like so:

/bin/breakout level2.txt spanish

Note that if you pass a language you have to pass a level :)

Gameplay

Quitting: Press q, escape, or click the x close window button to exit the game

Controls: Use the left and right arrow keys or 'a' and 'd' to move the paddle left and right, respectively. Or press 'm' to switch to using the mouse to control the paddle. Pressing 'm' again will switch back, and so on. The goal of the game is to break all the bricks on the screen without losing all your lives.

Level Building

You can build your own levels as documented in the LevelManager. Place them within the Assets/levels folder.

Localization

By default english to spanish translation is available but you can define your own localization as documented in LocalizationManager. Place your configs within the Assets/localization folder.

Credits

Background Music composed by Oscar Owl

Breakout game assets downloaded from unity store, all royalty free.

Contact

Feel free to contact me at thermitchellman@gmail.com for more information.