minetest-mods/irc
1
0
Fork 1
mirror of https://github.com/minetest-mods/irc.git synced 2025-01-27 15:40:18 +01:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Calinou 2015-04-03 13:59:24 +02:00
parent 18b80bd127
commit 46903eb4eb
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -12,27 +12,31 @@ The forum topic is at http://minetest.net/forum/viewtopic.php?id=3905
Installing 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 `<Mod directory>` to fit your installation of Minetest.
For more information, see [the wiki](http://wiki.minetest.net/Installing_mods). For more information, see [the wiki](http://wiki.minetest.net/Installing_mods).
The Minetest IRC mod uses submodules, therefore you will have to run The Minetest IRC mod uses submodules, therefore you will have to run
`git submodule init` when first installing the mod, and `git submodule update` `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 every time that a submodule is updated. These steps can be combined as
`git submodule update --init`. `git submodule update --init`.
The Minetest IRC mod also requires LuaSocket. This can be installed using your The Minetest IRC mod also requires LuaSocket. This can be installed using your
package manager on many distributions, for example on Arch Linux: package manager on many distributions, for example on Arch Linux:
# pacman -S lua51-socket # pacman -S lua51-socket
Or on Debian/Ubuntu:
# apt-get install lua-socket
Settings Settings
-------- --------
All settings are changed in `minetest.conf`. If any of these settings **All settings are changed in `minetest.conf`.** If any of these settings
are not set, the default value is used. are not set, the default value is used.
* `irc.server` (string, default "irc.freenode.net") * `irc.server` (string, default "irc.freenode.net")
@ -84,8 +88,7 @@ are not set, the default value is used.
Usage Usage
----- -----
Once the game is connected to the IRC channel, chatting using the 'T' or Once the game is connected to the IRC channel, chatting from the chat dialog or the console will send the messages to the channel, and will be visible
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 by anyone. Also, when someone sends a message to the channel, that text
will be visible in-game. will be visible in-game.
@ -145,13 +148,13 @@ Forums and on the #minetest channel. In no particular order:
vortexlabs/mrtux, marveidemanis, marktraceur, jmf/john\_minetest, vortexlabs/mrtux, marveidemanis, marktraceur, jmf/john\_minetest,
sdzen/Muadtralk, VanessaE, PilzAdam, sfan5, celeron55, KikaRz, sdzen/Muadtralk, VanessaE, PilzAdam, sfan5, celeron55, KikaRz,
OldCoder, RealBadAngel, and all the people who commented in the OldCoder, RealBadAngel, and all the people who commented in the
forum topic. Thanks to you all! forum topic. **Thanks to you all!**
License License
------- -------
(C) 2012-2013 Diego Martínez <kaeza@users.sf.net> Copyright (C) 2012-2013 Diego Martínez <kaeza@users.sf.net>
See LICENSE.txt for licensing information. See LICENSE.txt for licensing information.