Sircbot - Revision history

John3-16: Added Category: IRC

2025-12-13T16:44:05Z

Added Category: IRC

← Older revision		Revision as of 16:44, 13 December 2025
Line 137:		Line 137:
	# 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'.		# 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:IRC]]
	[[Category:Networking]]		[[Category:Networking]]

Aqaqland: Add sending message with lua library

2024-03-08T02:29:15Z

Add sending message with lua library

← Older revision		Revision as of 02:29, 8 March 2024
Line 5:		Line 5:
	{{Cmd\|# apk add {{Pkg\|sircbot}} {{Pkg\|lua-sircbot}}}}		{{Cmd\|# apk add {{Pkg\|sircbot}} {{Pkg\|lua-sircbot}}}}

	== Configure sircbot ==		== Configure sircbot daemon ==

	Edit the configuration file located at {{Path\|/etc/conf.d/sircbot}} and change the name, server, and channel:		Edit the configuration file located at {{Path\|/etc/conf.d/sircbot}} and change the name, server, and channel:
Line 11:		Line 11:

	{{Cat\|/etc/conf.d/sircbot\|...		{{Cat\|/etc/conf.d/sircbot\|...
	sircbot_opts{{=}}"-n ~~name~~ -s ~~server~~"		sircbot_opts{{=}}"-n NICK -s SERVER"
	sircbot_channels{{=}}"#channel"		sircbot_channels{{=}}"#channel"
	...}}		...}}

			It is the same to run sirbot directly.

			{{Cmd\|$ sircbot -s SERVER -n NICK '#channel'}}

			Sircbot would act as "daemon" joining server and channels thus do the following response.

			== Sending messages ==

			There are two ways to send messages, channel need be specified first in sirbot daemon.

			=== sircbot-send ===

			{{Cmd\|<nowiki>$ echo "$MESSAGE" \| sircbot-send '#channel'</nowiki>}}

			=== sircbot lua library ===

			{{Cat\|lua_script\|<nowiki>local sircbot = require('sircbot')
			local client = sircbot.connect('#channel')

			client:send("hello")</nowiki>}}

	== Create sircbot scripts folders and files ==		== 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.~~		Sircbot will use an folder for the channel where is logged in. The folder path is: {{Path\|/etc/sircbot.d/#channel}}
	The folder path is: {{Path\|/etc/sircbot.d/#<channel>}}
			For every message that goes to the channel, sircbot will run all scripts in /etc/sircbot.d/#channel/ with sender, message and channel name as arguments.[https://git-old.alpinelinux.org/hosted/sircbot/about/]

	== Example ==		== Example ==
Line 100:		Line 122:
	== Giving life to the bot ==		== Giving life to the bot ==

	Starting ~~bot service~~ and adding to boot.		Starting sircbot daemon and adding service to boot.

	{{Cmd\|# rc-service sircbot start && rc-update add sircbot default}}		{{Cmd\|# rc-service sircbot start && rc-update add sircbot default}}

Aqaqland: /* Create sircbot scripts folders and files */

2024-03-07T12:36:52Z

Create sircbot scripts folders and files

← Older revision		Revision as of 12:36, 7 March 2024
Line 18:		Line 18:

	Sircbot will use an folder for the channel where is logged in. Lets say we will use it at the "test" channel.		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: {{Path\|/etc/sircbot.d/#channel}}		The folder path is: {{Path\|/etc/sircbot.d/#<channel>}}

	== Example ==		== Example ==

Bbbhltz: style and formatting

2023-06-01T11:44:11Z

style and formatting

Show changes

Kabaka: fix spelling error

2013-12-02T23:49:43Z

fix spelling error

← Older revision		Revision as of 23:49, 2 December 2013
Line 115:		Line 115:
	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:		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-~~sensetive~~ 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 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'.		# 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]]		[[Category:Networking]]

Fab: category added

2012-05-21T15:21:43Z

category added

← Older revision		Revision as of 15:21, 21 May 2012
Line 117:		Line 117:
	# Sircbot is case-sensetive 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 is case-sensetive 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'.		# 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]]

Wmjohnso: fixed the numbered list in the Troubleshooting Section

2012-04-20T15:31:32Z

fixed the numbered list in the Troubleshooting Section

← Older revision		Revision as of 15:31, 20 April 2012
Line 116:		Line 116:

	# Sircbot is case-sensetive 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 is case-sensetive 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'.
	## 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'.

Wmjohnso: Added the Troubleshooting section. - wmjohnso

2012-04-20T11:06:56Z

Added the Troubleshooting section. - wmjohnso

← Older revision		Revision as of 11:06, 20 April 2012
Line 106:		Line 106:

	{{Cmd\|/etc/init.d/sircbot start && rc-update add sircbot default}}		{{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-sensetive 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'.

Radelphe: /* Example */

2012-04-20T10:08:03Z

Example

← Older revision		Revision as of 10:08, 20 April 2012
Line 96:		Line 96:
	io.popen(command)		io.popen(command)
	end		end

			Make the script to be executable

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

	== Giving life to the bot ==		== Giving life to the bot ==

Radelphe: /* Example */

2012-04-20T09:55:20Z

Example

← Older revision		Revision as of 09:55, 20 April 2012
Line 38:		Line 38:
	Create the lua scrip file for our bot.		Create the lua scrip file for our bot.

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

	#!/usr/bin/lua		#!/usr/bin/lua
Line 55:		Line 55:
	local kumquatresult = string.find(message, "kumquat")		local kumquatresult = string.find(message, "kumquat")
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	command="echo 'What can i do for you '"..sender.."'?' \| sircbot-send '~~#hed~~'"		command="echo 'What can i do for you '"..sender.."'?' \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end
Line 62:		Line 62:
	local kumquatresult = string.find(message, "hi")		local kumquatresult = string.find(message, "hi")
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	command="echo 'Hello there, amigo '"..sender.."'' \| sircbot-send '~~#hed~~'"		command="echo 'Hello there, amigo '"..sender.."'' \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end
Line 69:		Line 69:
	local kumquatresult = string.find(message, "date")		local kumquatresult = string.find(message, "date")
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	command="date -u \| sircbot-send '~~#hed~~'"		command="date -u \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end
Line 77:		Line 77:
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	local strng = (string.sub(message, 12))		local strng = (string.sub(message, 12))
	command="apk search"..strng.." \| sircbot-send '~~#hed~~'"		command="apk search"..strng.." \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end
Line 85:		Line 85:
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	local strng = (string.sub(message, 6))		local strng = (string.sub(message, 6))
	command="host "..strng.." \| sircbot-send '~~#hed~~'"		command="host "..strng.." \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end
Line 93:		Line 93:
	if kumquatresult ~= nil then		if kumquatresult ~= nil then
	local strng = (string.sub(message, 6))		local strng = (string.sub(message, 6))
	command="ping -c 3 "..strng.." \| sircbot-send '~~#hed~~'"		command="ping -c 3 "..strng.." \| sircbot-send '"..channel.."'"
	io.popen(command)		io.popen(command)
	end		end