3.1 KiB
title, description
| title | description |
|---|---|
| Getting Started | Use this section as the main entry point for the Forge framework. |
Forge combines:
- Arma 3 shared config addons for mission-facing classes
- Arma 3 client addons for UX and browser-hosted interfaces
- Arma 3 server addons for mission integration and authoritative flow control
- a Rust server extension for command routing and persistence
- shared Rust crates for models, repositories, and services
- SurrealDB for durable storage
Launch Prerequisites
Before starting a Forge-enabled dedicated server or local multiplayer test,
server owners and developers must start SurrealDB and make sure
config.toml is beside forge_server_x64.dll. The config values must match
the running SurrealDB endpoint, namespace, database, username, and password.
Servers must load @forge_mod as a normal mod and @forge_server as a
server-only mod.
Mission designers and players do not need their own SurrealDB instance unless
they are hosting locally, but they do need @forge_mod for shared Forge
mission classes. Players also load @forge_client for player-facing UI.
Common Commands
cargo test
npm run build:webui
.\build-arma.ps1
Start Here
::u-page-grid :::u-page-card
icon: i-lucide-network title: Architecture to: /getting-started/architecture
Understand how SQF, Rust services, SurrealDB, and browser UIs fit together. :::
:::u-page-card
icon: i-lucide-boxes title: Module Reference to: /getting-started/module-reference
Review gameplay domains, infrastructure modules, and extension command groups. :::
:::u-page-card
icon: i-lucide-wrench title: Development Guide to: /getting-started/development
See the rules for adding modules and changing boundaries without regressions. :::
:::u-page-card
icon: i-lucide-map title: Mission Designer Guide to: /getting-started/mission-designer
Place Eden interaction objects, garage markers, and Forge task modules for playable missions. :::
:::u-page-card
icon: i-lucide-user-round-check title: Player Guide to: /getting-started/player-guide
Learn the player-facing CAD, phone, bank, store, locker, garage, and economy workflows. :::
:::u-page-card
icon: i-lucide-database title: SurrealDB Setup to: /getting-started/surrealdb-setup
Install SurrealDB, match Forge config values, and choose the right setup path for developers or admin-facing roles. :::
:::u-page-card
icon: i-lucide-server-cog title: Server Extension to: /server-extension
Follow the extension architecture, API surface, and SQF usage examples. :::
:::u-page-card
icon: i-lucide-layers-3 title: Server Modules to: /server-modules
Dive into the actor, bank, CAD, garage, locker, organization, phone, store, task, and owned-storage guides. :::
:::u-page-card
icon: i-lucide-monitor-smartphone title: Client Addons to: /client-addons
Explore the client bridge model and addon-specific browser integration rules. ::: ::