IDSolutions/forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
forge/docs/README.md
Jacob Schmidt c676a9084e Consolidate shared Forge config and Arma cfg templates 
- Add shared `bin/host/config.example.toml` and remove the old host example
- Split Arma config creation between `server.cfg` and `basic.cfg`
- Update docs and examples to reflect shared host-managed config
2026-06-06 20:16:39 -05:00

5.0 KiB
Raw Blame History

Forge Documentation

Forge is split into a shared Arma addon, 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.

Arma Addon Layout

Forge now ships three Arma addon packages:

  • @forge_mod: shared client/server config classes required by Forge missions. It owns shared definitions such as Forge task Eden modules and the custom body bag vehicle config.
  • @forge_client: client-side UX, browser UIs, keybinds, and local player integrations. It depends on @forge_mod.
  • @forge_server: server-only runtime systems, extension bridge code, and authoritative mission/task execution. It depends on @forge_mod but should not be required by clients.

Mission requiredAddons should reference shared mission-facing classes through forge_mod_* addons, not forge_server_*, so clients can load and edit missions without installing the server-only mod.

Launch Prerequisites

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

  1. Start SurrealDB.
  2. Place a Forge config.toml where the extension can find it. Use arma/server/extension/config.example.toml for an extension-only config, or use bin/host/config.example.toml at the repo root when Forge Host should manage SurrealDB, ICOM, and the Arma server.
  3. Keep the config.toml SurrealDB endpoint, namespace, database, username, and password aligned with the running database.
  4. Load @forge_mod with the server's normal mod list and @forge_server as a server-only mod.
  5. Start Arma with both dedicated server config files: server.cfg through -config for server rules and mission rotation, and basic.cfg through -cfg for network tuning. Forge Host can create both files from bin/host/server.example.cfg and bin/host/basic.example.cfg.

Mission designers and players do not need to run SurrealDB unless they are hosting locally, but they do need @forge_mod for Forge mission config classes. Players also load @forge_client for player-facing UI. 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.
  • Custom Mission Generators: how communities and mission developers can create CAD-visible custom generated missions on top of Forge.
  • 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