31 lines
1.1 KiB
TOML
31 lines
1.1 KiB
TOML
name = "@help"
|
|
title = "help system administration"
|
|
admin = true
|
|
body = """
|
|
the help system stores topics as TOML files in content/help/.
|
|
each topic has a name, title, optional admin flag, and body text.
|
|
|
|
commands
|
|
@help list all help topics
|
|
@help create create a new topic (guided)
|
|
@help create <name> create a new topic with the given name
|
|
@help edit <topic> edit an existing topic
|
|
@help remove <topic> remove a topic
|
|
|
|
creating topics
|
|
@help create walks you through each field:
|
|
name the topic name (what players type after 'help')
|
|
title short description shown in listings
|
|
admin only whether only admins can view it
|
|
body the help text (opens in the editor)
|
|
|
|
editing topics
|
|
@help edit shows current values for each field.
|
|
press enter to keep the current value.
|
|
the editor opens with the existing body text.
|
|
|
|
files
|
|
topics are stored in content/help/<name>.toml
|
|
they can also be edited directly with any text editor.
|
|
changes are loaded at server startup.
|
|
"""
|