Skip to main content

​
Prerequisites

Before you begin, make sure you have the following installed:
  • Rust toolchain — Install via rustup. The workspace uses Cargo’s resolver v2 and requires a recent stable toolchain.
  • git — To clone the repository.
No other system dependencies are required to build and run the engine. All graphics, audio, and windowing dependencies are fetched automatically by Cargo.

​
Get the engine running

1

Clone the repository

git clone https://github.com/Quiet-Wolfe/Rustic-Engine.git
cd Rustic-Engine
2

Build the workspace

Run a debug build to verify everything compiles. Cargo will download and compile all dependencies on the first run, which may take a few minutes.
cargo build
For a release build with optimizations:
cargo build --release
3

Run the engine

cargo run
This launches the engine starting at the title screen. The window opens at 1280×720.
Use cargo run --release for a release build with full optimizations.
4

Run the tests

Run all tests across the workspace:
cargo test
To run tests for a single crate — for example, rustic-core:
cargo test -p rustic-core
5

Run the linter

cargo clippy
Clippy is the primary lint tool used in this project. Fixing Clippy warnings is expected before committing.

​
What you can do right now

Rustic Engine is under active development. All five development phases are currently in progress. The engine starts at the title screen, but many gameplay systems are not yet complete.
The engine currently boots to a title screen via the TitleScreen state. The state machine in rustic-app handles transitions between screens, and the GPU rendering layer (rustic-render) is initialized at startup using wgpu and winit. Work is ongoing across Phase 1 (core systems and rendering foundation) through Phase 5 (Lua scripting and mod support). See Development phases for the current status of each phase.

​
Next steps