hldtux/docker-sgdk repository overview

⁠Introduction

Dockerfile based SGDK⁠ toolchain.

The Dockerfile is based on this m68k-elf toolchain⁠ and it includes newlib (even though SGDK does not require it). All the tools in the image (including GCC) are Linux native and replace the Windows versions bundled with upstream SGDK. Since SGDK 2.0, bundled GCC is version 13.1. Older SGDK images come with GCC version 6.3.

The repository contains a GitLab CI/CD script that automatically builds the docker images on new tags, and pushes them to the GitLab registry, so you do not need to build the image yourself, you can just pull it from the GitLab registry. You can browse the readily available images here⁠.

The Dockerfile supports generating docker images with and without MegaWiFi support. Images with MegaWiFi support have a version tag ending with -mw (e.g. v2.11-mw tag uses the latest v2.11 SGDK tag when the image was built and has MegaWiFi support, while v2.11 tag uses the latest v2.11 SGDK tag without MegaWiFi support).

The entry point directly runs make -f $GDK/makefile.gen. Thus if you run the container mapping the directory of an SGDK project to /m68k, the container will directly try building it.

⁠Usage

⁠Building an SGDK project

To build your SGDK project, from the project directory run:

Release

docker run --rm -v $PWD:/m68k -t hldtux/docker-sgdk:v2.11

Debug

docker run --rm -v $PWD:/m68k -t hldtux/docker-sgdk:v2.11 debug

You can replace v2.11 with the version tag you want. The first time you run the command, Docker should fetch the container from the registry and run it.

You can pass additional make arguments. E.g. to clean the project run:

docker run --rm -v $PWD:/m68k -t hldtux/docker-sgdk:v2.11 clean

If you prefer staying inside the docker container, you can get an interactive shell by setting the -i (interactive) flag and overriding the entry point:

docker run --rm -v $PWD:/m68k --entrypoint=/bin/bash -it hldtux/docker-sgdk:v2.11

You do not want to type these long commands above, so it is recommended to use a script to launch them for you.

Note that this Docker container runs as unprivileged m68k user, and home is set to /m68k.