mirror of
https://github.com/minetest-mods/irc.git
synced 2025-02-05 03:30:16 +01:00
Created Usage (markdown)
parent
f26294b4af
commit
eeb81e646e
49
Usage.md
Normal file
49
Usage.md
Normal file
@ -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 <nick> <message>` -- 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 [<command>]` -- 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 <player>` -- Return the location of the given player.
|
Loading…
Reference in New Issue
Block a user