forge/docs/README.md

2.5 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.
  • 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