Installation

Flint is built from source using the Rust toolchain. There are no pre-built binaries yet.

Prerequisites

Rust (stable, 1.75+) — install from rustup.rs
Git — for cloning the repository
A GPU with Vulkan, Metal, or DX12 support (for the renderer and viewer)

Clone the repository and build in release mode:

git clone https://github.com/chrischaps/flint.git
cd flint
cargo build --release

The binary is at target/release/flint (or target/release/flint.exe on Windows).

cargo run --bin flint -- --version

You should see the Flint version string.

You can run Flint directly through Cargo without installing it system-wide:

cargo run --bin flint -- <command>

For example:

cargo run --bin flint -- init my-game
cargo run --bin flint -- serve demo/showcase.scene.toml --watch

To verify everything is working:

cargo test

This runs the full test suite across all crates.

To use flint directly without cargo run:

cargo install --path crates/flint-cli

Or copy the release binary to a directory on your PATH.

With Flint built, follow Your First Project to create a scene from scratch.