Welcome to the documentation for the OxideMUD Engine. This directory contains comprehensive manuals and reference guides tailored to the different roles and responsibilities involved in running, building, and customizing the MUD world.
Select the guide below that corresponds to your area of responsibility:
| Role / Responsibility | Guide | Description |
|---|---|---|
| New Operators & Admins | Getting Started Guide | Quick start with Docker, installation options, server configuration, and connecting clients. |
| Server Administrators | Server Administration Guide | How to configure, start, manage, and back up the MUD server. |
| Immortal & Admin Staff | Immortal Guide | Rules, permission structures, and commands for game moderators and admins. |
| World Builders & Designers | Builder Manual | World-building structure, template syntax (including stances, passives, triggers), OLC command references, and validation rules. |
| Offline/Online Builders & Players | Spade Manual | Using the spade builder TUI — offline editor, room grid, validation, script console (online mode planned). |
| AI Agents & Integrators | MCP Integration Guide | Setting up and utilizing the Model Context Protocol (MCP) server for automated building. |
| Gameplay Scriptwriters | Scripting Guide | Rhai scripting API, sandbox limits, and lifecycle — currently scaffold-only (planned). |
| Game Mechanics Reference | Game Mechanics | Reference for combat, death & ghost, rest states, skills & practice, stances, doors, regen, prompt system, communication, inventory, and time/weather. |