Sircbot

2013-12-02T23:49:43Z

Kabaka: fix spelling error

Sircbot is a simple irc bot based in lua script.

== Install sircbot ==

{{Cmd|apk add sircbot lua-sircbot}}

== Configue sircbot ==

{{Cmd| vi /etc/conf.d/sircbot}}

Change name, server and channel

sircbot_opts="-n name -s server"
sircbot_channels="#channel"

== Create sircbot scripts folders and files ==

Sircbot will use an folder for the channel where is logged in. Lets say we will use it at the "test" channel.
The folder path is: /etc/sircbot.d/#channel

== Example ==

Lets see an example:

Our bot will be named kumquat and we will join at the #test channel in the irc.ddd.ddd server.

{{Cmd| vi /etc/conf.d/sircbot}}

Change name, server and channel

sircbot_opts="-n kumquat -s irc.ddd.ddd"
sircbot_channels="#test"

Create folder bot.

{{Cmd| mkdir /etc/sircbot.d/#test -p}}

Create the lua scrip file for our bot.

{{Cmd| vi /etc/sircbot.d/#test/commands}}

#!/usr/bin/lua

-- Scripts for kumquat in Lua

args={...}

sender=args[1] -- is the nickname of running the command on IRC
message=args[2] -- is the message or command typed
channel=args[3] -- is the channel name

os.execute("sleep " .. tonumber(1))

-- This command will show: What can i do for you "nickname"?
local kumquatresult = string.find(message, "kumquat")
if kumquatresult ~= nil then
command="echo 'What can i do for you '"..sender.."'?' | sircbot-send '"..channel.."'"
io.popen(command)
end

-- This command will show: Hello there, amigo "nickname"
local kumquatresult = string.find(message, "hi")
if kumquatresult ~= nil then
command="echo 'Hello there, amigo '"..sender.."'' | sircbot-send '"..channel.."'"
io.popen(command)
end

-- This command will show the current UTC date and time
local kumquatresult = string.find(message, "date")
if kumquatresult ~= nil then
command="date -u | sircbot-send '"..channel.."'"
io.popen(command)
end

-- This command will do a search for a alpine linux package
local kumquatresult = string.find(message, "apk search:[^%d]")
if kumquatresult ~= nil then
local strng = (string.sub(message, 12))
command="apk search"..strng.." | sircbot-send '"..channel.."'"
io.popen(command)
end

-- This command will resolve a host name and ip
local kumquatresult = string.find(message, "host:[^%d]")
if kumquatresult ~= nil then
local strng = (string.sub(message, 6))
command="host "..strng.." | sircbot-send '"..channel.."'"
io.popen(command)
end

-- This command will do a 3 times ping to a server or ip address
local kumquatresult = string.find(message, "ping:[^%d]")
if kumquatresult ~= nil then
local strng = (string.sub(message, 6))
command="ping -c 3 "..strng.." | sircbot-send '"..channel.."'"
io.popen(command)
end

Make the script to be executable

{{Cmd| chmod +x /etc/sircbot.d/#test/commands}}

== Giving life to the bot ==

Starting bot service and adding to boot.

{{Cmd|/etc/init.d/sircbot start && rc-update add sircbot default}}

== Troubleshooting ==

If your bot is not responding as expected, an easy way to troubleshoot is to manually execute the script in /etc/sircbot.d/<#channelname>/<scriptname> with the three agruments.

{{Cmd|/etc/sircbot.d/<#channelname>/<scriptname> username hi '<#channelname>'}}

If your bot responds as expected, then you know that your script works. The problem is that sircbot is not executing the script. Here are two likely causes:

# Sircbot is case-sensitive when looking for the channel directory for a script to execute. For example, if you have a channel named "#Alpine", sircbot will look for /etc/sircbot.d/#Alpine/*. If that pathway isn't exactly right, then sircbot will skip that folder. In our example, if you have /etc/sircbot.d/#alpine/script, sircbot will not execute anything in that folder. To fix, simply rename the folder to /etc/sircbot.d/#Alpine/
# Sircbot doesn't execute scripts that have a '.' in the name. For example a script named 'listen.lua' will not be executed. Simply rename the script to 'listen'.

[[Category:Networking]]

Alpine Linux - User contributions [en]

Sircbot