Add debug build option

Author: mdeclerk

.vscode/tasks.json

@@ -10,13 +10,21 @@
       "problemMatcher": []
     },
     {
-      "label": "Bananas: Build",
+      "label": "Bananas: Build (Release)",
       "type": "shell",
       "command": "${workspaceFolder}/scripts/build.sh",
       "group": { "kind": "build", "isDefault": true },
       "presentation": { "reveal": "always", "panel": "shared" },
       "problemMatcher": []
     },
+    {
+      "label": "Bananas: Build (Debug)",
+      "type": "shell",
+      "command": "${workspaceFolder}/scripts/build.sh DEBUG=1",
+      "group": "build",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    },
     {
       "label": "Bananas: Clean",
       "type": "shell",
@@ -34,9 +42,17 @@
       "problemMatcher": []
     },
     {
-      "label": "Bananas: Build & Play",
+      "label": "Bananas: Build (Release) & Play",
+      "dependsOrder": "sequence",
+      "dependsOn": ["Bananas: Build (Release)", "Bananas: Play"],
+      "group": "test",
+      "presentation": { "reveal": "always", "panel": "shared" },
+      "problemMatcher": []
+    },
+    {
+      "label": "Bananas: Build (Debug) & Play",
       "dependsOrder": "sequence",
-      "dependsOn": ["Bananas: Build", "Bananas: Play"],
+      "dependsOn": ["Bananas: Build (Debug)", "Bananas: Play"],
       "group": "test",
       "presentation": { "reveal": "always", "panel": "shared" },
       "problemMatcher": []

Makefile

@@ -17,6 +17,10 @@ HDRS := $(shell find $(SRC_DIR) -name '*.h') $(ASSET_HDRS)
 
 CPPFLAGS := -I$(BUILD_DIR)
 
+ifeq ($(DEBUG),1)
+CFLAGS += -Wa-l -Wl-j -Wl-m -Wm-yS
+endif
+
 PNG2ASSET_FLAGS := -keep_duplicate_tiles -no_palettes -map -bpp 2 -tiles_only -pack_mode gb -noflip -keep_palette_order
 
 all: $(ROM)
@@ -31,7 +35,7 @@ $(GEN_DIR)/%.c: $(ASSET_DIR)/%.png Makefile | $(GEN_DIR)
 $(GEN_DIR)/%.h: $(GEN_DIR)/%.c ;
 
 $(ROM): $(SRCS) $(HDRS) | $(BUILD_DIR)
-	$(CC) $(CPPFLAGS) -o $@ $(SRCS)
+	$(CC) $(CPPFLAGS) $(CFLAGS) -o $@ $(SRCS)
 
 clean:
 	rm -rf $(BUILD_DIR)

README.md

@@ -14,16 +14,21 @@ A 2-player artillery game for the original Game Boy (DMG), inspired by the class
 
 Download the latest release ROM [bananas.gb](https://github.com/mdeclerk/Bananas/releases/latest) and run with [SameBoy](https://sameboy.github.io/) or [mGBA](https://mgba.io/).
 
+## Prerequisites
 
-## Getting Started
+- Docker (containerized build environment)
+- [SameBoy](https://sameboy.github.io/) (GameBoy emulator)
+
+## Build environment
 
 ```sh
-./scripts/init.sh     # one-time Docker build env setup
-./scripts/build.sh    # compile → build/bananas.gb
-./scripts/play.sh     # launch SameBoy
+./scripts/init.sh             # one-time Docker build env setup
+./scripts/build.sh            # release build → build/bananas.gb
+./scripts/build.sh DEBUG=1    # debug build with .map + .sym/.noi symbols
+./scripts/play.sh             # launch SameBoy with build/bananas.gb
 ```
 
-All scripts are also available as VS Code tasks via **Terminal → Run Task** (Init, Build, Clean, Play, Build & Play).
+All scripts are also available as VS Code tasks via **Terminal → Run Task**.
 
 ## How to play
 
@@ -33,12 +38,7 @@ All scripts are also available as VS Code tasks via **Terminal → Run Task** (I
   <img src="docs/gameplay-subtitled.gif" alt="Gameplay demo" width="336">
 </p>
 
-## Prerequisites
-
-- Docker (containerized build environment)
-- [SameBoy](https://sameboy.github.io/) (GameBoy emulator)
-
-## Project Structure
+## Project Layout
 
 ```
 src/              Source code — gameplay, physics, rendering, input, sfx