Merge branch 'master' into Lyberta/WaypointIcons

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

diff --git a/help.cfg b/help.cfg
new file mode 100644 (file)
index 0000000..70b7c8a
--- /dev/null
+++ b/help.cfg
@@ -0,0 +1,25 @@
+// Simple help message system
+
+// First exec this file, then the correct help-*.cfg for your ruleset.
+
+// 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" "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
+alias help_say "set help_tmp_oldnick \"$sv_adminnick\"; set sv_adminnick \"$help_cfg_nick\"; say \"$*\"; help_say2"
+alias help_say2 "set sv_adminnick \"$help_tmp_oldnick\""
+alias help_doit "sv_cmd rpn /help_tmp_msg help_msg_$help_tmp_index def; help_doit2"
+alias help_doit2 "help_say $help_cfg_prefix$help_tmp_msg"
+alias help_inc "sv_cmd rpn /help_tmp_index help_tmp_index 1 add $help_msg_count mod def"
+alias help_next "help_inc; help_doit" // increment first - if the ruleset changed, the number of tips could have too, this avoids overflow
+alias help_loop "help_next; defer $help_cfg_time help_loop"