This repository provides a basic template for Gameboy development using RGBDS. The game.asm file is the starting point for your Gameboy project.
This template is based on the example provided at gbdev.io.
The recommended development environment for this project is Visual Studio Code. This repository includes a preconfigured VSCode setup in the .vscode directory.
The following VSCode extensions are recommended for this project:
- RGBDS Z80 Extension: Provides support for
*.asmfiles. - Emulicious Debugger: Enables debugging of Gameboy games.
The RGBDS toolchain, which has been used for building Gameboy games in Assembly since 1996, is required for this project. You can install it using the following command (Mac users):
brew install rgbdsAdditional installation information for other OSes can be found here.
This project uses the Emulicious emulator. The emulator is included in this repository, so there is no need for additional downloads. However, you will need to install JAVA to run it.
To enable remote debugging in Emulicious, navigate to Tools > Remote Debugging and enable it.
This project includes the hardware.inc file, which serves as the standard library for Gameboy ASM.
You are not supposed to modify this file, but just import it in your code.
To build the project, press Shift + Cmd + B. This will execute the commands defined in the .vscode/tasks.json file.
This will create a build directory and place the ROM, named game.gb, inside it.
Please note that the build process expects a game.asm file as your source code.
To start debugging, press Shift + CMD + D and click the Play button for Launch in Emulicious.
To run the game, either manually run the ROM via an emulator or press Ctrl + F5.