diff --git a/content/help/admin-commands.toml b/content/help/admin-commands.toml new file mode 100644 index 0000000..f0f69b4 --- /dev/null +++ b/content/help/admin-commands.toml @@ -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 teleport to zone spawn point + @dig create new zone + @paint toggle terrain paint mode + @save save current zone to file + @place place a thing at your position + + spawning + spawn spawn a mob at your tile + + content management + reload hot-reload TOML definition + edit edit combat move in-game + + help topics + @help list all help topics + @help create create new help topic + @help edit edit existing topic + @help remove remove topic + + player management + @promote grant admin status + @demote revoke admin status + + paint mode (after @paint) + p toggle painting on/off + brush set brush character + movement paint or survey while moving + + other useful commands + power up/down/ manage power level + snapneck instant kill unconscious target + + see also: help building, help spawning, help editing, help content +""" diff --git a/content/help/building.toml b/content/help/building.toml new file mode 100644 index 0000000..6965558 --- /dev/null +++ b/content/help/building.toml @@ -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 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 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 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/.toml + + navigating + @zones list all zones + @goto teleport to a zone's spawn point + + zones are saved as TOML files in content/zones/ and persist across restarts. +""" diff --git a/content/help/content.toml b/content/help/content.toml new file mode 100644 index 0000000..62ebea2 --- /dev/null +++ b/content/help/content.toml @@ -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 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 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 +""" diff --git a/content/help/editing.toml b/content/help/editing.toml new file mode 100644 index 0000000..4c2efbc --- /dev/null +++ b/content/help/editing.toml @@ -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 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/.toml. saves write directly to the file. + + after editing, use 'reload ' to hot-reload the changes without + restarting the server. + + see also: help content, help admin-commands +""" diff --git a/content/help/spawning.toml b/content/help/spawning.toml new file mode 100644 index 0000000..6c8b132 --- /dev/null +++ b/content/help/spawning.toml @@ -0,0 +1,27 @@ +name = "spawning" +title = "spawning mobs and things" +admin = true +body = """ + spawn command creates mobs at your current position. + + usage + spawn 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 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. +"""