Skip to content

README.md

Latest commit

 

History

History
44 lines (31 loc) · 1.36 KB

README.md

File metadata and controls

44 lines (31 loc) · 1.36 KB

GameBoyDev

An example gameboy game project.

How to Build the ROM

Depedencies

  • RGBDS - Game Boy Assembly & Linking Tools
  • GNU Make - Build system tool (installation should only be required on Windows).

Use Make to Build the ROM

With the assembler installed, open a command-line and run make:

$ make

This will run the make script and produce the bin/GameBoyDev.gb rom.

Easy Build in VS Code

  • Use the command pallette (CTRL/CMD + SHIFT + P) and select Tasks: Run Build Task.

Build Settings (ROM name, etc.)

For changes to how the game is assembled and linked, change the parameters in project.mk (don't make changes to the MakeFile directly).

Suggested Emulators

  • Windows - BGB (note: this should work fine on mac/linux using wine)
  • Mac / Linux - Emulicious

VS Code Extensions

  • RGBDS Z80 Web Link - Adds full language support for Game Boy Z80 Assembly (syntax highlighting & intellisense).

Attribution

This project was derived from gb-boilerplate, for further details please see README-gb-boilerplate.md.