forge/docs/README.md
Jacob Schmidt b7f7ae3a01 Add mission designer guide and Eden assets
- Document Eden object, garage, and task setup for playable missions
- Add the new getting-started page and update navigation links
- Rename store actor variable to `isStore` in the docs
2026-05-16 19:19:51 -05:00

2.7 KiB

Forge Documentation

Forge is split into Arma client addons, Arma server addons, a Rust server extension, shared Rust domain crates, and web UI build tooling. This directory collects framework-level documentation for those pieces.

Start Here

  • Framework Architecture: how SQF, web UIs, Rust services, repositories, and SurrealDB fit together.
  • Module Reference: module inventory for gameplay domains, extension command groups, client addons, server addons, and Rust crates.
  • Development Guide: how to add or change a module without breaking the framework boundaries.
  • Mission Designer Guide: how to place Eden objects, garage markers, and CAD-compatible task modules for playable missions.
  • SurrealDB Setup: where to get SurrealDB or Surrealist and how to connect Forge to it for local or live use.

Server and Extension Usage Guides

Client Usage Guides