20
Compiling spice2x
bicarus edited this page 2026-08-11 09:40:57 -07:00

Use Docker scripts included with source (build_docker.sh / build_docker.bat). The Docker image is based on Arch. This is the method used to produce release packages and in continuous integration.

If you notice that the Docker method stopped compiling, please file a bug. Occasionally the images on Docker repository get updated and break the build.

Github Actions

If you fork the repo, you will also inherit Github Actions that will run the Docker build scripts as part of CI. You can also manually invoke a build by running Draft Release action.

Arch

See README.md included in the source file for more details on compiling on Arch Linux.

Even if you're not using Docker, checkout the Dockerfile which gives you a list of packages needed to compile locally.

If you're on Windows, WSL with Arch should also work in theory.

Ubuntu

Setting up the environment in Ubuntu: https://github.com/spice2x/spice2x.github.io/issues/58

If you're on Windows, WSL with Ubuntu should also work in theory.

Other environments and compilers

Not supported; specifically, MSVC on Windows is not supported due to incompatibility and cost of maintenance. We do occasionally accept PRs that fix compilations in such environments, but don't expect every release to build in unsupported environments.

Compiling WinXP variants

WinXP variants use an entirely separate toolchain. It runs as part of the main build script.

Help! spice2x suddenly stopped compiling!

Most likely, this is due to some upstream change in MinGW. This is the unfortunate result of relying on Arch tool chain. Please report a bug or file a PR.