forge/docus/dist/raw/getting-started.md
Jacob Schmidt 827f3303a2 feat: add initial Docus setup and sync tool for documentation generation
- Created package.json for Docus with necessary scripts and dependencies.
- Implemented sync-docus-docs.mjs to automate the generation of documentation files from source markdown.
- Defined mappings for generated pages and virtual routes to ensure proper linking in documentation.
- Added static content files for the documentation structure, including navigation and index pages.
2026-04-21 16:07:27 -05:00

1.9 KiB

Getting Started

Use this section as the main entry point for the Forge framework.

Forge combines:

  • 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

Common Commands

cargo test
npm run build:webui
.\build-arma.ps1

Start Here

Understand how SQF, Rust services, SurrealDB, and browser UIs fit together.

Review gameplay domains, infrastructure modules, and extension command groups.

See the rules for adding modules and changing boundaries without regressions.

Install SurrealDB, match Forge config values, and choose the right setup path for developers or admin-facing roles.

Follow the extension architecture, API surface, and SQF usage examples.

Dive into the actor, bank, CAD, garage, locker, organization, phone, store, task, and owned-storage guides.

Explore the client bridge model and addon-specific browser integration rules.