forge/arma/server/addons/org/README.md
Jacob Schmidt 9d789440e0 Enhance documentation and functionality across various server addons
- Updated README.md files for extension, garage, locker, main, organization, phone, store, and task addons to provide clearer overviews, dependencies, main components, and usage notes.
- Improved task module documentation to clarify timer semantics and server task flows, ensuring accurate usage of time limits.
- Adjusted default values for task time limits and IED timers to enforce positive countdown requirements.
- Added new CAD addon for dispatch coordination, including its overview, dependencies, main components, and event handling.
2026-04-18 11:55:19 -05:00

37 lines
1.3 KiB
Markdown

# Forge Server Organization
## Overview
The organization addon is the server-side bridge for player organizations,
membership, treasury funds, reputation, credit lines, shared assets, fleet
entries, and invitations.
Organization hot state is owned by the extension. SQF coordinates Arma-facing
events, UI payloads, membership syncs, and integration with actor, bank, store,
and task flows.
## Dependencies
- `forge_server_main`
- `forge_server_common`
- `forge_server_extension` at runtime for organization extension calls
- `forge_server_actor` at runtime for organization membership lookups
- `forge_client_org` and `forge_client_notifications` for response RPCs
## Main Components
- `fnc_initOrgStore.sqf` initializes `OrgModel` and `OrgStore`.
- `fnc_initPayloadBuilder.sqf` builds portal, organization, member, asset, and
fleet payloads.
## Supported Operations
- initialize and hydrate organization portal data
- register, leave, and disband organizations
- invite, accept, and decline members
- assign and repay credit lines
- update funds and reputation
- grant assets and fleet vehicles
- save organization hot state
## Runtime Notes
The addon ensures the `default` organization exists during store creation.
Task rewards and store checkout both rely on `OrgStore` for authoritative
organization-owned state.