Nanobot manual - Revision history

Admin: /* Configuration */

2021-10-20T10:36:06Z

Configuration

← Older revision		Revision as of 10:36, 20 October 2021
Line 60:		Line 60:
	:'''nick''': This is bots own nickname.		:'''nick''': This is bots own nickname.
	:'''pass''': If you've registered the bot's nick with NickServ, put the password here.		:'''pass''': If you've registered the bot's nick with NickServ, put the password here.
	:'''command''': This is the character commands are prefixed with on IRC. So "@command = '\!'" means on irc you would do things like "!help" and "!version"		:'''command''': This is the character commands are prefixed with on IRC. So "@command = '!'" means on irc you would do things like "!help" and "!version"
	:'''server''': The server the bot connects to		:'''server''': The server the bot connects to
	:'''server6''': If the server's IPv6 address is different you can specify that here.		:'''server6''': If the server's IPv6 address is different you can specify that here.

Admin: /* Built in bot commands */

2021-10-20T10:35:49Z

Built in bot commands

← Older revision		Revision as of 10:35, 20 October 2021
Line 100:		Line 100:
	== Built in bot commands ==		== Built in bot commands ==
	By itself the bot only has the bare essential commands required to operate. Most of the common others are implemented in the 'core' plugin.		By itself the bot only has the bare essential commands required to operate. Most of the common others are implemented in the 'core' plugin.
	How the commands are called is defiled by the @command setting in config.rb. Here we will assume '\!' is set.		How the commands are called is defiled by the @command setting in config.rb. Here we will assume '!' is set.

	:'''!quit''' ''message'' Instruct the bot to quit. The quit message may be specified, if omitted a default one is used.		:'''!quit''' ''message'' Instruct the bot to quit. The quit message may be specified, if omitted a default one is used.
Line 109:		Line 109:
	:'''!loaded''' Show the list of currently loaded plugins.		:'''!loaded''' Show the list of currently loaded plugins.
	:'''!available''' Show the list of all plugins in the plugins directory.		:'''!available''' Show the list of all plugins in the plugins directory.


	== Command parsing order ==		== Command parsing order ==

Admin: /* Configuration */

2021-10-20T10:35:25Z

Configuration

← Older revision		Revision as of 10:35, 20 October 2021
Line 14:		Line 14:
	@version = "Nanobot 4" # Version		@version = "Nanobot 4" # Version

	@command = '\!' # Character prefix for commands ~~(escape special chars)~~		@command = '!' # Character prefix for commands

	@server = "irc.insomnia247.nl" # IPv4 address		@server = "irc.insomnia247.nl" # IPv4 address

imported>Wikiadmin: /* Command parsing order */

2014-08-22T12:41:36Z

Command parsing order

← Older revision		Revision as of 12:41, 22 August 2014
Line 114:		Line 114:
	The order of looking for looking for a command is as follows:		The order of looking for looking for a command is as follows:
	:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>		:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>
	(In reality it will first resolve aliases but ~~well~~ look at that in the '''Aliases plugin''' section later.)		(In reality it will first resolve aliases but we will look at that in the '''Aliases plugin''' section later.)


Line 126:		Line 126:
	!demo arguments		!demo arguments
	Much the same as the previous except it will find there is no function called 'arguments' in the demo plugin. It then looks for a 'main' function in the demo plugin and executes that with 'arguments' as the function arguments to 'main'.		Much the same as the previous except it will find there is no function called 'arguments' in the demo plugin. It then looks for a 'main' function in the demo plugin and executes that with 'arguments' as the function arguments to 'main'.


	== Plugins ==		== Plugins ==

imported>Wikiadmin at 12:40, 22 August 2014

2014-08-22T12:40:58Z

← Older revision		Revision as of 12:40, 22 August 2014
Line 111:		Line 111:


	=== Command parsing order ===		== Command parsing order ==
	The order of looking for looking for a command is as follows:		The order of looking for looking for a command is as follows:
	:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>		:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>
Line 128:		Line 128:


	=== Plugins ===		== Plugins ==
	Loading a plugin will give your bot the added functionality from this plugin. To call functions from a plugin you can use the following syntax:		Loading a plugin will give your bot the added functionality from this plugin. To call functions from a plugin you can use the following syntax:
	!plugin_name function_name arguments list		!plugin_name function_name arguments list

imported>Wikiadmin at 12:40, 22 August 2014

2014-08-22T12:40:31Z

← Older revision		Revision as of 12:40, 22 August 2014
Line 111:		Line 111:


	== Command parsing order ===		=== Command parsing order ===
	The order of looking for looking for a command is as follows:		The order of looking for looking for a command is as follows:
	:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>		:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>

imported>Wikiadmin at 12:40, 22 August 2014

2014-08-22T12:40:14Z

← Older revision		Revision as of 12:40, 22 August 2014
Line 110:		Line 110:
	:'''!available''' Show the list of all plugins in the plugins directory.		:'''!available''' Show the list of all plugins in the plugins directory.

	The order of looking for looking for ~~commands~~ is as follows:
			== Command parsing order ===
			The order of looking for looking for a command is as follows:
	:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>		:Internal commands => Core plugin => Other plugins function => Other plugins main<br/>
	(In reality it will first resolve aliases but well look at that in the '''Aliases plugin''' section later.)		(In reality it will first resolve aliases but well look at that in the '''Aliases plugin''' section later.)

imported>Wikiadmin at 12:38, 22 August 2014

2014-08-22T12:38:48Z

← Older revision		Revision as of 12:38, 22 August 2014
Line 1:		Line 1:
	== Environment ==		== Environment ==
	:To run the bot you need to have Ruby installed. Specific plugins may require additional gems		:To run the bot you need to have Ruby installed. Specific plugins may require additional gems
	:If you have plugins you want to load, take a directory named "plugins" in the same folder where ~~your~~ nanobot.rb resides, and place your plugin files in there.		:If you have plugins you want to load, take a look a the directory named "plugins" in the same folder where nanobot.rb resides and place your plugin files in there.

imported>Wikiadmin at 12:38, 22 August 2014

2014-08-22T12:38:12Z

← Older revision		Revision as of 12:38, 22 August 2014
Line 1:		Line 1:
	== Environment ==		== Environment ==
	:To run the bot you need to have Ruby installed. Specific plugins may ~~requires~~ additional gems		:To run the bot you need to have Ruby installed. Specific plugins may require additional gems
	:If you have plugins you want to load, take a directory named "plugins" in the same folder where your nanobot.rb resides, and place your plugin files in there.		:If you have plugins you want to load, take a directory named "plugins" in the same folder where your nanobot.rb resides, and place your plugin files in there.

imported>Wikiadmin: /* All other plugins */

2014-08-22T10:18:09Z

All other plugins

← Older revision		Revision as of 10:18, 22 August 2014
Line 164:		Line 164:

	=== All other plugins ===		=== All other plugins ===
	Since there's far too many plugins and lots of new ones are created all the time I won't be writing manuals on all of them here. If you need information about a plugin look at it's help function first of all ('''!pluginname help''' is almost always available. ) Besides that you may look at the plugin file itself. The first few lines are normally some comments that tell you want the plugin does and any other special information ~~for this plugin~~.		Since there's far too many plugins and lots of new ones are created all the time I, won't be writing manuals on all of them here. If you need information about a plugin look at it's help function first of all ('''!pluginname help''' is almost always available. ) Besides that you may look at the plugin file itself. The first few lines are normally some comments that tell you want the plugin does and any other special information that applies to it.