Space Station 2197 Development Documentation

Developer's documentation for working with Space Station 2197.

Currently it is very crude, but you can follow the setup guide.

Setup

Environment

Before building and running the game, you need to have Rust installed on your system. Go to rustup.rs and follow the instructions to install Rust. This will install the Rust toolchain, including the cargo package manager required for the steps below.

Dependencies

Bevy will require some dependencies to be installed depending on your operating system. Follow the Installing OS Dependencies section of Bevy's Setup to install required dependencies.

Building

To compile the workspace binaries:

cargo build -p client -p server

Running

After building the project, to run the client do:

cargo run -p client

To run a headless server instance, run the following command. It will use the server_config.toml configuration file.

cargo run -p server

Make sure to set the BEVY_ASSET_ROOT environment variable to the workspace's folder before running the client or server. This is due to how crates will load assets/ relative to it's crate's path instead of the workspace's assets shared by all.