ZGB Devcontainer Template Repository

This is a GitHub repository template for ZGB.

It includes:

• build automation via Make
• Visual Studio Code configuration with C/C++ and Remote Container support.
• container include below tools and libraries.
  • GBDK-2020
  • mod2gbt
  • pngb
  • Gameboy Map Builder
  • Gameboy Tile Designer
  • BGB
  • Emulicious
• noVNC/VNC support.

Getting started

1. Copy this repository by pressing the "Use this template" button in Github.
2. Clone your repository and rename .project.example to .project and set PROJECT_NAME in it.
3. Open the cloned directory in the latest Visual Studio Code.
4. F1 -> Remote-Containers: Reopen in Container.
5. Open localhost:6080 in your browser or connect a VNC viewer to port 5901 after a container is created and started and type vscode for vnc-auth.

Build

Terminal

• make / make release - execute the release build pipeline for GB.
• make color release - execute the release build pipeline for GBC.
• make debug - execute the debug build pipeline for GB.
• make color debug - execute the debug build pipeline for GBC.
• make clean - execute to remove the output

Visual Studio Code

F1 → Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B) to execute the build pipeline.

Debug

Visual Studio Code

F5 to launch the debug build in Emulicious.

Useful links

• ZGB Tutorial
• GBDK-2020 Docs
• Game Boy Development community
• ZGB / GBDK Discord