A book that teaches how to develop games for the Game Boy and Game Boy Color using assembly language and the RGBDS toolchain.

You can read it at https://gbdev.io/gb-asm-tutorial/.

Contributing is really easy, fork this repo and edit the files in the src directory. Then, you can send your PR.

To deploy gb-asm-tutorial locally:

1. Install Rust and mdBook (v0.4.x). mdBook powers the book itself, Rust is used for some custom plugins.

$ cargo install [email protected]

2. Within a terminal pointed at the directory book.toml is in, run mdBook commands:

# Watches the book's src directory for changes, rebuild the book, serve it on localhost:3000
#  and refresh clients for each change.
mdbook serve

# Produce a build in `book/custom/`
mdbook build
# Watch your files and trigger a build automatically whenever you modify a file.
mdbook watch

If you have Docker installed, you can pull and run the prebuilt image for this project:

docker run -p 3000:3000 \
  --mount "type=bind,source=$(pwd)/preproc,target=/code/preproc" \
  --mount "type=bind,source=$(pwd)/renderer,target=/code/renderer" \
  --mount "type=bind,source=$(pwd)/src,target=/code/src" \
  --mount "type=bind,source=$(pwd)/unbricked,target=/code/unbricked" \
  --mount "type=bind,source=$(pwd)/theme,target=/code/theme" \
  -it ghcr.io/gbdev/gb-asm-tutorial

That's it! gb-asm-tutorial is live at localhost:3000.

If you prefer to build the image yourself:

docker build -t gb-asm-tutorial .

To help translate the tutorial, join the project on Crowdin.

Different parts of gb-asm-tutorial are subject to different licenses:

• All the code contained within the tutorial itself is licensed under CC0. To the extent possible under law, all copyright and related or neighboring rights to code presented within GB ASM Tutorial have been waived. This work is published from France.
• The contents (prose, images, etc.) of this tutorial are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
• Code used to display and format the site is licensed under the MIT License unless otherwise specified.
• The code related to the i18n support is originally from Google's Comprehensive Rust and is released under the Apache License 2.0.