A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.
Switch branches/tags
Nothing to show
Clone or download

README.md

GameboyIcon Awesome Game Boy Development

Join us on Discord Discord Badge

A curated list of awesome Game Boy (Color) Development resources, tools, docs, related projects and open-source ROMs. Inspired by the awesome list thing.

Contents

Intro

Disambiguation

Although this documentation is focused on the original (1989) Game Boy (DMG), the Game Boy Color (GBC) and Super Game Boy (SGB) are very similar systems, with few important distinctions, such as:

  • Different hardware specifications
  • Specific hardware and software features
  • Specific registers
  • Specific bugs and exploitable behaviours

If you aim to develop your software for SGB or GBC, or you want to know how it runs on the other systems, you may want to take advantage and adapt to these differences, check the Game Boy Color category and look for specific references to GBC/CGB and SGB.

Community

Documentation

Misc

Cheatsheets, Tables

Hardware

Game Boy Color

Peripherals

Cartridges

Emulator Development

Testing

Software Development

Assemblers

Compilers

  • GBDK - A set of tools that enable to develop in C. Includes a set of libraries for the most common requirements and generates ready ROM files. Documentation.
    • gbdk-osx - Patched GBDK 2.96a for the latest compilers on OS X.
    • gbdk-n - Aims to update the gbdk libraries to be compatible with new versions of SDCC and provide helpers for building roms. Does not support ROM banking, thus limiting ROM size to 32K.

Experimental/Proof of Concepts

  • Wiz - A high-level assembly language for writing homebrew on retro console platforms (Game Boy, NES, Atari 2600, and more).
  • gbforth - A Forth-based Game Boy development kit.
  • gbasm - A JavaScript based compiler for Game Boy z80 assembly code.
  • tniASM - Macro Assembler.
  • Assembler - Assembler written in Swift.
  • llvm-gbz80 / clang-gbz80 - Clang/LLVM port to the GBZ80 CPU (similar to the deprecated euclio/llvm-gbz80).

Emulators

  • BGB - Powerful emulator and debugger. Provides an accurate hardware emulation.
  • SameBoy - Accurate emulator with a wide range of powerful debugging features.
  • Mooneye GB - Research project and emulator in Rust.
  • mGBA - Modern cross platform GBA emulator which also runs GB/GBC games.
  • Binjgb - 5Kloc emulator that passes most of the tests. Rewind feature. Runs in the browser using WebAssembly.
  • Gambatte - Cross-platform and accurate emulator.

Complete list of open source emulators

Tools

  • ZGB - A little engine for creating games for the original Game Boy (expands gbdk, more info here).
  • DevSound - Sound driver embeddable in homebrews which supports pulse width manipulation, arpeggios, and multiple waveforms.
  • Carillon Player - Music Engine for Game Boy & Game Boy Color.
  • Game Boy Tile Data Generator - HTML5 / JS web application that will convert bitmap images to hexadecimal data appropriate for use in tile based graphical applications, specifically GB.
  • Harry Mulder's GB Development - Some sources and home of Game Boy Tile Designer and Game Boy Map Builder tools.
  • GBTiles - Converts .GBR files created with Harry Mulder's Tile Designer (GBTD) and .GBM files created with Harry Mulder's Map Builder (GBMB) to different formats for use with the Game Boy and GBDK.
  • GBT PLAYER - A music player library and converter kit for Game Boy that can be used with RGBDS.
  • ROM Header Utility - An online tool to inspect and modify a ROM's header data, including the logo.
  • gbcamextract - Extracts photos from Game Boy Camera saves.
  • GBExtended - C library extending gbdk.
  • bmp2cgb - Graphics converter for Game Boy Color development providing real time palette adjustments.
  • png2gb - CLI tool to convert image file to game boy .c array.
  • gbdk-lib-extension - A small set of sources and tools for the Game Boy Development Kit by Michael Hope.
  • GB-convert - Game Boy tile conversion and map editor tool (converts to assembly).
  • cart-dumper - Game Boy Cartridge Dumper ROM.
  • Game Boy LCD sniffing - Sniff your Game Boy's LCD using a logic analyzer.
  • Dot Matrix Game Editor - An IDE for Game Boy programming in a C-like language called GBL, with many other features like tile and map extraction, WLA-DX assembly, and more.
  • brewtool - A collection of primitive editor/converter tools for making assets used with homebrew ROM development.
  • Game Boy Text Tools - Set of tools for text manipulation and translation of Game Boy ROMs written in NodeJS
  • mmlgb - A MML parser and GBDK sound driver for the Nintendo Game Boy.
  • XPMCK - An MML-based music compiler with support for Game Boy & Game Boy Color.
  • mgbdis - Game Boy ROM disassembler with RGBDS compatible output.
  • Retr0 GB - An engine for creating games (expands GBDK).
  • awake - Game Boy decompiler.
  • swapdump - Diagnostic utility for Game Boy flashcarts.
  • Gameboy-LinkUp - Game Boy LinkUp serial cable networking project.
  • vtGBte - A minimalistic ncurses tile editor.

Programming

ASM

Timings

Boilerplates

C

Syntax highlighting packages

Homebrews

  • Homebrew Hub - Every unofficial homebrew ever produced for Game Boy playable online (mobile/touch too): a community-lead attempt to collect, archive and save every unofficial game, homebrew, demo, patch, hackrom for Game Boy (Color) produced by the community through years of passionate work.
  • Infinity - RPG developed by Affinix Software primarily between the years 1999 and 2001. The game never found a publisher and was eventually canceled. Got recently released with the full source, development tools and workflows.

ASM

C

Hack ROMs

Demos

ROMs Disassembly

Articles and tools

Related projects

  • ArduinoBoy - Serial communication (MIDI) from an Arduino to the Game Boy for music applications such as LittleSoundDJ, Nanoloop, and mGB.
  • papiGB - Game Boy Classic fully functional FPGA implementation from scratch.
  • fpgaboy - Implementation Nintendo's Game Boy console on an FPGA.
  • Piglet - A LUA-driven AI that plays classic Game Boy color games using experimentation. In active development.
  • Gatesboy - Non-gaming purposes applications development.
  • Ostrich - A Game Boy Sound System player written in Swift.
  • mGB - A Game Boy cartridge program that enables the Game Boy to act as a full MIDI supported sound module.
  • GBVisualizer - Demonstrating the use of two undocumented Game Boy Color registers, nicknamed PCM12 (FF76) and PCM34 (FF77), which can be used to read the current PCM amplitude of the 4 APU channels.
  • GBVideoPlayer - A technical demo demonstrating how the Game Boy LCD controller can be hacked to make a Game Boy Color play a full motion video in color, together with music.
  • ArduinoGameBoy - Arduino based Game Boy cartridge reader and writer.
  • gameboy-brainfuck - Brainf*ck interpreter.
  • gbfk - Brainf*ck interpreter, with input.
  • gb-save-states - Patches to add save state support to Game Boy games when playing on the original hardware.
  • gbcpu - A CPU and peripherals implementing the Game Boy instruction set and functionality.
  • Digitized Speech in Game Boy Games
  • Sniffing Game Boy serial traffic with an STM32F4
  • Virtual Game Boy Printer with an STM32F4
  • Printing on the Game Boy Printer using an STM32F4
  • Pokemon Pocket Computer: - What is it and how to use it to make cheat codes.
  • Booting the Game Boy with a custom logo - Bypassing the Nintendo logo check.
  • Making a Game Boy game in 2017: A "Sheep It Up!" Post-Mortem (part 1, part 2)
  • Nintendo's fake logos - Every cartridge has to show the authentic logo to be considered valid and be run, but obviously some companies managed to exploit the check system.
  • liblsdj - Utility library for interacting with the LSDj save format (.sav), song files (.lsdsng) and more.
  • lsdpatch - Tool for modifying samples, fonts and palettes on LSDj ROM images.
  • Game Boy video effects - Some little experiments using the STAT interrupt to do funny video manipulations.

Directories

Websites

About

Contribute

Take a look at Contribution Guidelines.

License

Licensed under GPLv3. See LICENSE for more information.

Acknowledgements

Thanks to every contributor of this project, Jeff Frohwein, Pascal Felber, KOOPa, Pan of Anthrox, GABY, Marat Fayzullin, Paul Robson, BOWSER, neviksti, Martin “nocash" Korth, Nitro2k01, Duo, Chris Antonellis, Michael Hope, Beware, Jonathan “Lord Nightmare” Gevaryahu, Carsten Sorense, Sindre Aamås, Otaku No Zoku, GeeBee.

Sponsors

Special thanks to our friends at DigitalOcean, sponsoring the open source activites of our Game Boy Development community (announcement).