Skip to main content
FORGE is 21 packages. Each owns one domain and exposes its capability through exports and events. This page is the map; per-package reference pages cover each one’s API in detail.

Foundation

PackageOwns
forge-coreLogging, the Result helper, database access, permissions, identity, save coordination, the service registry. Loads first; everything depends on it.
forge-testsThe in-editor test runner and assertion library.
forge-uiThe client UI framework, WebUI views, the input-mode stack, notifications, the HUD mount.
forge-devtoolsDev-only tooling: log control, event tracer, state dumps (dumpchar), scenarios, the coords console command. Disabled for distribution.

Character

PackageOwns
forge-charactersCharacter identity, multi-character rosters, creation, appearance, activation, staging.
forge-attributesAttribute definitions, base values, and stacked modifiers (computed at read time).
forge-progressionLevels, an XP curve, attribute points, and refcounted unlocks.
forge-effectsTimed/permanent status effects that push attribute modifiers and tags while active.

Items & world

PackageOwns
forge-itemsThe item catalog (immutable definitions) and instance toolkit. The shared vocabulary every item system speaks.
forge-inventoryContainers: the player bag, world drops, named stashes. Add/move/merge/split/swap, weight and slot caps.
forge-equipmentWorn/wielded items as an equip container: slots, fit rules, and equip consequences (modifiers + granted effects).
forge-lootLoot tables, rolling, and delivery (grant to a holder or spill to a drop).
forge-craftingRecipes, known-recipe knowledge, stations, and the crafting job loop.
forge-economyAudited wallets, currencies, shops, proximity pay, and trade.
forge-interactionsWorld interactables: prompts, distance gating, cooldowns, routing to a handler.
forge-instancingManaged private instances over HELIX’s isolation (offset Z-stacking or dimensions).

Gameplay

PackageOwns
forge-combatFORGE-authoritative HP, damage with a validator chain, death, heal, revive, archetypes.
forge-abilitiesAbility definitions, the hotbar, cooldowns, mana, casting, and projectile resolution.
forge-questsQuest registry, progress state machine, event-driven objectives, rewards, and dialogue.
forge-factionsMembership (ranks, perms), reputation tiers, points/leaderboards, and a friendly-fire validator.
forge-adminAn audited, permission-gated GM surface that wraps owning-package exports. Adds zero gameplay.

Example content

forge-examples/forge-example-content is not a framework package, it’s the reference themed showcase (a magic-academy slice) that demonstrates how a creator builds on FORGE. Delete it and the framework still boots. See the fork model.

How they depend on each other

Dependencies flow upward: foundation → character/items → gameplay. A package only ever reaches another through exports and events, and gates on the dependency’s IsReady() before calling it. Nothing depends on the example content.

Build something

The guides walk through registering content against these packages.