89169f1e84
- Revised README.md for the Forge Client Example Addon to clarify its purpose as a template. - Enhanced MODULE_REFERENCE.md to categorize guides into Server and Extension guides and Client guides. - Created detailed usage guides for various client addons including Actor, Bank, CAD, Garage, Locker, Notifications, Organization, Phone, and Store. - Added a Client Common Usage Guide to outline shared browser UI bridge patterns. - Introduced a Client Main Usage Guide to define the foundational elements for client addons. - Established authoritative state notes and usage rules across new guides to ensure clarity on server ownership and client responsibilities.
2.3 KiB
2.3 KiB
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.
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.
Server and Extension Usage Guides
- Actor Usage Guide
- Bank Usage Guide
- CAD Usage Guide
- Garage Usage Guide
- Locker Usage Guide
- Organization Usage Guide
- Owned Storage Usage Guide
- Phone Usage Guide
- Store Usage Guide
- Task Usage Guide
Client Usage Guides
- Client Usage Guide
- Client Main Usage Guide
- Client Common Usage Guide
- Client Actor Usage Guide
- Client Bank Usage Guide
- Client CAD Usage Guide
- Client Garage Usage Guide
- Client Locker Usage Guide
- Client Notifications Usage Guide
- Client Organization Usage Guide
- Client Phone Usage Guide
- Client Store Usage Guide