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 Client Documentation
This folder documents the Arma client mod. The client side is responsible for displaying UI, handling player input, caching client-visible state, and sending CBA events to server addons.
Authoritative gameplay state lives on the server side or in the Rust extension. Client repositories should be treated as view state, not durable storage.
Architecture
- Each addon declares its own UI resources and CBA extended event handlers.
XEH_preStart.sqf/XEH_preInit.sqfcompile functions.XEH_postInitClient.sqfinitializes client repositories, UI bridges, and response event handlers.- Browser UIs send JSON events through A3API.
- SQF handlers translate browser events into local actions or server RPCs.
- Server responses update repositories and push browser events back into the UI.
Addon Docs
Related Docs
- Root Client Usage Guide
- Root Client Main Usage Guide
- Root Client Common Usage Guide
- Root Client Actor Usage Guide
- Root Client Bank Usage Guide
- Root Client CAD Usage Guide
- Root Client Garage Usage Guide
- Root Client Locker Usage Guide
- Root Client Notifications Usage Guide
- Root Client Organization Usage Guide
- Root Client Phone Usage Guide
- Root Client Store Usage Guide
- Shared web UI framework notes
- CAD map integration notes
- Root framework docs