Skip to content

Build process

Jump to bottom
Benedikt Freisen edited this page Jan 31, 2024 · 3 revisions

The provided Makefiles can not only build the binary, but will also take care of preparing the game artwork and a set of disk images.

Prerequisites

The reference build host is GNU/Linux. Your mileage with other systems may vary. Feedback and tutorials for your fellow users are welcome.

These tools are required for all targets in the Makefile to work as expected:

  • git
  • YASM
  • GNU make
  • GNU bash
  • GNU sed
  • GNU mtools
  • UPX
  • ZX7 compressor and decompressor as provided by Z88DK
  • GCC C++
  • Python3
  • midicsv
  • DOSBox

The bash script get_assets.sh can pull all the required artwork from folders containing material from official Planet X3 and related downloads, such as "Planet-X3-With-Soundtrack" or "6ISLAND". It expects the respective folders in the parent directory of the px3_ose folder. The assetconv and MIDI-Converter repositories should also go there.

Please note that it is not yet possible to automatically import artwork from a Planet X3 package downloaded from the Steam platform.

Building Planet X3 OSE

If you want to build a specific version, check out the respective version tag, eg. 1.0.0, first. The aforementioned converters will either have matching version tags or the most recent version can be used for all existing tagged PX3 OSE versions. It can be advisable to repeat the game artwork import step and to trigger a clean build whenever you switch between versions, because the import process may differ between versions.

Once all prerequisites are available, building disk images and running the game in DOSBox can be as simple as typing the following command in a terminal:

$> make dosbox_vga

This will implicitly build a whole bunch of disk images. You can also rebuild just the px3_ose.com binary:

$> make build/px3_ose.com

Read the Makefile itself for further details.

Clone this wiki locally