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.
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
# 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](./FRAMEWORK_ARCHITECTURE.md): how SQF, web UIs,
|
|
Rust services, repositories, and SurrealDB fit together.
|
|
- [Module Reference](./MODULE_REFERENCE.md): module inventory for gameplay
|
|
domains, extension command groups, client addons, server addons, and Rust
|
|
crates.
|
|
- [Development Guide](./DEVELOPMENT_GUIDE.md): how to add or change a module
|
|
without breaking the framework boundaries.
|
|
|
|
## Server and Extension Usage Guides
|
|
|
|
- [Actor Usage Guide](./ACTOR_USAGE_GUIDE.md)
|
|
- [Bank Usage Guide](./BANK_USAGE_GUIDE.md)
|
|
- [CAD Usage Guide](./CAD_USAGE_GUIDE.md)
|
|
- [Garage Usage Guide](./GARAGE_USAGE_GUIDE.md)
|
|
- [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md)
|
|
- [Organization Usage Guide](./ORG_USAGE_GUIDE.md)
|
|
- [Owned Storage Usage Guide](./OWNED_STORAGE_USAGE_GUIDE.md)
|
|
- [Phone Usage Guide](./PHONE_USAGE_GUIDE.md)
|
|
- [Store Usage Guide](./STORE_USAGE_GUIDE.md)
|
|
- [Task Usage Guide](./TASK_USAGE_GUIDE.md)
|
|
|
|
## Client Usage Guides
|
|
|
|
- [Client Usage Guide](./CLIENT_USAGE_GUIDE.md)
|
|
- [Client Main Usage Guide](./CLIENT_MAIN_USAGE_GUIDE.md)
|
|
- [Client Common Usage Guide](./CLIENT_COMMON_USAGE_GUIDE.md)
|
|
- [Client Actor Usage Guide](./CLIENT_ACTOR_USAGE_GUIDE.md)
|
|
- [Client Bank Usage Guide](./CLIENT_BANK_USAGE_GUIDE.md)
|
|
- [Client CAD Usage Guide](./CLIENT_CAD_USAGE_GUIDE.md)
|
|
- [Client Garage Usage Guide](./CLIENT_GARAGE_USAGE_GUIDE.md)
|
|
- [Client Locker Usage Guide](./CLIENT_LOCKER_USAGE_GUIDE.md)
|
|
- [Client Notifications Usage Guide](./CLIENT_NOTIFICATIONS_USAGE_GUIDE.md)
|
|
- [Client Organization Usage Guide](./CLIENT_ORG_USAGE_GUIDE.md)
|
|
- [Client Phone Usage Guide](./CLIENT_PHONE_USAGE_GUIDE.md)
|
|
- [Client Store Usage Guide](./CLIENT_STORE_USAGE_GUIDE.md)
|
|
|
|
## Related Documentation
|
|
|
|
- [Server Extension Docs](../arma/server/docs/README.md)
|
|
- [Server Extension API Reference](../arma/server/docs/api-reference.md)
|
|
- [Server Extension Usage Examples](../arma/server/docs/usage-examples.md)
|
|
- [Client Addon Docs](../arma/client/docs/README.md)
|
|
- [Shared Rust Libraries](../lib/README.md)
|
|
- [Repository Crate](../lib/repositories/README.md)
|
|
- [Service Crate](../lib/services/README.md)
|
|
- [Model Crate](../lib/models/README.md)
|