Revamp and modernize - v1.3

Author: aaaronic

.github/workflows/build.yml

@@ -6,9 +6,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Build
-        run: docker run --rm -v ${{ github.workspace }}:/gba aaaronic/gba-compiler:1.2
-      - name: Upload Project.gba
+        run: docker run --rm -v ${{ github.workspace }}:/gba aaaronic/gba-compiler:1.3
+      - name: Upload my_project.gba
         uses: actions/upload-artifact@v4
         with:
-          name: Project.gba
-          path: ${{ github.workspace }}/Project.gba
+          name: my_project.gba
+          path: ${{ github.workspace }}/my_project.gba

.vscode/tasks.json

@@ -2,20 +2,38 @@
     // See https://go.microsoft.com/fwlink/?LinkId=733558
     // for the documentation about the tasks.json format
     "version": "2.0.0",
+    "windows": {
+        "options": {
+            "shell": {
+                "executable": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
+                "args": ["-NoProfile", "-Command"]
+            }
+        }
+    },
     "tasks": [
         {
-            "label": "build run",
+            "label": "run",
             "type": "shell",
-            // add the mGBA.exe exact path to the relevant line(s) below, before "./Project.gba"!
-            // Make sure there is a space between the exact path and "./Project.gba".
             "windows": {
-                "command": "C:/Users/AaronHansen/Desktop/mGBA.exe ./Project.gba"
+                "command": "C:/Users/AaronHansen/Desktop/mGBA-0.10.5-win64/mGBA.exe ./my_project.gba"
+                // Add the mGBA.exe exact path to the above line inside the quotes before the space in  " ./Project.gba"!
+                //      (use double-backslash "\\" or "/" between folders),
+                // Make sure there is a space between the exact path and "./my_project.gba".
             },
             "osx": {
-                "command": "open -a /Users/aaronhansen/Downloads/mGBA.app ./Project.gba"
+                "command": "open -a /Applications/mGBA.app ./my_project.gba"
+                // Add the mGBA.app exact path to the above line,
+                // in between "open -a" and " ./Project.gba"!
+                // Make sure there is a space before/after the path the exact path and "./my_project.gba".
+            },
+            "linux":{
+                "command": "You're on your own, but the above should be close."
             },
             "problemMatcher": [],
-            "dependsOn": ["build"],
+            "dependsOn": [
+                "build"
+            ],
+            "dependsOrder": "sequence",
             "group": {
                 "kind": "build",
                 "isDefault": true
@@ -24,14 +42,20 @@
         {
             "label": "build",
             "type": "shell",
-            "command": "docker run --rm -it -v \"${PWD}:/gba\" aaaronic/gba-compiler:1.2",
+            "command": "docker run --rm -it -v \"${PWD}:/gba\" aaaronic/gba-compiler:1.3",
             "problemMatcher": []
         },
         {
             "label": "clean",
             "type": "shell",
-            "command": "docker run --rm -it -v \"${PWD}:/gba\" aaaronic/gba-compiler:1.2 bash -c 'cd /gba && make clean'",
+            "command": "docker run --rm -it -v \"${PWD}:/gba\" aaaronic/gba-compiler:1.3 clean",
+            "problemMatcher": []
+        },
+        {
+            "label": "audio",
+            "type": "shell",
+            "command": "docker run --rm -it -v \"${PWD}:/gba\" aaaronic/gba-compiler:1.3 audio",
             "problemMatcher": []
         }
     ]
-  }
+}

Dockerfile

@@ -1,27 +1,44 @@
-FROM debian:stretch
+FROM debian:trixie-slim AS wav2c_builder
 
-MAINTAINER Aaron Hansen <[email protected]>
+LABEL maintainer="Aaron Hansen <[email protected]>"
 # Copied/adapted from https://github.com/devkitPro/docker/blob/master/devkitarm/Dockerfile
 
 ENV DEBIAN_FRONTEND=noninteractive
 
+WORKDIR /wav2c
+
+RUN apt-get update && \
+    apt-get install -y build-essential wget unzip
+
+RUN wget https://github.com/aaaronic/wav2c/archive/refs/heads/master.zip && \
+    unzip -j master.zip && \
+    make
+
+FROM debian:trixie-slim
+
 RUN apt-get update && \
-    apt-get install -y apt-utils vim && \
-    apt-get install -y --no-install-recommends sudo ca-certificates pkg-config curl wget bzip2 xz-utils make git bsdtar doxygen gnupg && \
+    apt-get install -y --no-install-recommends apt-utils && \
+    apt-get install -y --no-install-recommends sudo ca-certificates wget && \
     apt-get clean
 
-RUN wget https://github.com/devkitPro/pacman/releases/download/devkitpro-pacman-1.0.2/devkitpro-pacman.deb && \
-    dpkg -i devkitpro-pacman.deb && \
-    rm devkitpro-pacman.deb && \
-    dkp-pacman -Scc --noconfirm
+RUN ln -s /proc/self/mounts /etc/mtab
+
+RUN wget https://apt.devkitpro.org/install-devkitpro-pacman && \
+    chmod +x ./install-devkitpro-pacman && \
+    sudo yes | ./install-devkitpro-pacman && \
+    apt-get clean
 
 ENV DEVKITPRO=/opt/devkitpro
 ENV PATH=${DEVKITPRO}/tools/bin:$PATH
 
-RUN dkp-pacman -Syyu --noconfirm gba-dev && \
-    dkp-pacman -Scc --noconfirm
+RUN dkp-pacman -Syyu --noconfirm --needed gba-dev && \
+    yes | dkp-pacman -Scc
 ENV DEVKITARM=${DEVKITPRO}/devkitARM
-RUN mkdir /gba
-COPY wav2c /usr/local/bin
+
+ADD entrypoint.sh /usr/local/bin
+ADD Makefile /usr/default/Makefile
+COPY --from=wav2c_builder /wav2c/wav2c /usr/local/bin
+
 VOLUME ["/gba"]
-CMD cd /gba && make
+WORKDIR /gba
+ENTRYPOINT [ "/usr/local/bin/entrypoint.sh" ]

Makefile

@@ -1,4 +1,4 @@
-PRODUCT_NAME       = Project
+PRODUCT_NAME       = my_project
 
 # You probably won't need to touch anything below here!!!
 # The one exception is the cleanup stuff.
@@ -56,12 +56,12 @@ build : $(ROM_NAME)
 
 # --- Build .elf file into .gba ROM file
 $(ROM_NAME) : $(ELF_NAME)
-	$(OBJCOPY) $(OBJCOPYFLAGS) $(ELF_NAME) $(ROM_NAME)
+	$(OBJCOPY) $(OBJCOPYFLAGS) $^ $(ROM_NAME)
 	$(GBAFIX) $(ROM_NAME)
 
 # --- Build .o files into .elf file
 $(ELF_NAME) : $(OBJECTS)
-	$(LD) $(OBJECTS) $(LDFLAGS) -o $@
+	$(LD) $^ $(LDFLAGS) -o $@
 
 # -- Build .asm files into .o files
 $(ASMOBJECTS) : %.o : %.asm
@@ -79,7 +79,7 @@ $(AUDIOHEADERS) : %.h : %.c
 
 
 clean:
-	$(RM) $(ROM_NAME) $(ELF_NAME) $(BIN_NAME)
+	$(RM) $(ROM_NAME) $(ELF_NAME) $(BIN_NAME).sav
 	$(RM) $(AUDIOOBJECTS) $(AUDIOHEADERS)
 	$(RM) *.o *.i *.s
 

README.md

@@ -1,8 +1,12 @@
 # Docker GBA Complier
 Windows people have had a particularly rough time getting up and running with GBA development.
 Since installing cygwin + devkitPro, updating system paths, and updating the Makefile to match
-has proven difficult time and time again, this Dockerfile + Makefile represents an attempt to
-unify things cross-platform in a less brittle way.
+has proven difficult time and time again, this Dockerfile (+ default Makefile) represents an
+attempt to unify things cross-platform in a less brittle way.
+
+If you're using the latest version, note that the `gcc` version included in the 1.3+ container
+is significantly stricter than the older version. `-fpermissive` and similar options may need
+to be added to the `CFLAGS` definition in your fork of the example Makefile.
 
 ## Requirements
 Docker for Desktop: https://www.docker.com/products/docker-desktop/
@@ -11,65 +15,61 @@ Note: Even if you can't get Docker running locally, I now have instructions for
 
 
 ## Building your own Docker Container (not required)
-Ths following `docker build` command is only required if you plan to create your own version of this docker container. The one in this repo is available on Docker Hub as aaaronic/gba-compiler:1.2.
+Ths following `docker build` command is only required if you plan to create your own version of this docker container. The one in this repo is available on Docker Hub as `aaaronic/gba-compiler:1.3`.
 
 Once docker is installed, you could choose to do a one-time build of the Dockerfile on your machine (*from the folder containing the `Dockerfile`*):
 
 ```
     docker build . -t gba-compiler
 ```
 A few minutes later, you should have a docker image named gba-compiler that you should not
-need to rebuild (hopefully ever again). It might spend a long time on the "Generating pacman
-keyring master key..." step).
+need to rebuild (hopefully ever again).
 
 ## Running a GBA project build (aka, compiling your GBA project)
-1. The provided Makefile needs to be in your GBA project's directory (next to all your `.h` and
-`.c` files).
-   - You should (hopefully) not need to change much about the Makefile aside from the
-`PRODUCT_NAME` line. It defaults to "Project", which leads to your resulting `.gba` file
-being named `Project.gba`. Feel free to change it to anything _without spaces or special characters_ (ex: "BouncingBox"). You can always rename the resulting file after the compilation instead.
-
+1. Run from your GBA project's directory (with all your `.h` and `.c` files).i
+  - You can optionally provide your own Makefile (ideally based on the one in this repo)
 2. Run the docker image we built above with the following special sauce:
 
 ```
-    docker run --rm -it -v ${PWD}:/gba aaaronic/gba-compiler:1.2
+    docker run --rm -it -v ${PWD}:/gba aaaronic/gba-compiler:1.3
 ```
 or, alternatively (if you chose to do your own `docker build` locally):
 ```
     docker run --rm -it -v ${PWD}:/gba gba-compiler
 ```
 
-If the compilation succeeded, you should now see a `Project.gba` (or whatever you renamed it
-to) in your project's folder.
+If the compilation succeeded, you should now see a `my_project.gba` (or whatever you renamed it
+to) in your non-default Makefile.
 
 ## Setting it and forgetting it for a project in Visual Studio Code
 Copy the included `.vscode` folder (containing `tasks.json`) into your project folder.
-Update `tasks.json`'s "build" command to point to your visualboyadvance-m installation:
+Update `tasks.json`'s "build" command to point to your mGBA installation:
 
 Windows example:
 ```
-    "command": "C:/Users/Aaron/Desktop/visualboyadvance-m.exe ./Project.gba",
+    "command": "C:/Users/Aaron/Desktop/mGBA.exe ./my_project.gba",
 ```
 Mac Example:
 ```
-    "command": "open /path/to/visualboyadvance-m.app ./Project.gba",
+    "command": "open -a /Applications/mGBA.app ./my_project.gba",
 ```
 
-Note: If you've renamed `Project.gba`, you should fix that part of the command as well.
+Note: If you've renamed `my_project.gba`, you should fix that part of the command as well.
 Also Note: if you did a local `docker build` and want to use that image,
 update the docker commands for build and clean accordingly (basically
-just remove the "aaaronic/" and the ":1.0").
+just remove the "aaaronic/" and the ":1.3").
 
 Once that's all set up and happy, the Terminal -> Run Build Task... command in the menu
 should now compile your project and open the emulator with the result (if the compile
 succeeds).
 
 Terminal -> Run Task should provide 3 options:
-- **build run**: build and run the project
+- **run**: build and run the project
 - **build**: just build the project (but don't run anything).
 - **clean**: remove all the intermediate files from builds so the next build is _from
  scratch_. This is helpful if something buggy is going on or if you've only changed header
  files and aren't seeing your expected changes in the build.
+- **audio**: convert .wav files (8-bit format) to .c / .h files.
 
 ## Acknowledgements
 The provided Dockerfile is a fork/combination of the Dockerfiles provided by devkitPro:

entrypoint.sh

@@ -0,0 +1,15 @@
+#! /bin/bash
+# entrypoint.sh
+
+CLEANUP_MAKEFILE=
+if [[ ! -f /gba/Makefile ]]; then
+  echo "Using default Makefile"
+  cp /usr/default/Makefile /gba
+  CLEANUP_MAKEFILE=1
+fi
+
+make "$@"
+
+if [[ -n "$CLEANUP_MAKEFILE" ]]; then
+  rm /gba/Makefile
+fi