IDSolutions/forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
forge/arma/forge_pmc_simulator.Tanoa/guides/README.md
Jacob Schmidt afb3c665af Add PMC simulator mission pack and setup flow 
- Add mission config, params, and function registrations
- Implement faction helpers and mission generators
- Include setup docs, CBA settings, and mission scaffolding
2026-05-22 22:38:38 -05:00

3.4 KiB
Raw Blame History

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.

Launch Prerequisites

Before starting a Forge-enabled dedicated server or local multiplayer test, server owners and developers must:

  1. Start SurrealDB.
  2. Place config.toml beside forge_server_x64.dll.
  3. Keep the config.toml SurrealDB endpoint, namespace, database, username, and password aligned with the running database.

Mission designers and players do not need to run SurrealDB unless they are hosting locally, but the server they join must have these prerequisites ready. See SurrealDB Setup for the full setup path.

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.
  • Player Guide: how players use CAD, phone, bank, store, locker, garage, and economy services during 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

Related Documentation