GB Snake is project coded in c that implements the Snake game for the Gameboy 1st generation (black and white screen).
GB Snake was primarily developed on MacOS (10.15) but was also built and tested on Linux (Centos 7).
Required:
- Makefile
- gcc compiler
Optional:
- Python 3
- Pillow
For more information about the code, please read the documentation.
- Make sure gcc and make are installed
> gcc --version
> make --versionIf some version and info are printed after running the previous commands, gcc and make are installed. If you get command not found error, please be sure to install them first.
- Download GBDK-2020 latest release
Go to the GBDK-2020 release page and download the last release available for your platform and extract the content to a given folder.
- Clone the GBSnake project
> git clone https://github.com/raph080/gbSnake- Build
Enter the cloned folder and run the Makefile by specifying the folder containing the last GBDK-2020 release previously downloaded and extracted.
> cd gbSnake
> make GBDK_LOCATION=/path/to/GBDK-2020-release- Run
If everything went well, a bin folder is created with snake.gb inside.
You can then run the game with your favourite emulator.
Various emulators exist (see https://www.emulator-zone.com/doc.php/gameboy/).
The one that was used to developed GB Snake on MacOS was Emulicious. This software is really convenient due to its debug features and its support on a lot of operating system.
If you wish to quickly test the game without installing any emulator on your machine, I then suggest using https://taisel.github.io/GameBoy-Online/
GBT Player is used to convert mod music to GBT code files thanks to the mod2gbt binary. It also provides a library to ease the sound management from GBT code files.
The code from GBT player has been copied from its original repository and restructured within the vendors folder.
Python 3 and Pillow are required to run this script.
image2gbpng.py converts an image to another one that is compatible with the
gameboy architecture. The resulting image can be safely used as input for
the png2asset binary from GBDK-2020 project.
For more info, run
> python3 image2gbpng.py --helpSprites and backgrounds PNGs are compiled using png2asset with different flags. To simplify the project structure, background are identified with the bkg.png extension and the sprites with the sprite.png extension.
At first, sound and graphics libraries were implemented in a generic way, in order to be used in other projects. But it has been later decided to make those two library specific to the snake project, in order to simplify the project structure and code.
It is really tricky to find 8-bits musics that are compatible with the GBT Player limits (see mod_instructions.txt).
Fun fact: The Tetris music used for the game is actually not a remix. It is just the original Tetris music that is been truncated by mod2gbt. But it ended up as a nice remix.
If you want to compose your own for this game, feel free to try OpenMPT and pull request it!