reference.md

Module Reference

This page is the reference landing map for the documented RCCE modules under docs/modules/. Use it together with the live application entrypoints in src/Client.bb, src/Server.bb, src/GUE.bb, and src/Project Manager.bb when you are tracing a runtime path through the current source tree.

Not every source module has a matching reference page yet. This index covers the modules that already have docs and calls out the largest undocumented surfaces so the page reflects the real repository state.

How To Read The Current Tree

• The client currently includes ClientAreas_FE.bb; the matching reference page is modules/clientareas.md.
• The server and editor share a large slice of gameplay/content modules, but the server also owns authority, persistence, and account/update flows.
• Project Manager now lives on newer framework, graphics, IO, and component modules that do not yet have dedicated reference pages under docs/modules/.

Application Map

Client

• Startup and resource loading: ClientLoaders, MainMenu, Media, Language, Logging
• World and rendering: ClientAreas, Environment, Environment3D, Actors, Actors3D, Animations, Projectiles3D, RottParticles, Radar
• Gameplay and interface: Items, Inventories, Spells, ClientCombat, Interface, Interface3D, Gooey, Gooey_3D_Text, CharacterEditorLoader
• Networking: RottNet, ClientNet, Packets, MD5

Server

• Core game state: Actors, Items, Inventories, Spells, Projectiles, Environment, ServerAreas
• Scripting, networking, and persistence: Scripting, RottNet, ServerNet, Packets, MySQL, Logging, Language
• Server-only control surfaces: AccountsServer, GameServer, UpdatesServer

GUE Editor

• Content databases and pickers: Media, MediaDialogs, Items, Inventories, Animations, Spells
• World and content editing: Actors, Actors3D, CharacterEditorLoader, Environment, Interface, ClientAreas, ServerAreas, Projectiles, RCTrees, RottParticles
• Shared runtime plumbing: Language, RottNet, Packets, Logging

Project Manager

Project Manager is part of the live source tree, but its current implementation leans on framework, graphics, IO, and UI-component modules that do not yet have matching pages in docs/modules/. For now, start with src/Project Manager.bb and the contributor workflow in start.md.

Documented Module Index

World, Gameplay, And Content

• Actors - actor templates and live actor instances
• Actors3D - client-side actor rendering state
• Animations - animation set loading and save flows
• CharacterEditorLoader - character editor render data loading
• ClientAreas - client-side area loading and save flows
• ClientCombat - combat UI updates and combat animation/display logic
• Environment - world time, weather, and other environment settings
• Environment3D - 3D weather, suns, and other client presentation for the environment
• Inventories - inventory ownership and item storage
• Items - item templates and persistence
• Projectiles - projectile definitions and server updates
• Projectiles3D - client-side projectile rendering
• Radar - minimap creation and updates
• RCTrees - tree assets built by the tree editor
• RottParticles - 3D particle effect assets and runtime behavior
• ServerAreas - server-side area data and weather
• Spells - ability definitions and related data

Interface, Assets, And Client Support

• ClientLoaders - client startup data loading
• Gooey - resolution-independent in-game UI framework
• Gooey_3D_Text - 3D text support for Gooey
• Interface - saved interface layout/settings data
• Interface3D - live in-game interface widgets and player input handling
• Language - localized string loading and lookup
• MainMenu - client startup menu flow
• Media - mesh, texture, sound, and music database access
• MediaDialogs - standard media selection dialogs

Networking, Services, And Server Control

• AccountsServer - account creation and account management windows
• ClientNet - client message handling and outbound updates
• GameServer - server-side game logic update loop and server window management
• Logging - log creation and log writing
• MD5 - MD5 checksum helper used by password flows
• MySQL - MySQL integration points
• Packets - network packet type constants
• RottNet - low-level networking library
• Scripting - gameplay script interpreter
• ServerNet - server message processing and broadcast flows
• UpdatesServer - update file metadata and update distribution window

Current Gaps

These source-tree surfaces are part of the live code but still lack dedicated reference pages here:

• Project Manager framework and component modules under src/Modules/Framework/ and src/Modules/Graphics/
• Server helpers such as SpawnTracking.bb
• Client/editor helpers such as F-UI.bb, FastExt.bb, and ShadowsSimple.bb

When you need those areas today, read the source entrypoint plus the corresponding module files directly.