forge/docus/dist/raw/server-extension/api-reference.md
Jacob Schmidt 827f3303a2 feat: add initial Docus setup and sync tool for documentation generation
- Created package.json for Docus with necessary scripts and dependencies.
- Implemented sync-docus-docs.mjs to automate the generation of documentation files from source markdown.
- Defined mappings for generated pages and virtual routes to ensure proper linking in documentation.
- Added static content files for the documentation structure, including navigation and index pages.
2026-04-21 16:07:27 -05:00

1.2 KiB

Forge Server API Reference

The Forge server extension exposes domain-oriented commands through callExtension. Persistent data is stored through the configured SurrealDB connection and schema modules.

Core Commands

"forge_server" callExtension ["version", []];
"forge_server" callExtension ["status", []];
"forge_server" callExtension ["surreal:status", []];

status and surreal:status return initializing, connected, or failed.

Domain Commands

Game systems should call the domain APIs instead of raw database operations:

  • actor:*
  • bank:*
  • garage:*
  • locker:*
  • org:*
  • phone:*
  • store:*
  • task:*
  • cad:*
  • owned:garage:*
  • owned:locker:*
  • transport:*

Large request and response payloads are routed through the transport layer when needed by forge_server_addons_extension_fnc_extCall.

Module Guides