>ROllerozxa at 21:29, 23 December 2022

2022-12-23T21:29:06Z

← Older revision	Revision as of 14:29, 23 December 2022
(No difference)

>ROllerozxa at 21:29, 23 December 2022

2022-12-23T21:29:06Z

← Older revision	Revision as of 14:29, 23 December 2022
(No difference)

>ROllerozxa at 21:29, 23 December 2022

2022-12-23T21:29:06Z

← Older revision	Revision as of 14:29, 23 December 2022
(No difference)

>ROllerozxa at 21:29, 23 December 2022

2022-12-23T21:29:06Z

New page

{{Mod Data
| name=IRC
| luaname=irc
| author=kaeza
| type=Server
| forum=[https://forum.minetest.net/viewtopic.php?f=11&t=3905 3905]
| source=[https://github.com/kaeza/minetest-irc Github]
}}
This [[Mods|mod]] lets you connect the chat between in-game and an arbitrary [[IRC]] channel via an IRC bot.

== Installation ==

=== Requirements ===

This mod can run in any Minetest version (tested on 0.4.3 up to 0.4.10).

First of all, you will need to install the <code>luasocket</code> library. For example, on Debian-based distributions:
<source lang="bash" enclose="div">
sudo apt-get install lua-socket
</source>

=== Installing using Git ===

First, the repo for the mod, then update the submodules:
<source lang="bash" enclose="div">
cd /path/to/minetest/mods
git clone https://github.com/kaeza/minetest-irc.git irc
cd irc
git submodule update --init
</source>

This will clone the LuaIRC library required for the mod.

That's it! It should be ready to go, at least for testing if it works.

=== Installing from zip archives ===

Download the main mod from [https://github.com/kaeza/minetest-irc/archive/master.zip here], and LuaIRC from [https://github.com/ShadowNinja/LuaIRC/archive/master.zip here].

Unzip <code>minetest-irc-master.zip</code> into your <code>mods/</code> directory, and rename the resulting directory to just <code>irc</code>.

Unzip <code>LuaIRC-master.zip</code> into the <code>mods/irc/</code> directory, and rename the resulting directory to just <code>irc</code> (so that you have <code>mods/irc/irc/</code>).

That's it! It should be ready to go, at least for testing if it works.

== Configuration ==

Configuration for this mod is specified via <code>[[minetest.conf]]</code>.

The following options need to be specified for the mod to run:
<source lang="text" enclose="div">
# IRC server to connect to
irc.server = your.server.name.com

# Channel to connect the bot to
irc.channel = #your-channel

# Nickname for the bot
irc.nick = YourBotName
</source>

=== Basic configuration ===

'''irc.server'''
:This is the server the bot will connect to.

'''irc.port'''
:This is the port on the server the bot will connect to. Default is 6667 (standard IRC port).

'''irc.channel'''
:This is the channel the bot will join upon connection.

'''irc.nick'''
:This specifies the nickname of the bot.

'''irc.username'''
:This specifies the username of the bot.

'''irc.realname'''
:This specifies the realname of the bot.

'''irc.NSPass'''
:Specifies the password to use to identify to NickServ. Default is empty, which means the bot will not be identified.
:How to set up an account may vary between IRC networks. Consult the documentation for your IRC network for more information.

=== Advanced configuration ===

Please refer to [https://github.com/kaeza/minetest-irc/blob/master/config.lua config.lua] in the mod's repository for all the available configuration settings.

== Usage ==

Once you set up the mod and start the game server, your bot will connect to the specified IRC server and join the channel (see ''Basic configuration'' above).

Any text you say in-game will be seen on the channel, and any text sent to the channel will be seen in-game.

=== Chat commands ===

The mod adds some chat commands that can be invoked in-game:

'''/irc_connect'''
:Requires ''irc_admin'' privilege.
:Connects again to the IRC server. Used after using <code>/irc_disconnect</code>.

'''/irc_disconnect'''
:Requires ''irc_admin'' privilege.
:Disconnects from the IRC server.

'''/irc_reconnect'''
:Requires ''irc_admin'' privilege.
:Reconnects again to the IRC server. This is effectively the same as using <code>/irc_disconnect</code> followed by using <code>/irc_connect</code>.

'''/irc_part'''
:Parts (leaves) the channel. Your messages will not be visible in the channel, and channel messages will not be visible to you.

'''/irc_join'''
:Joins the channel. Your messages will be visible in the channel, and channel messages will be visible to you. This is the default.

'''/irc_quote <line>'''
:Requires ''irc_admin'' privilege.
:Send a line to the IRC server directly. This can be used to send arbitrary commands to the IRC server.
:Example: <code>/irc_quote PRIVMSG #thechannel :Hello!</code>

'''/irc_msg <nickname> <message>'''
:Requires ''shout'' privilege.
:Send a private message to an user on IRC.
:Example: <code>/irc_msg OtherUser Hello!</code>

'''/irc_names'''
:List the people currently in the IRC channel.

In addition, it overrides the <code>/me</code> command to send the action to IRC.

=== Bot commands ===

The mod adds some bot commands that can be invoked from IRC. The commands can be invoked in two ways:
* Write the name of the bot, followed by either a comma (',') or a colon (':'), followed by a space, and then the command. Example: <code>RandomBot: uptime</code>
* Send the command directly to the bot as a private message. Example: <code>/msg RandomBot uptime</code>

If you communicate with the bot via the channel, it responds in the channel. If you communicate via PM, it responds privately.

'''help <command>'''
:Prints help about a bot command.
:Example: <code>help uptime</code>

'''list'''
:Lists the available bot commands.

'''uptime'''
:Outputs the amount of time the server has been up.

'''players'''
:Outputs the names of the players currently in game.

'''whereis <name>'''
:Outputs the location of the player named ''name''.
:Example: <code>whereis JohnDoe</code>

Other mods can register their own bot commands (see ''Application Programming Interface'' below).

== Application Programming Interface ==

There's an API for other mods to use. Please refer to [https://raw.githubusercontent.com/kaeza/minetest-irc/master/API.md API.md] in the mod distribution. (Note: the MarkDown view is currently broken).

== Add-ons ==

This is a list of add-on mods that explicitly support IRC mod API:

* [https://github.com/ShadowNinja/minetest-irc_commands irc_commands] by ShadowNinja.

== Known issues ==

=== GNU/Linux ===

Many distributions install luasocket in a place that Minetest's builtin Lua library doesn't look in. The IRC mod adds some extra search paths, but it can't support esoteric configurations. This issue is manifested by Minetest exiting with the error "<code>Failed to load and run .../irc/init.lua</code>", complaining it can't find <code>socket</code> or <code>core.so</code>.

To fix this, you have a few options:

* Use LuaJIT, which isn't bundled with Minetest and is correctly configured by the distro.
* Create a symlink at <code>/usr/local/lib/lua/5.1/socket</code> pointing to <code>/usr/i686-linux-gnu/lib/lua/5.1/socket</code>.
* Open <code>irc/init.lua</code> ('''not''' <code>irc/irc/init.lua</code>!), and add this line at the start:
:<source lang="lua" enclose="div">
ie.package.cpath = "/usr/i686-linux-gnu/lib/lua/5.1/?.so;"..ie.package.cpath
</source>
Replace "i686-linux-gnu" with your architecture if different. For example, Debian 8 requires:
:<source lang="lua" enclose="div">
ie.package.cpath = "/usr/lib/x86_64-linux-gnu/lua/5.1/?.so;"..ie.package.cpath
</source>

[[Category:Mods]]

Mods/IRC - Revision history

>ROllerozxa at 21:29, 23 December 2022

>ROllerozxa at 21:29, 23 December 2022

>ROllerozxa at 21:29, 23 December 2022

>ROllerozxa at 21:29, 23 December 2022