forked from minetest-mods/irc
Improve README
This commit is contained in:
ShadowNinja
parent
fd1a570794
commit
38832b3c55
56
README.md
56
README.md
|
|
@ -6,28 +6,31 @@ Introduction
|
|||
This mod is just a glue between IRC and Minetest. It provides two-way
|
||||
communication between the in-game chat, and an arbitrary IRC channel.
|
||||
|
||||
The forum topic is at http://minetest.net/forum/viewtopic.php?id=3905
|
||||
The forum topic is at https://forum.minetest.net/viewtopic.php?f=11&t=3905
|
||||
|
||||
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
Quick one line install for linux:
|
||||
Quick one line install for Linux:
|
||||
|
||||
cd <Mod directory> && git clone https://github.com/kaeza/minetest-irc.git irc && cd irc && git submodule update --init
|
||||
cd <Mods directory> && git clone --recursive https://github.com/kaeza/minetest-irc.git irc
|
||||
|
||||
Please change `<Mod directory>` to fit your installation of minetest.
|
||||
Please change `<Mods directory>` to fit your installation of Minetest.
|
||||
For more information, see [the wiki](http://wiki.minetest.net/Installing_mods).
|
||||
|
||||
The Minetest IRC mod uses submodules, therefore you will have to run
|
||||
`git submodule init` when first installing the mod, and `git submodule update`
|
||||
every time that a submodule is updated. These steps can be combined as
|
||||
`git submodule update --init`.
|
||||
The IRC mod's git repository uses submodules, therefore you will have to run
|
||||
`git submodule init` when first installing the mod (unless you used
|
||||
`--recursive` as above), and `git submodule update` every time that a submodule
|
||||
is updated. These steps can be combined into `git submodule update --init`.
|
||||
|
||||
The Minetest IRC mod also requires LuaSocket. This can be installed using your
|
||||
package manager on many distributions, for example on Arch Linux:
|
||||
You'll need to install LuaSocket. You can do so with your package manager on
|
||||
many distributions, for example:
|
||||
|
||||
# # On Arch Linux:
|
||||
# pacman -S lua51-socket
|
||||
# # On Debian/Ubuntu:
|
||||
# apt-get install lua-socket
|
||||
|
||||
|
||||
Settings
|
||||
|
|
@ -35,10 +38,10 @@ Settings
|
|||
All settings are changed in `minetest.conf`. If any of these settings
|
||||
are not set, the default value is used.
|
||||
|
||||
* `irc.server` (string, default "irc.freenode.net")
|
||||
This is the IRC server the mod connects to.
|
||||
* `irc.server` (string)
|
||||
The address of the IRC server to connect to.
|
||||
|
||||
* `irc.channel` (string, default "##mt-irc-mod")
|
||||
* `irc.channel` (string)
|
||||
The IRC channel to join.
|
||||
|
||||
* `irc.interval` (number, default 2.0)
|
||||
|
|
@ -46,15 +49,14 @@ are not set, the default value is used.
|
|||
least 2.0 but can be higher. After four messages this much
|
||||
time must pass between folowing messages.
|
||||
|
||||
* `irc.nick` (string, default "MT-FFFFFF")
|
||||
Nickname used as "proxy" for the in-game chat.
|
||||
'F' stands for a random base-16 number.
|
||||
* `irc.nick` (string)
|
||||
Nickname the server uses when it connects to IRC.
|
||||
|
||||
* `irc.password` (string, default "")
|
||||
* `irc.password` (string, default nil)
|
||||
Password to use when connecting to the server.
|
||||
|
||||
* `irc.NSPass` (string, default nil)
|
||||
NickServ password. Don't use this if you use SASL authentication.
|
||||
NickServ password. Don't set this if you use SASL authentication.
|
||||
|
||||
* `irc.sasl.pass` (string, default nil)
|
||||
SASL password, same as nickserv password.
|
||||
|
|
@ -62,7 +64,7 @@ are not set, the default value is used.
|
|||
if the server supports it.
|
||||
|
||||
* `irc.sasl.user` (string, default `irc.nick`)
|
||||
The SASL username. This should normaly be set to your main NickServ account name.
|
||||
The SASL username. This should normaly be set to your NickServ account name.
|
||||
|
||||
* `irc.debug` (boolean, default false)
|
||||
Whether to output debug information.
|
||||
|
|
@ -84,13 +86,11 @@ are not set, the default value is used.
|
|||
Usage
|
||||
-----
|
||||
|
||||
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.
|
||||
Once the game is connected to the IRC channel, chatting in-game will send
|
||||
messages to the channel, and will be visible by anyone. Also, messages sent
|
||||
to the channel will be visible in-game.
|
||||
|
||||
Messages that begin with `[off]` from in-game or IRC are not sent to the
|
||||
other side.
|
||||
Messages that begin with `[off]` from in-game or IRC are not sent to the other side.
|
||||
|
||||
This mod also adds a few chat commands:
|
||||
|
||||
|
|
@ -115,7 +115,7 @@ This mod also adds a few chat commands:
|
|||
|
||||
You can also send private messages from IRC to in-game players.
|
||||
|
||||
To do it, you must send a private message to the bot (set with
|
||||
To do so, you must send a private message to the bot (set with
|
||||
the `irc.nick` option above), in the following format:
|
||||
|
||||
@playername message
|
||||
|
|
@ -151,7 +151,7 @@ forum topic. Thanks to you all!
|
|||
License
|
||||
-------
|
||||
|
||||
(C) 2012-2013 Diego Martínez <kaeza@users.sf.net>
|
||||
Copyright © 2012-2013 Diego Martínez <kaeza@users.sf.net>
|
||||
|
||||
See LICENSE.txt for licensing information.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue