First clone, initialize submodules, install Poetry and enter the Poetry shell as
defined here. Do not forget you need to be in a
Install the required packages, depending on your operating system.
sudo apt-get install scons libsdl2-dev libsdl2-image-dev
sudo yum install scons SDL2-devel SDL2_image-devel
sudo zypper install scons libSDL2-devel libSDL2_image-devel
sudo pacman -S scons sdl2 sdl2_image
There is a
shell.nix file in the root of the project. Just run the following before entering the
- Mac OS X:
Consider using Nix. With Nix all you need to do is
For other users:
brew install scons sdl2 sdl2_image pkg-config
- Windows: not supported yet, sorry.
Run the build with:
Now you can start the emulator:
The emulator has a number of interesting features all documented in the Emulator section.
Build the debuggable unix binary so you can attach the gdb or lldb. This removes optimizations and reduces address space randomization. Beware that this will significantly bloat the final binary and the firmware runtime memory limit HEAPSIZE may have to be increased.
DEBUG_BUILD=1 make build_unix