adjust the comments, add a tip

[xonotic/xonotic-data.pk3dir.git] / help.cfg

diff --git a/help.cfg b/help.cfg
index 21b7afb630802a5b96bbcb697edc47bd759916a7..52cfb09f3377f8cadb963e0577b1b542b7915e20 100644 (file)
--- a/help.cfg
+++ b/help.cfg
@@ -1,17 +1,17 @@
 // Simple help message system
-// It prints messages with the configured name and interval to all connected users
-// Exec this file and start the help system with the command help_loop
-// You can adjust those two settings and change the messages and their count
-// help_cfg_time is the time between two messages in seconds
-// help_cfg_prefix is prepended to each message, useful to color the nick and message differently
-// help_msg_count is from 0 to last message, thus one more then the last message number you want
+// It prints messages with the configured name
+
+// You can start the help system with the command help_loop but this has been found to annoy players.
+// A better way is to put `alias sv_hook_gamestart_all "defer 20 help_next"` into your server.cfg,
+// that way you get one message per match.
+
 // the messages need to be starting from 0 and be consecutive
 // for manual use: help_inc switches to the next message, help_doit will print the current message, help_next will do both together
 
 // settings
-set help_cfg_nick "^2Help System^3"
-set help_cfg_time 5
-set help_cfg_prefix "^2"
+set help_cfg_nick "^2Help System^3" "the messages will appear in chat coming from the sever using this name"
+set help_cfg_time 5 "the time between two messages in seconds when started using help_loop"
+set help_cfg_prefix "^2" "prepended to each message, useful to color the nick and message differently"
 
 // aliases making up the actual helpsystem
 set help_tmp_index -1 // -1 since we first increment, then show it