Merge branch 'master' of github.com:OnStarPrograms/gb-asm-tutorial

Author: starprograms

.github/workflows/build-and-deploy.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install mdbook
         uses: peaceiris/actions-mdbook@v1
         with:
-          mdbook-version: latest
+          mdbook-version: 0.4.52
 
       - name: Install static-sitemap-cli
         run: npm install static-sitemap-cli

.github/workflows/build-unbricked.yml

@@ -0,0 +1,34 @@
+name: Build Unbricked example code
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download and extract RGBDS v1.0.0
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          RGBDS_URL="https://github.com/gbdev/rgbds/releases/download/v1.0.0/rgbds-linux-x86_64.tar.xz"
+          DEST_DIR="$RUNNER_TEMP/rgbds"
+
+          mkdir -p "$DEST_DIR"
+          curl -L --fail --retry 3 -o "$RUNNER_TEMP/rgbds.tar.xz" "$RGBDS_URL"
+          tar -xJf "$RUNNER_TEMP/rgbds.tar.xz" -C "$DEST_DIR"
+
+          # Add extracted folder to PATH for later steps
+          echo "$DEST_DIR" >> "$GITHUB_PATH"
+
+      - name: Run build script
+        shell: bash
+        run: |
+          set -euo pipefail
+          cd unbricked
+          chmod +x ./build_all.sh
+          ./build_all.sh

.gitignore

@@ -5,4 +5,6 @@
 /galactic-armada/src/generated
 /galactic-armada/dist/
 /galactic-armada/obj/
-.idea
+.idea
+*.gb
+*.o

README.md

@@ -1,25 +1,36 @@
-# GB ASM tutorial (v2)
+# GB ASM tutorial
 
-Re-doing [GB ASM Tutorial](https://github.com/ISSOtm/gb-asm-tutorial-old), and this time, until the end.
+A book that teaches how to develop games for the Game Boy and Game Boy Color using assembly language and the RGBDS toolchain.
 
-## Translating
-
-To help translate the tutorial, join the [project on Crowdin](https://crowdin.com/project/gb-asm-tutorial).
+You can read it at https://gbdev.io/gb-asm-tutorial/.
 
 ## Contributing 
 
 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](https://www.rust-lang.org/tools/install) and [mdBook](https://github.com/rust-lang/mdBook#readme).
+1. Install [Rust](https://www.rust-lang.org/tools/install) and [mdBook](https://github.com/rust-lang/mdBook#readme) (v0.4.x).
   mdBook powers the book itself, Rust is used for some custom plugins.
+  ```bash
+  $ cargo install mdbook@0.4.52
   ```
-  $ cargo install mdbook
-  ```
-2. Within a terminal pointed at the directory `book.toml` is in, run mdBook (`mdbook build` / `mdbook watch` / `mdbook serve`).
-3. The HTML files are in `book/custom/`.
+2. Within a terminal pointed at the directory `book.toml` is in, run mdBook commands:
+
+```bash
+# 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
+```
+
+## Translating
+
+To help translate the tutorial, join the [project on Crowdin](https://crowdin.com/project/gb-asm-tutorial).
 
 ## License
 

galactic-armada/src/main/states/gameplay/objects/player.asm

@@ -234,9 +234,9 @@ MoveUp:
     sub PLAYER_MOVE_SPEED
     ld [wPlayerPositionY], a
 
-    ld a, [wPlayerPositionY]
+    ld a, [wPlayerPositionY+1]
     sbc 0
-    ld [wPlayerPositionY], a
+    ld [wPlayerPositionY+1], a
 
     ret
 

src/SUMMARY.md

@@ -29,7 +29,9 @@
 - [Input](part2/input.md)
 - [Collision](part2/collision.md)
 - [Bricks](part2/bricks.md)
+- [Title Screen](part2/title-screen.md)
 - [Decimal Numbers](part2/bcd.md)
+- [Serial Link](part2/serial-link.md)
 - [Work in progress](part2/wip.md)
 
 # Part III — Our second game

src/assets/hello-world.asm

@@ -19,7 +19,7 @@ EntryPoint:
 WaitVBlank:
 	ld a, [rLY]
 	cp 144
-	jp c, WaitVBlank
+	jr c, WaitVBlank
 
 	; Turn the LCD off
 	ld a, 0
@@ -29,7 +29,7 @@ WaitVBlank:
 	; Copy the tile data
 	ld de, Tiles
 	ld hl, $9000
-	ld bc, TilesEnd - Tiles
+	ld bc, Tiles.End - Tiles
 CopyTiles:
 ; ANCHOR: memcpy_first_two
 	ld a, [de]
@@ -39,24 +39,24 @@ CopyTiles:
 	dec bc
 	ld a, b
 	or a, c
-	jp nz, CopyTiles
+	jr nz, CopyTiles
 ; ANCHOR_END: memcpy
 
 	; Copy the tilemap
 	ld de, Tilemap
 	ld hl, $9800
-	ld bc, TilemapEnd - Tilemap
+	ld bc, Tilemap.End - Tilemap
 CopyTilemap:
 	ld a, [de]
 	ld [hli], a
 	inc de
 	dec bc
 	ld a, b
 	or a, c
-	jp nz, CopyTilemap
+	jr nz, CopyTilemap
 
 	; Turn the LCD on
-	ld a, LCDCF_ON | LCDCF_BGON
+	ld a, LCDC_ON | LCDC_BG_ON
 	ld [rLCDC], a
 
 	; During the first (blank) frame, initialize display registers
@@ -66,11 +66,12 @@ CopyTilemap:
 ; ANCHOR_END: bgp_write
 
 Done:
-	jp Done
+	jr Done
 
 
 SECTION "Tile data", ROM0
 
+; ANCHOR: tiles
 Tiles:
 	db $00,$ff, $00,$ff, $00,$ff, $00,$ff, $00,$ff, $00,$ff, $00,$ff, $00,$ff
 	db $00,$ff, $00,$80, $00,$80, $00,$80, $00,$80, $00,$80, $00,$80, $00,$80
@@ -142,10 +143,12 @@ Tiles:
 	db $54,$ff, $aa,$ff, $54,$ff, $aa,$ff, $54,$ff, $aa,$ff, $54,$ff, $00,$ff
 	db $15,$ff, $2a,$ff, $15,$ff, $0a,$ff, $15,$ff, $0a,$ff, $01,$ff, $00,$ff
 	db $01,$ff, $80,$ff, $01,$ff, $80,$ff, $01,$ff, $80,$ff, $01,$ff, $00,$ff
-TilesEnd:
+.End:
+; ANCHOR_END: tiles
 
 SECTION "Tilemap", ROM0
 
+; ANCHOR: tilemap
 Tilemap:
 	db $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00,  0,0,0,0,0,0,0,0,0,0,0,0
 	db $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00,  0,0,0,0,0,0,0,0,0,0,0,0
@@ -165,4 +168,5 @@ Tilemap:
 	db $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00,  0,0,0,0,0,0,0,0,0,0,0,0
 	db $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00,  0,0,0,0,0,0,0,0,0,0,0,0
 	db $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00, $00,  0,0,0,0,0,0,0,0,0,0,0,0
-TilemapEnd:
+.End:
+; ANCHOR_END: tilemap