forge/docus/dist/raw/index.md
2026-05-23 09:23:12 -05:00

4.2 KiB

Forge Framework Documentation

Forge is a persistent Arma 3 framework that combines SQF addons, a Rust arma-rs extension, SurrealDB persistence, shared domain crates, and browser-backed player interfaces.

Use these docs to understand the runtime architecture, extension API surface, server gameplay modules, and client addon integration patterns.

Start here

View source

What Forge Covers

Domain

Modules

Actor, bank, CAD, garage, locker, organization, phone, store, task, and owned-storage workflows share a consistent service and extension model.

Rust

Extension

The server extension keeps command parsing thin, routes domain requests into services, and persists durable state through SurrealDB.

Durable

Persistence

Repository traits stay storage-agnostic while concrete adapters in the extension handle schema and database mapping.

Browser

UIs

Client addons host web-based interfaces inside Arma displays and synchronize state through namespaced browser bridge events.

Transport

Layer

Large payloads move through chunked request and response transport while smaller commands still use direct callExtension paths.

Development

Workflow

The docs cover module boundaries, local validation checks, and where new domain logic belongs across Rust, SQF, and web UI layers.

Documentation Areas

Getting Started

Framework overview, architecture, module reference, and development rules.

Server

Extension

Extension architecture, command surface, and SQF usage examples.

Server

Modules

Gameplay-domain usage guides for persistence, hot state, and command flows.

Client

Addons

Browser bridge, client UX entry points, and addon-specific event contracts.