Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Development Setup

Prerequisites

  • Rust 1.94.1 (stable). The project pins this in rust-toolchain.toml.
  • cargo-deny for supply-chain checks: cargo install cargo-deny
  • mdbook for documentation: cargo install mdbook

Clone and Build

git clone https://github.com/greysquirr3l/shadowforge-rs.git
cd shadowforge-rs
cargo build --workspace

Verify

cargo test --workspace
cargo clippy --workspace -- -D warnings
cargo deny check

Optional: PDFium

PDF rasterisation requires the PDFium shared library. On macOS:

brew install pdfium

On Linux, download the prebuilt binary from pdfium-binaries and place it on LD_LIBRARY_PATH.

Editor Setup

The project includes .vscode/settings.json with rust-analyzer configuration. VS Code with the rust-analyzer extension will pick up lints and formatting automatically.