|
| 1 | +IRC Mod for Minetest |
| 2 | +==================== |
| 3 | + |
| 4 | +Introduction |
| 5 | +------------ |
| 6 | +This mod is just a glue between IRC and Minetest. It provides two-way |
| 7 | + communication between the in-game chat, and an arbitrary IRC channel. |
| 8 | + |
| 9 | +The forum topic is at http://minetest.net/forum/viewtopic.php?id=3905 |
| 10 | + |
| 11 | + |
| 12 | +Installing |
| 13 | +---------- |
| 14 | + |
| 15 | +Quick one line install for linux: |
| 16 | + |
| 17 | + cd <Mod directory> && git clone https://github.com/kaeza/minetest-irc.git irc && cd irc && git submodule update --init |
| 18 | + |
| 19 | +Please change `<Mod directory>` to fit your installation of minetest. |
| 20 | +For more information, see [the wiki](http://wiki.minetest.net/Installing_mods). |
| 21 | + |
| 22 | +The Minetest IRC mod uses submodules, therefore you will have to run |
| 23 | +`git submodule init` when first installing the mod, and `git submodule update` |
| 24 | +every time that a submodule is updated. These steps can be combined as |
| 25 | +`git submodule update --init`. |
| 26 | + |
| 27 | +The Minetest IRC mod also requires LuaSocket. This can be installed using your |
| 28 | +package manager on many distributions, for example on Arch Linux: |
| 29 | + |
| 30 | + # pacman -S lua51-socket |
| 31 | + |
| 32 | + |
| 33 | +Settings |
| 34 | +-------- |
| 35 | +All settings are changed in `minetest.conf`. If any of these settings |
| 36 | +are not set, the default value is used. |
| 37 | + |
| 38 | + * `irc.server` (string, default "irc.freenode.net") |
| 39 | + This is the IRC server the mod connects to. |
| 40 | + |
| 41 | + * `irc.channel` (string, default "##mt-irc-mod") |
| 42 | + The IRC channel to join. |
| 43 | + |
| 44 | + * `irc.interval` (number, default 2.0) |
| 45 | + This prevents the server from flooding. It should be at |
| 46 | + least 2.0 but can be higher. After four messages this much |
| 47 | + time must pass between folowing messages. |
| 48 | + |
| 49 | + * `irc.nick` (string, default "MT-FFFFFF") |
| 50 | + Nickname used as "proxy" for the in-game chat. |
| 51 | + 'F' stands for a random base-16 number. |
| 52 | + |
| 53 | + * `irc.password` (string, default "") |
| 54 | + Password to use when connecting to the server. |
| 55 | + |
| 56 | + * `irc.NSPass` (string, default nil) |
| 57 | + NickServ password. Don't use this if you use SASL authentication. |
| 58 | + |
| 59 | + * `irc.SASLPass` (string, default nil) |
| 60 | + SASL password, same as nickserv password. |
| 61 | + You should use this instead of NickServ authentication |
| 62 | + if the server supports it. |
| 63 | + |
| 64 | + * `irc.SASLUser` (string, default irc.nick) |
| 65 | + The SASL username. This should normaly be set to your main NickServ account name. |
| 66 | + |
| 67 | + * `irc.debug` (boolean, default false) |
| 68 | + Whether to output debug information. |
| 69 | + |
| 70 | + * `irc.disable_auto_connect` (boolean, default false) |
| 71 | + If false, the bot is connected by default. If true, a player with |
| 72 | + the 'irc_admin' privilege has to use the /irc_connect command to |
| 73 | + connect to the server. |
| 74 | + |
| 75 | + * `irc.disable_auto_join` (boolean, default false) |
| 76 | + If false, players join the channel automatically upon entering the |
| 77 | + game. If true, each user must manually use the /join command to |
| 78 | + join the channel. In any case, the players may use the /part |
| 79 | + command to opt-out of being in the channel. |
| 80 | + |
| 81 | + * `irc.send_join_part` (boolean, default true) |
| 82 | + Determines whether to send player join and part messages to the channel. |
| 83 | + |
| 84 | +Usage |
| 85 | +----- |
| 86 | + |
| 87 | +Once the game is connected to the IRC channel, chatting using the 'T' or |
| 88 | +F10 hotkeys will send the messages to the channel, and will be visible |
| 89 | +by anyone. Also, when someone sends a message to the channel, that text |
| 90 | +will be visible in-game. |
| 91 | + |
| 92 | +Messages that begin with `[off]` from in-game or IRC are not sent to the |
| 93 | +other side. |
| 94 | + |
| 95 | +This mod also adds a few chat commands: |
| 96 | + |
| 97 | + * `/irc_msg <nick> <message>` |
| 98 | + Sends a private message to a IRC user. |
| 99 | + |
| 100 | + * `/join` |
| 101 | + Join the IRC chat. |
| 102 | + |
| 103 | + * `/part` |
| 104 | + Part the IRC chat. |
| 105 | + |
| 106 | + * `/irc_connect` |
| 107 | + Connect the bot manually to the IRC network. |
| 108 | + |
| 109 | + * `/irc_disconnect` |
| 110 | + Disconnect the bot manually from the IRC network (this does not |
| 111 | + shutdown the game). |
| 112 | + |
| 113 | + * `/irc_reconnect` |
| 114 | + Equivilant to `/irc_disconnect` followed by `/irc_connect`. |
| 115 | + |
| 116 | +You can also send private messages from IRC to in-game players. |
| 117 | + |
| 118 | +To do it, you must send a private message to the bot (set with |
| 119 | +the `irc.nick` option above), in the following format: |
| 120 | + |
| 121 | + @playername message |
| 122 | + |
| 123 | +For example, if there's a player named `mtuser`, you can send him/her |
| 124 | +a private message from IRC with: |
| 125 | + |
| 126 | + /msg server_nick @mtuser Hello! |
| 127 | + |
| 128 | +To avoid possible misunderstandings (since all in-game players use the |
| 129 | +same IRC user to converse with you), the "proxy" user will reject any |
| 130 | +private messages that are not in that format, and will send back a |
| 131 | +nice reminder as a private message. |
| 132 | + |
| 133 | +The bot also supports some basic commands, which are invoked by sending |
| 134 | +a private message to it. Use `!list` to get a list of commands, and |
| 135 | +`!help <command>` to get help about a specific command. |
| 136 | + |
| 137 | + |
| 138 | +Thanks |
| 139 | +------ |
| 140 | + |
| 141 | +I'd like to thank the users who supported this mod both on the Minetest |
| 142 | +Forums and on the #minetest channel. In no particular order: |
| 143 | + |
| 144 | +0gb.us, ShadowNinja, Shaun/kizeren, RAPHAEL, DARGON, Calinou, Exio, |
| 145 | +vortexlabs/mrtux, marveidemanis, marktraceur, jmf/john\_minetest, |
| 146 | +sdzen/Muadtralk, VanessaE, PilzAdam, sfan5, celeron55, KikaRz, |
| 147 | +OldCoder, RealBadAngel, and all the people who commented in the |
| 148 | +forum topic. Thanks to you all! |
| 149 | + |
| 150 | + |
| 151 | +License |
| 152 | +------- |
| 153 | + |
| 154 | +(C) 2012-2013 Diego Martínez <kaeza@users.sf.net> |
| 155 | + |
| 156 | +See LICENSE.txt for licensing information. |
| 157 | + |
| 158 | +The files in the irc directory are part of the LuaIRC project. |
| 159 | +See irc/LICENSE.txt for licensing information. |
| 160 | + |
0 commit comments