Ubuntu / Linux Mint Installation


First you need pip available, as well as dependencies:

sudo apt-get install python3-pip git python3-setuptools cmake build-essential libsdl2-dev libopenal-dev docker.io

Fixing the $PATH

For some reason, Ubuntu doesn't add user-installed Python executables to the $PATH so you'll need to do that for the simulant command to work once installed:

echo "PATH=$HOME/.local/bin:$PATH" >> ~/.profile
source ~/.profile

Authorising Docker

You must be a member of the docker group to use the docker command.

sudo usermod -aG docker $USER

You'll need to log out and log back in for this to take effect (easiest to reboot to be sure!)


Next, you need to install the simulant-tools pip package:

pip3 install -U --user git+https://gitlab.com/simulant/simulant-tools.git

One installation is complete, you will have access to the simulant command.

Creating your first project

Getting started is easy:

$ simulant start myprojectname
$ cd myprojectname
$ simulant run --rebuild

That's it!

Updating to latest Simulant

Simulant is under heavy development (and unstable), it is recommended you regularly update to get the latest fixes:

$ simulant update

Building for the Dreamcast

To build for the Dreamcast you must have Docker and have downloaded the Docker kazade/dreamcast-sdk container.

Then, simply:

$ simulant package dreamcast

This command will take a while on first run as it downloads the Docker image

This will generate a .cdi image ready to burn. If you have 'lxdream' installed, you can run the CDI:

$ simulant run dreamcast