Awesome Gbdev Overview
A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.
🏠 Home · 🔥 Feed · 📮 Subscribe · ❤️ Sponsor · 😺 gbdev/awesome-gbdev · ⭐ 4K · 🏷️ Gaming
Awesome Game Boy Development
Join us on Discord
A curated list of awesome Game Boy (Color) Development resources, tools, docs, related projects and open-source ROMs. Inspired by the awesome (⭐333k) list thing.
You can find a (way cooler) web version of this list here.
Contents
- Introduction
- Community
- Documentation
- Emulator Development
- Software Development
- Programming
- Homebrews
- Reverse Engineering
- Game Boy Camera
- Related projects
- About
Introduction
Disambiguation
Game Boy Advance
Game Boy Advance development is covered by another project, the awesome-gbadev (⭐1k) list. GBA, however, can run GB/GBC games. It does so in a slightly different way compared to native hardware: this is covered in the Emulator Development section of this list.
Game Boy Color and Super Game Boy
This list is focused on the original Game Boy (GB or DMG, 1989), the Game Boy Color (GBC or CGB) and the Super Game Boy (SGB) are very similar systems, with a few important distinctions, such as:
- Different hardware specifications;
- Specific hardware and software features;
- Specific registers;
- Specific bugs, quirks 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
- Pan Docs - The single, most comprehensive technical reference to Game Boy available to the public. Corrected, updated and maintained by the community.
- The Cycle-Accurate Game Boy Docs (⭐191) - A precise documentation by AntonioND to make a cycle-accurate Game Boy emulator.
- Complete Technical Reference - by Gekkio.
- Game Boy Architecture: A Practical Analysis - by Rodrigo Copetti.
- Game Boy Project Report - Report of an hardware emulator (⭐6) (on a Terasic DE1-SoC Board) developed as final project for the CSEE4840 Embedded Systems Design course at Columbia University.
Opcodes
- gb-opcodes - Opcodes table
- RGBDS opcodes reference - A reference of all instructions, including short descriptions, cycle and byte counts, and explanations of flag modifications.
Game Boy Color
- Bootstrap ROM
- Unused Palettes
- Colorization palettes in the BIOS
- Boot ROM Disassembly
- GBC Hicolour notes - A technical note regarding Hicolour mode trick for Game Boy Color and its realization in the GBC game “Crystalis”.
Hardware
- DMG Schematics - Hardware schematics.
- The Game Boy Project - Provides a study on the hardware and detailed constructional information for the implementation of three 8-bit bidirectional parallel ports.
- Related custom hardware (⭐320) - by Gekkio.
- ESP8266 GB Dev Board (⭐26) - Dev board for Game Boy accessories development, powered by ESP8266.
- ESP8266 GB Printer (⭐48) - A device that emulates the GB Printer and lets you retrieve images using WiFi.
- fruttenboel - Page with loads of information on the hardware, custom boards to interface with the console and other related projects.
- Game Boy hardware database - Data and photos of various types of Game Boy consoles.
- dmg-schematics (⭐15) - Schematics and annotated overlay for the DMG-CPU B chip, extracted from die photos, made with KiCad. Also contains Electric VLSI library with layouts for some of the cells and memories.
Peripherals
- Dan Docs - Obscure Game Boy hardware documentation.
- Edge of Emulation, a series of articles about emulating and investigating Game Boy accessories. Also available as technical documents (⭐528) in the GBE- emulator documentation.
- Mobile Adapter GB - Internet connectivity and DLC on the Game Boy Color.
- The Game Boy Printer
- Pocket Sonar - A blue cart with built-in sonar hardware.
- Zok Zok Heroes - Zok Zok Heroes' Full Changer, a motion-activated accessory.
- Infrared Madness - Infrared communication on the Game Boy Color.
- Game Boy 4-Player Adapter - DMG-07.
- Barcode Boy - The first Game Boy card-scanner.
- Barcode Taisen Bardigun - A late 90s DMG-GBC barcode reader.
- DMG-07 Technical Documentation
- Game Boy Camera RE (⭐81) - Documentation about GB Camera and tools used to reverse engineer it by using Arduino.
- Creating photo realistic images with neural networks and a Gameboy Camera
- The Game Boy Printer - An in-depth technical document about the printer hardware, the communication protocol and the usual routine that games used for implementing the print feature.
- Ben Heck Reverse Engineers Game Boy Printer (Errata: the used thermal paper is expired, 4 colors are actually printable).
- Arduino Game Boy Printer Emulator (⭐318) - Emulating a Game Boy Printer via the Game Boy Link cable with an Arduino.
- Mobile Game Boy Adapter
- GB KISS LINK MODEM
Cartridges
- GB Flash Cartridges for Sale - A List of available, ready-made Game Boy Flash Cartridges.
- AntonioND's docs (⭐191) - Corrected schematics and infos on cartridge header data.
- Gekkio's Game Boy cartridge types - An overview on existing cartridge types.
- Gekkio's cartridge analysis:
- Pinout, registers descriptions and VHDL code of some cartridge types on Tauwasser's wiki:
- Game Boy Cartridges Schematics - Schematics for MBC2 and MBC3 types.
- Cartridges PCB photos
- MBC1+RAM+Battery cartridge Schematic - First schematics by Jeff Frohwein.
- MBC1 and MBC2 cartridges circuits - and explanation on how these MBC bank switch and control RAM.
- GB Rom List - Navigable table of every game released with details on their cartridges.
- Game Boy cartridge PCB photos
Custom cartridges
- Emulating a GameBoy Cartridge - Emulating the functionality of a Game Boy cartridge with the development board STM32F4.
- Wolf - Game Boy cartridge with co-processor.
- Homebrew-Gameboy-Cartridge (⭐129) - Eagle library, schematic, and board files for a cartridge PCB using an Atmel AT49F040 as ROM.
- Homebrew Gameboy Color Cartridge (⭐71) - Board layout for an EEPROM powered cartridge.
- Nekocart (⭐114) - Open-source flash cartridge using an Xilinx CPLD as MBC5 (Post).
- Reiner Ziegler's Game Boy page - Commercial and homemade programmable cartridges and programming systems. Tutorials, wiring and schematics provided.
- Gameboy-MBC5-MBC1-Hybrid (⭐49) - CPLD implementation of a MBC5/MBC1 Hybrid cartridge.
Misc
- Introduction to Game Boy Hacking - Workshop introducing basic assembly, debugging and reverse engineering.
- GBSOUND.txt (⭐52) - A document detailing the Game Boy sound engine.
- gbdev FAQs - Must read by Jeff Frohwein.
- Game Boy Bootrom - Commented dump of the DMG bootrom.
- Differences between the Z80 and the gameboy's processor
- Gameboy 2BPP Graphics Format - Information on how the Game Boy interprets VRAM tile data to color pixels.
Emulator Development
- Reverse Engineering fine details of Game Boy hardware - 43 minutes talk by Gekkio given at Disobey 2018 (errata).
- Emulation of Nintendo Game Boy (⭐4.6k) - Overview of the Game Boy hardware with the perspective of building an emulator.
- DMG-01 - An educational Gameboy Emulator in Rust and a companion book explaining its development. *Oh Boy! Creating a Game Boy Emulator in Rust- is a talk given at Rust Fest 18 about this.
- Building a Game Boy emulator in JavaScript - Step by step tutorial.
- Writing a Game Boy emulator, Cinoop
- 0dmg - Learning Rust by building a partial Game Boy emulator.
- RealBoy Emulator - A series of posts about the design and implementation of the RealBoy Emulator.
- Codeslinger - Another series of posts documenting the building of an emulator.
- Why did I spend 1.5 months creating a Gameboy emulator? - Blog post.
- binjgb rewind - Implementing a *rewind- feature.
- binjgb on the web - Porting of the binjgb emulator to Web Assembly. (Part 2)
- binjgb debugging hangs - Investigations on emulations quirks.
- Decoding Gameboy Z80 opcodes - How to algorithmically decode Game Boy instructions (as opposed to writing one huge switch-case statement).
- Porting a GO Game Boy emulator to WebAssembly
- About swotGB - Notes about the development of a Game Boy emulator in JavaScript.
- List of open source emulators
- Game Boy Doctor (⭐197) - A command line tool for comparing logs from your emulator to those from a known-correct one. Useful for line-by-line debugging of Blargg's test ROMs.
Testing
- Blargg's test roms
- Gekkio's test roms
- SameSuite (⭐33)
- Mealybug Tearoom Tests (⭐59)
- GB Accuracy Tests
- 144p Test Suite (⭐232) - Port of Artemio Urbina's 240p Test Suite to the Game Boy.
- MBC3 RTC test ROM (⭐31)
- dmg-acid2 (⭐181) and cgb-acid2 (⭐76) - Basic PPU rendering tests.
Software Development
The Choosing tools for Game Boy development essay provides an overview of the available development tools for Game Boy.
Assemblers
- RGBDS (⭐1.4k) - Assembler and linker package. Documentation.
- ASMotor (⭐76) - Assembler engine and development system targeting Game Boy, among other CPUs. Written by the original RGBDS author. Documentation (⭐76).
- wla-dx (⭐548) - Yet Another GB-Z80/Z80/... Multi Platform Cross Assembler Package. Documentation.
Compilers
- GBDK (⭐1.7k) - Maintained and modernized GBDK (Game Boy Development Kit) powered by an updated version of the SDCC toolchain. Provides a C compiler, assembler, linker and a set of libraries.
- Turbo Rascal Syntax Error - Complete suite (IDE, compiler, programming language, resource editor) intended for developing games/demos for 8 / 16-bit line of computers, including the Game Boy and Game Boy Color.
Experimental/Proof of Concepts
- RGBDS-Live - In-browser coding environment to try out RGBDS.
- Wiz (⭐409) - A high-level assembly language for writing homebrew on retro console platforms (Game Boy, NES, Atari 2600, and more).
- gbforth (⭐128) - A Forth-based Game Boy development kit.
- gbasm-rs - An opinionated Rust based compiler for Game Boy z80 assembly code.
- gbasm (⭐130) - A JavaScript based compiler for Game Boy z80 assembly code.
- tniASM - Macro Assembler.
- Assembler (⭐117) - Assembler written in Swift.
- llvm-gbz80 (⭐36) / clang-gbz80 (⭐23) - Clang/LLVM port to the GBZ80 CPU (similar to the deprecated euclio/llvm-gbz80 (⭐9)).
- gbdk-go (⭐21) - A compiler translates Go programs to C code. The output C code is built into GB ROM by GBDK.
Emulators
BGB - Powerful emulator and debugger. Provides an accurate hardware emulation.
SameBoy (⭐1.7k) - Accurate emulator with a wide range of powerful debugging features.
Mooneye GB (⭐898) - Research project and emulator in Rust.
mGBA (⭐5.7k) - Modern cross platform GBA emulator which also runs GB/GBC games.
Binjgb (⭐547) - 5Kloc emulator that passes most of the tests. *Rewind- feature. Runs in the browser using WebAssembly.
Gambatte (⭐4) - Cross-platform and accurate emulator.
MetroBoy (⭐1.1k) - A playable, circuit-level simulation of an entire Game Boy.
gbe-plus (⭐528) - A recently rewritten emulator that has a large effort in preserving the functions of obscure accessories (such as IR link, Mobile Network GB, Barcode Boy, GB Printer, local and online GB Serial Link Cable, ... )
Emulicious - Provides accurate emulation and includes powerful tools such as a profiler and source-level debugging for ASM and C via a VS Code debug adapter.
Complete list of open source emulators
Tools
Engines
- ZGB (⭐704) - A little engine for creating games for the original Game Boy (expands gbdk, more info here).
- Retr0 GB - An engine for creating games (expands GBDK).
Development tools
- GBExtended - C library extending gbdk.
- gbdk-lib-extension (⭐12) - A small set of sources and tools for the Game Boy Development Kit by Michael Hope.
- 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.
- mgbdis (⭐252) - Game Boy ROM disassembler with RGBDS compatible output.
- ROM Header Utility - An online tool to inspect and modify a ROM's header data, including the logo.
- romusage (⭐47) - Command line tool for estimating usage (free space) of Game Boy ROMs from a .map, .noi or ihx file. Works with GBDK-2020 and RGBDS.
- awake (⭐66) - Game Boy decompiler.
- Game Boy Text Tools (⭐10) - Set of tools for text manipulation and translation of Game Boy ROMs written in Node.js.
- evscript (⭐10) - A scripting language for the Game Boy, useful for enemy AI, dialogue, animations, and coroutines.
- evunit (⭐17) - A unit testing program for assembly code.
- opcode_count (⭐2) - Generates statistics on which CPU instructions are run the most often using Python and Emulicious
Graphics utilities
- Game Boy Tile Data Generator (⭐89) - 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 (GBTD) and Game Boy Map Builder (GBMB) tools.
- GBTiles (⭐15) - 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.
- bmp2cgb (⭐26) - Graphics converter for Game Boy Color development providing real time palette adjustments.
- png2gb (⭐21) - CLI tool to convert image file to game boy .c array.
- GB-convert - Game Boy tile conversion and map editor tool (converts to assembly).
- brewtool - A collection of primitive editor/converter tools for making assets used with homebrew ROM development.
- vtGBte (⭐33) - A minimalistic ncurses tile editor.
- tpp1 (⭐21) - Definition and specification of a custom GB/GBC memory/hardware mapper, as a functional superset of MBC.
- libstdgb (⭐12) - A C library of useful Game Boy operations (SDCC).
- Tilemap GB (⭐62) - GIMP image editor plug-in for importing & exporting GBMB and GBTD tilemaps and tilesets (as bitmap images or .GBM/.GBR files).
- Tilemap Helper (⭐28) - GIMP image editor plug-in for optimizing tile maps and tile sets.
- Tilemap Studio (⭐392) - A tilemap editor for Game Boy, Color, Advance, and SNES projects. Written in C++ with FLTK.
- Superfamiconv (⭐154) - Flexible and composable tile graphics converter supporting Super Nintendo, Game Boy, Game Boy Color, Game Boy Advance, Mega Drive and PC Engine formats.
Hardware and ROM utilities
- cart-dumper (⭐41) - Game Boy Cartridge Dumper ROM.
- gbcamextract (⭐47) - Extracts photos from Game Boy Camera saves.
- Game Boy LCD sniffing (⭐170) - Sniff your Game Boy's LCD using a logic analyzer.
- swapdump (⭐2) - Diagnostic utility for Game Boy flashcarts.
- Gameboy-LinkUp (⭐0) - Game Boy LinkUp serial cable networking project.
Music drivers and trackers
- DevSound (⭐49) - Sound driver embeddable in homebrews which supports pulse width manipulation, arpeggios, and multiple waveforms.
- Carillon Player - Music Engine.
- GBT PLAYER (⭐283) - A music player library and converter kit.
- mmlgb (⭐42) - A MML parser and GBDK sound driver for the Nintendo Game Boy.
- XPMCK (⭐27) - An MML based music compiler with support for Game Boy & Game Boy Color.
- GBSoundSystem (⭐13) - A modernized audio driver for GameBoy Tracker (aka the Paragon 5 music player).
- hUGETracker (⭐287) - A music tracker based on OpenMPT, focused on ease of use, compact output, and embeddability in homebrew games.
- CBT-FX (⭐23) - A GBDK-2020 sound effect driver compatible with FX-Hammer sound effects.
Programming
Guides, tutorials and tools to develop software for Game Boy using the development toolchains described in the Software Development chapter.
ASM
- gb asm tutorial - Step by step tutorial, building several ROMs to accompany its explanations.
- hardware.inc (⭐119) - Standard include file containing Game Boy hardware definitions for use in RGBDS projects.
- Assembly tutorial by David Pello - Good document to learn to produce working asm code for gb. Brief explanations of many important topics. Many examples with commented source code.
- assemblydigest (⭐76) - Exploring Game Boy programming techniques:
- Beginner's Guide to Reverse Engineering GB - Some starting tips on disassembling and reverse engineering.
- FlappyBoy: Making a simple Game Boy Game
- Super Game Boy development - Step by step tutorial to implement Super Game Boy features (frame and palettes).
- GameBoy programming tutorial: Hello World! - Step by step tutorial.
- DMGreport (⭐59) - Game programming tutorials in assembly.
- OAM DMA tutorial - Example of how to use OAM DMA in assembly.
- Game Boy Assembly Programming for the Modern Game Developer (⭐151) - An e-book about making Game Boy games in Assembly.
Sources
Fragments of code, effects, proof of concepts and generally non complete games.
- dev'rs ASM section - A lot of working demos and sources.
- EmmaEwert's experiments (⭐22) - A collection of prototype programs, mostly just toying around. Among others, a daylight effect, transparency and a weather effect.
- DeadCScroll (⭐21) - A detailed tutorial on how to make the screen wobble, among other "raster effects"
Timings
- Nitty Gritty Gameboy Cycle Timing
- Mode3 Sprite Timing
- GameBoy Color DMA-Transfers v0.0.1
- STAT interrupt timings
- Video Timing (⭐9)
Boilerplates and libraries
- rgbds-template (⭐42) - Basic hello-world example for Game Boy using RGBDS.
- Game Boy Assembly Language Primer - Simple template code with memory defines, copy routines and IBM font tilemap.
- bootstrap.gb (⭐30) - An example Game Boy project.
- Gameboy Boilerplate (⭐29) - Boilerplate project to move quicker into the actual assembly code for your game.
- GingerBread (⭐128) - A software library for making your own Game Boy games. It is made to be used alongside the book Game Boy Assembly Programming for the Modern Game Developer (⭐151) which also doubles as documentation.
- gb-vwf (⭐50) - Library to print variable-width text, comes with a demo.
- gb-boilerplate (⭐72) - A template for starting Game Boy projects, providing a Makefile for infrastructure.
- gb-starter-kit (⭐55) - An expansion on the above, including base library code as well to get started faster.
- gb-template (⭐4) - A template with basic functions such as joypad input, DMA transfers, and map/tile data loading.
Syntax highlighting packages
- gbz80-highlight (⭐7) - Notepad+- and gedit syntax highlighting files for RGBDS assembly.
- Vim syntax file for the Game Boy assembler RGBASM - Vim syntax highlighting for RGBDS assembly.
- Vim syntax file for RGBDS (⭐10) - Another Vim syntax highlighting file for RGBDS assembly.
- sublime-rgbds - A Sublime Text 3 package for RGBDS, including syntax highlighting and some completion snippets.
- Z80 Assembly support for Visual Studio Code (⭐32)
- rgbds-vscode (⭐65) - Visual Studio Code language extension for RGBDS GBZ80 Assembly.
- rgbds-mode (⭐4) - Emacs major mode for RGBDS assembly.
C
- 8-Bit Wonderland (⭐32) - Well-written introductory document about how the Game Boy works and how to start developing working code for it.
- Grooves Game Boy Programming (⭐86) - A complete set of lessons about implementing various game mechanics in a Game Boy game.
- How to Write a Simple Side Scrolling Game - Old (but still relevant) tutorial.
- Just another simple tutorial
- GBDK Tutorial - Fairly minimal game demo for getting started with GBDK.
- GBDK Sprite - Presents a workflow for getting multiple sprites to display and animate.
- GBDK Color - Extends your knowledge of basic spriting on the Game Boy by adding colors to sprites, backgrounds and the window layer.
- GBDK Joypad - Details the use of the joypad with GBDK.
- Game Boy home of Flavor - Some full games and sources.
- GBDK Configuring and Programming Tutorial - Configuring GBDK, Using Tiles, Colliding Sprites, GBTD, GBMB, Memory Management and ROM Banking.
- Simplified GBDK examples (⭐191)
- GBDK Programming Video Tutorials - A series of video tutorials introducing beginners to programming with GBDK.
- Larold's Jubilant Junkyard - A collection of detailed GBDK-2020 based tutorials.
Homebrews
Complete and open source games.
- Homebrew Hub - A community-led attempt to collect, archive and preserve every unlicensed and homebrew game released for Game Boy. Entries are playable online.
ASM
- Tuff (⭐306)
- 2048-gb (⭐112)
- Snake
- Lazerpong (⭐14)
- Geometrix (⭐29)
- µCity (⭐429)
- Carazu (⭐17)
- Snake-gb (⭐19)
- GB303 (⭐131) - GB303 wavetable-based TB-303 style synthesizer for the Nintendo Game Boy.
- Sushi (⭐5)
- Flappy-boy-asm (⭐91)
- kupman (⭐5) and some other projects.
- Adjustris (⭐15)
- exeman
- Aevilia (⭐56)
- GBSlides (⭐29) - A simple Game Boy Powerpoint-like slides viewer.
- Pokered-gbc (⭐142) - Pokémon Red remade with full GBC support.
- ToyToy (⭐10)
- StefaN (⭐4) - Fourway Breakout clone.
- Galaxia (⭐4)
- desgb (⭐14) - DES encryption.
- superhappyfunbubbletime (⭐5)
- minesweepGB (⭐11)
- Libbet and the Magic Floor (⭐35)
- waveform-gb (⭐18) - Program visualizing the wave form used by the wave channel. The wave form can be edited freely and playback of the wave is updated immediately.
- vectroid.gb - Developed with gbasm.
- PlantBoy (⭐1)
- Death Planet
- Quartet - Puzzle game for the Game Boy (Color) and Super Game Boy.
- Dangan
C
- FlappyBoy (⭐21)
- flappybird-gameboy (⭐15)
- fbgb (⭐3)
- Novascape
- Squishy the Turtle (⭐8)
- Quadratino (⭐12)
- Doctor How (⭐27)
- Super Princess' 2092 Exodus (⭐27) - (ZGB engine (⭐704)).
- GBsnake (⭐31)
- gb-mines (⭐32)
- oranges
- red hot princess carnage (⭐6)
- loderunner
- Hives
- Bubble Factory (⭐27) - *Vanilla- SDCC (no gbdk).
- GBC Atari Boxing (⭐3) - Atari 2600 Boxing clone for the Game Boy (Color).
- GB raycaster, Vision-8 (⭐14) - and some other projects.
- Tobu Tobu Girl Deluxe (⭐77) - An arcade platformer for the Game Boy (Color).
- Burly Bear vs. The Mean Foxes (GBC port)
- PostBot (⭐7)
- Guns & Riders (⭐14)
- Dino's Offline Adventure (⭐59) - A clone of the Google Chrome offline game.
- dino-gb (⭐25) - Another clone of the Chrome game.
- Evoland.gb (⭐38) - A port of the first level of Evoland.
- Petris (⭐32) - A puzzle game of shapely pets for the Game Boy Color (itch.io).
- Infinity (⭐21) - 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.
- Black Castle - Side scrolling platformer for the Game Boy (itch.io).
- Genesis - Shmup for the Game Boy (itch.io).
- Indestructo Tank!
- Super JetPak DX
- Powa! - Side scrolling platformer for the Game Boy (Color) (ZGB engine (⭐704)).
- Cavern - (ZGB engine (⭐704)).
- Mona and the Witch's Hat Deluxe - (ZGB engine (⭐704)).
- The Bouncing Ball
- DMG Deals Damage
GB Studio
- Soul Void - Interactive horror fiction.
- Deadeus
- SUPER IMPOSTOR BROS.
Demos
- Back to Color (⭐28)
- beach-gbc (⭐14)
- CUTE DEMO (⭐32)
10 PRINT
Game Boy- Roboto Demo (⭐27)
- matrix-rain-gb (⭐29) - A Matrix digital rain effect in assembler.
- GBVideoPlayer (⭐88) - 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.
- GBVideoPlayer2 (⭐96) - The second iteration of the above demo, which increases the resolution, adds stereo- PCM audio, and introduces video compression.
Reverse Engineering
- Reverse engineering Kirby's Dreamland 2
- pokemontools (⭐327) - a python module that provides various reverse engineering components for various Pokémon games.
- Reverse Engineering a Gameboy ROM with radare2 - A walkthrough to reverse engineer a Game Boy ROM challenge using radare2.
- Disassembling Link's Awakening - A series of blog posts about disassembling Link's Awakening DX.
- Reverse Engineering the GameBoy Tetris (⭐27)
- DMA hijacking - A simple technique that allows you to run custom code in most GB/SGB/CGB games, provided you have an ACE exploit.
Game Disassemblies
- Pokémon Red/Blue (⭐4k)
- Pokémon Crystal (⭐2.1k)
- Pokémon Yellow (⭐716)
- Pokémon Gold and Silver (⭐533)
- Pokémon Pinball (⭐157)
- Pokémon TCG (⭐264)
- pokegold-spaceworld (⭐350) - Pokémon Gold and Silver 1997 Space World demo.
- Link's Awakening DX (⭐841)
- Oracle of Ages (⭐171)
- Tetris (⭐25) - Complete Tetris disassembly.
- FX Hammer (⭐8)
- Harvest Moon 3 (⭐18)
- Final Fantasy Adventure (⭐17)
Game Boy Camera
Retrieving images
Game Boy Printer emulation (e.g. to retrieve images from the camera):
- Arduino Gameboy Printer Emulator (⭐318) - Emulate a gameboy printer via the gameboy link cable.
- ESP8266 Game Boy Printer (⭐48) - A device that emulates the Gameboy Printer and lets you retrieve images using WiFi powered by an ESP8266.
- WiFi GBP Emulator (⭐66) - A GameBoy printer emulator which provides the received data over a WiFi connection.
- Game Boy WiFi Printer - D1 Mini Shield (⭐22) - Game Boy Printer interface shield for D1 mini/mini Pro ESP8266 boards.
- Game Boy Printer Sniffer (⭐9) - Sniff packet communications between a Game Boy and the Printer.
Changing the camera's behavior
Methods to improve and/or manipulate the camera's quality and behavior:
- Game Boy Camera Canon EF Lens Mount
- Game Boy Camera to Canon Lens mount - based on the above.
- game-boy-camera-frame-replacer (⭐36) - Manipulate the ROM of a camera to include custom frames
Post processing
- Game Boy Printer Paper Simulation (⭐75) - Generate as-if-printed images of digital printed images.
- Game Boy Printer Web (⭐56) - Gallery app for to the Game Boy camera: import pictures from exports or cartridge dumps and choose color palettes.
Related projects
- GB Studio - Drag and drop game creator with simple, no knowledge required, visual scripting.
- ArduinoBoy (⭐317) - Serial communication (MIDI) from an Arduino to the Game Boy for music applications such as LittleSoundDJ, Nanoloop, and mGB.
- papiGB (⭐16) - Game Boy Classic fully functional FPGA implementation from scratch.
- fpgaboy (⭐95) - Implementation Nintendo's Game Boy console on an FPGA.
- Piglet (⭐43) - A LUA-driven AI that plays classic Game Boy color games using experimentation. In active development.
- Ostrich (⭐40) - A Game Boy Sound System player written in Swift.
- mGB (⭐236) - A Game Boy cartridge program that enables the Game Boy to act as a full MIDI supported sound module.
- GBVisualizer (⭐27) - 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.
- ArduinoGameBoy (⭐153) - Arduino based Game Boy cartridge reader and writer.
- gameboy-brainfuck (⭐16) - Brainf*ck interpreter.
- gbfk (⭐2) - Brainf*ck interpreter, with input.
- gb-save-states (⭐153) - Patches to add save state support to Game Boy games when playing on the original hardware.
- gbcpu (⭐9) - 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
- Programming Game Boy Chinese cartridges with 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 (⭐93) - Utility library for interacting with the LSDj save format (.sav), song files (.lsdsng) and more.
- lsdpatch (⭐174) - Tool for modifying samples, fonts and palettes on LSDj ROM images.
- Game Boy video effects (⭐5) - Some little experiments using the STAT interrupt to do funny video manipulations.
- gbos (⭐26) - A basic operating system for the Game Boy.
- Work Master OS - Russian multi tasking operating system.
- Game Boy Link Cable Breakout Board (⭐87)
- GBCartFlasher firmware (⭐24)
- VerilogBoy (⭐465) - Game Boy compatible console Verilog RTL implementation.
- GBCamcorder (⭐91) - Lo-Fi portable video recorder using a GameBoy Camera cartridge.
- GBCartRead (⭐64) - Read ROM, Read RAM or Write RAM from/to a GameBoy Cartridge.
- GBxCart-RW (⭐96) - A device for reading game ROMs, save games and restoring saves for GB, GBC and GBA carts from your PC via USB.
- Dumping the Super Game Boy Boot ROM
Directories
- Archive of related files
- The Game Boy Archive - A library of Game Boy related software, hardware and literature. Aimed to mirror and preserve old and fragmented contributions from the last three decades.
- The Game Boy Archive - Salvage (⭐32) - Historical archive of software, old articles, FAQs and various documents.
Websites
- devrs.com/gb - Old home of the scene: examples, sources, complete documentation, guides, tutorials and various tools.
- pdroms.de - Game Boy releases.
- Handheld Underground - Unlicensed games, blog posts about Game Boy, home of the hhugboy emulator.
About
Contribute
Take a look at Contribution Guidelines.
License
Licensed under GPLv3. See LICENSE for more information.
Acknowledgements
Thanks to every (⭐4k) 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 and Incube8 Games, sponsoring the open source activites of our Game Boy Development community.