Getting Started

You must of course have Rust installed; this guide assumes you will be using the default toolchain, including rustup and cargo. Ensure your locally installed Rust keeps pace with the MSRV.

Configure Githooks

Before committing any changes, you should first run git config core.hooksPath .githooks in your copy of the repo. This ensures the pre-commit hook to validate Rust formatting is installed.

Clang and Mold

For faster builds, this project is configured to use mold with clang as the linker under Linux.

  1. Install clang: sudo apt install clang
  2. Install mold: Read the docs

Building ARC-71

Assuming you've set up clang and mold, there's no trick to building the game: Just run cargo build (or cargo run to build and run it). If you are using VS Code, a build task is provided in the .vscode directory; simply hit Ctrl-Shift-B to build and run the game from within VS Code.