LegacyShell Documentation
Technical documentation for LegacyShell itself - not lore or trivia about Shell Shockers (that's in the Wiki section), but how to install it, run it, extend it, and understand how it works.
This section is organized by who you are and what you're trying to do, not by topic. Pick the row that matches you:
| I want to... | Start here |
|---|---|
| Just get the game running for the first time | Getting Started |
| Operate a server - accounts, moderation, multiple regions, staying online | Running a Server |
| Make maps, models, skins, or sounds - no coding | Content Creation |
| Write a plugin - new commands, gamemodes, weapons, anticheat | Plugin Development |
| Understand or change the engine itself | Codebase Reference |
| Write documentation, or I'm an AI agent orienting myself in this repo | Contributing |
Each section assumes you've read the ones above it in this table, but not the ones below - stop wherever your goal is met.
A note on how this documentation is built
Reference-heavy pages (the plugin event catalog, database schema, config keys, wire protocol opcodes) are extracted directly from the source code rather than written by hand, so they can't silently go stale as the code changes. Everything else is written prose, aimed at the specific reader named at the top of each page. See the style guide for the conventions behind both.
This page was drafted with AI assistance and reviewed for accuracy. If something looks wrong, please open a PR or flag it.
