Add admin help topics for building, spawning, editing, content, and commands

This commit is contained in:
Jared Miller 2026-02-16 16:38:43 -05:00
parent 10c9d907b5
commit f450952e04
Signed by: shmup
GPG key ID: 22B5C6D66A38B06C
5 changed files with 182 additions and 0 deletions

View file

@ -0,0 +1,42 @@
name = "admin-commands"
title = "admin command reference"
admin = true
body = """
quick reference for admin @ commands.
world building
@zones list all zones
@goto <zone> teleport to zone spawn point
@dig <name> <w> <h> create new zone
@paint toggle terrain paint mode
@save save current zone to file
@place <thing> place a thing at your position
spawning
spawn <mob> spawn a mob at your tile
content management
reload <name> hot-reload TOML definition
edit <move> edit combat move in-game
help topics
@help list all help topics
@help create create new help topic
@help edit <topic> edit existing topic
@help remove <topic> remove topic
player management
@promote <player> grant admin status
@demote <player> revoke admin status
paint mode (after @paint)
p toggle painting on/off
brush <char> set brush character
movement paint or survey while moving
other useful commands
power up/down/<num> manage power level
snapneck <target> instant kill unconscious target
see also: help building, help spawning, help editing, help content
"""

View file

@ -0,0 +1,38 @@
name = "building"
title = "building zones"
admin = true
body = """
zones are spatial containers with terrain grids. this is the full workflow
for creating and editing zones.
creating zones
@dig <name> <w> <h> create a blank zone and teleport there
example: @dig castle 20 15
editing terrain
@paint toggle paint mode on/off
p toggle painting (while in paint mode)
brush <char> set the brush character
movement paint or survey as you move
paint mode lets you edit terrain tile-by-tile. after entering paint mode:
- move around to survey
- set a brush character (. for grass, # for wall, etc)
- press 'p' to start painting
- move to paint tiles
- press 'p' again to stop painting
placing objects
@place <thing> place a thing at your position
available things: bookshelf, chair, chest, fountain, lamp, nail,
painting, plank, rock, rug, sack, table
persisting changes
@save save current zone to content/zones/<name>.toml
navigating
@zones list all zones
@goto <zone> teleport to a zone's spawn point
zones are saved as TOML files in content/zones/ and persist across restarts.
"""

43
content/help/content.toml Normal file
View file

@ -0,0 +1,43 @@
name = "content"
title = "content system"
admin = true
body = """
the mud loads content from TOML files in the content/ directory.
content can be edited and hot-reloaded without restarting the server.
directory structure
content/
commands/ content commands (motd, etc)
combat/ combat move definitions
help/ help topics
mobs/ mob templates
things/ thing templates
zones/ zone definitions
recipes/ crafting recipes
dialogue/ npc dialogue trees
hot-reloading
reload <name> reload a TOML definition
example: reload punch
example: reload motd
reload works for:
- combat moves (content/combat/)
- content commands (content/commands/)
creating new content
- write a .toml file in the appropriate directory
- restart server to load it initially
- use reload to test changes after editing
editing content
edit <move> edit in-game (see 'help editing')
or edit files directly with your text editor
content format
all content files use TOML format. combat moves follow a specific
schema defined in docs/how/combat.rst. content commands use a simpler
format with name, handler/message, and optional fields.
see also: help editing, help admin-commands
"""

32
content/help/editing.toml Normal file
View file

@ -0,0 +1,32 @@
name = "editing"
title = "in-game toml editor"
admin = true
body = """
edit command opens the in-game text editor for TOML content files.
usage
edit blank editor
edit <move> edit a combat move TOML
example: edit punch
the editor supports:
- syntax highlighting for TOML
- search and replace
- undo/redo
- color depth detection (256 color or 16 color)
editor commands (in editor mode)
:h show editor help
:w save and continue editing
:wq save and exit
:q quit without saving
editing combat moves
when you edit a combat move, the editor loads the TOML file from
content/combat/<move>.toml. saves write directly to the file.
after editing, use 'reload <move>' to hot-reload the changes without
restarting the server.
see also: help content, help admin-commands
"""

View file

@ -0,0 +1,27 @@
name = "spawning"
title = "spawning mobs and things"
admin = true
body = """
spawn command creates mobs at your current position.
usage
spawn <mob_type> spawn a mob at your tile
available mobs
goblin hostile creature
librarian friendly npc with dialogue
training_dummy practice target
spawned mobs appear on your current tile and persist until killed or
despawned. mobs with loot tables drop corpses when killed.
placing things
@place <thing> place a thing (see 'help building')
available things
bookshelf, chair, chest, fountain, lamp, nail, painting, plank,
rock, rug, sack, table
things are static objects. some are containers (chest, sack), others
are furniture or decorations.
"""