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.
Forge Client
Forge Client contains the Arma client-side addons for Forge. It owns player UI, browser bridges, client repositories, local event handling, and client-to-server CBA RPC requests.
The client mod pairs with arma/server: client addons collect player input and
render state, while server addons and the Rust extension own authoritative
state and persistence.
Requirements
- CBA A3
- ACE3 for features that use ACE interactions, arsenal, spectator, or medical integrations
- Forge Server running the matching server-side addons
Addons
main: shared client mod config and macroscommon: shared browser UI bridge helpersactor: player interaction menu and actor repositorybank: banking UI and account request bridgecad: map/CAD UI for dispatch, groups, tasks, and support requestsgarage: vehicle storage and virtual garage UIlocker: locker and virtual arsenal repositoriesnotifications: notification HUD and soundsorg: organization portal UIphone: phone, contacts, messages, and email UIstore: storefront catalog and checkout UI
UI Pattern
Most feature UIs use an Arma display with a CT_WEBBROWSER control. JavaScript
sends JSON events through A3API, SQF handles them in fnc_handleUIEvents.sqf,
and response events are sent back into the browser with ctrlWebBrowserAction ["ExecJS", ...].
Client repositories cache the most recent state for display only. Server addons and the extension remain authoritative.
Documentation
License
Forge Client is licensed under APL-SA.