From eeb81e646e586d58355317d17b0d328651ee614a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Mart=C3=ADnez?= Date: Sat, 26 Oct 2013 13:41:20 -0700 Subject: [PATCH] Created Usage (markdown) --- Usage.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 Usage.md diff --git a/Usage.md b/Usage.md new file mode 100644 index 0000000..bb18600 --- /dev/null +++ b/Usage.md @@ -0,0 +1,49 @@ +Once the game is connected to the IRC channel, chatting using the `T` or +`F10` hotkeys will send the messages to the channel, and will be visible +by anyone. Also, when someone sends a message to the channel, that text +will be visible in-game. + +### Chat Commands ### + +* `/irc_msg ` -- Sends a private message to a IRC user. + For security reasons, users cannot send messages to any nick which + ends in either `Serv` or `Bot` (case insensitive). +* `/join` -- Join the IRC channel. +* `/part` -- Part the IRC channel. +* `/irc_connect` -- Connect the bot manually to the IRC network. + Requires `irc_admin` privilege. +* `/irc_disconnect` -- Disconnect the bot manually from the IRC + network (this does not shutdown the game). +* `/irc_reconnect` -- Equivalent to `/irc_disconnect` followed + shortly by `/irc_connect`. + +### Sending Messages to In-Game Users ### + +You can also send private messages from IRC to in-game players, though +it's a bit tricky. + +To do it, you must send a private message to the bot (set with the + `irc.nick` [option](Settings)), in the following format: + +`@playername message` + +For example, if there's a player named `mtuser`, you can send him/her + a private message from IRC with: + +`/msg server_nick @mtuser Hello!` + +To avoid possible misunderstandings (since all in-game players use the +same IRC user to converse with you), the bot will reject any private +messages that are not in that format, and will send back a nice reminder +as a private message. + +### Bot Commands ### + +The bot also supports some basic commands, which are invoked by sending +a private message to it. + +* `!help []` -- Get a list of commands, or help about a specific + command. +* `!players` -- Get a list of players currently in game, and which are + currently "joined" to the channel. +* `!whereis ` -- Return the location of the given player.