Aqu4bot - Revision history

Subsentient at 21:08, 20 March 2016

2016-03-20T21:08:40Z

← Older revision		Revision as of 21:08, 20 March 2016
Line 1:		Line 1:
	[[File:Aqu4bot.png\|frameless\|center\|Logo for aqu4bot.]]		[[File:Aqu4bot.png\|frameless\|center\|Logo for aqu4bot.]]

	aqu4bot, the main instance in IRC as aqu4, with the slogan "aqu4, daughter of pr0t0!" is an IRC bot written in C by [[User:Subsentient\|Subsentient]]. She has a wide range of functionality, many of her commands being humorous and others being obscure. She has channel management capabilities, user tracking and messaging capabilities, and an extensive logging system.		aqu4bot, the main instance in IRC as aqu4, with the slogan "aqu4, daughter of pr0t0!" is an IRC bot originally written in C and later ported to C++ by [[User:Subsentient\|Subsentient]]. She has a wide range of functionality, many of her commands being humorous and others being obscure. She has channel management capabilities, user tracking and messaging capabilities, and an extensive logging system.

	== Basic usage ==		== Basic usage ==
Line 36:		Line 36:
	Depending on the sophistication of your new command, editing irc.c's IRC_Loop may be necessary, and depending on the sophistication, you may wish to add a new source file. You'll need to edit src/Makefile to add it to the build process. Remember to edit the help list at the top of commands.c.		Depending on the sophistication of your new command, editing irc.c's IRC_Loop may be necessary, and depending on the sophistication, you may wish to add a new source file. You'll need to edit src/Makefile to add it to the build process. Remember to edit the help list at the top of commands.c.

	aqu4bot is written in C99~~. Until recent revisions~~, ~~aqu4bot was exclusively C89 aka ANSI~~ C. ~~Most~~ code ~~still conforms to C89, but~~ as aqu4bot~~'s use of C99 language features expands~~, ~~so will~~ the ~~incompatibilities with C89~~.		aqu4bot was originally written in C89, later updated to compile as C99, and finally ported to C++ on 2016-03-20. You can write code as C with aqu4bot, provided you are willing to deal with the C++ features that are present.

	=== SubStrings ===		=== SubStrings ===

Subsentient: /* SubStrings */

2015-10-31T02:47:36Z

SubStrings

← Older revision		Revision as of 02:47, 31 October 2015
Line 39:		Line 39:

	=== SubStrings ===		=== SubStrings ===
	Aqu4bot uses a small string handling library called [https://~~github~~.~~com/Subsentient~~/substrings SubStrings] that is also written by Subsentient. It is by default included in aqu4bot's source tree and is compiled along with 'make'. It is platform independent. SubStrings is used		Aqu4bot uses a small string handling library called [https://universe2.us/substrings.html SubStrings] that is also written by Subsentient. It is by default included in aqu4bot's source tree and is compiled along with 'make'. It is platform independent. SubStrings is used
	to simplify the large amount of text processing done by aqu4bot, which can be a more lengthy task in C.		to simplify the large amount of text processing done by aqu4bot, which can be a more lengthy task in C. It provides safe string copy and concatenation, string searching, line and character stepping/iteration, and much more.

	=== libcurl ===		=== libcurl ===

Subsentient at 21:33, 6 February 2015

2015-02-06T21:33:58Z

← Older revision		Revision as of 21:33, 6 February 2015
Line 37:		Line 37:

	aqu4bot is written in C99. Until recent revisions, aqu4bot was exclusively C89 aka ANSI C. Most code still conforms to C89, but as aqu4bot's use of C99 language features expands, so will the incompatibilities with C89.		aqu4bot is written in C99. Until recent revisions, aqu4bot was exclusively C89 aka ANSI C. Most code still conforms to C89, but as aqu4bot's use of C99 language features expands, so will the incompatibilities with C89.

			=== SubStrings ===
			Aqu4bot uses a small string handling library called [https://github.com/Subsentient/substrings SubStrings] that is also written by Subsentient. It is by default included in aqu4bot's source tree and is compiled along with 'make'. It is platform independent. SubStrings is used
			to simplify the large amount of text processing done by aqu4bot, which can be a more lengthy task in C.

	=== libcurl ===		=== libcurl ===

Subsentient at 21:28, 6 February 2015

2015-02-06T21:28:21Z

← Older revision		Revision as of 21:28, 6 February 2015
Line 29:		Line 29:

	== Developing new commands ==		== Developing new commands ==
	As aqu4bot is written in ~~C89~~ and compiled into native executables, it does not support modules. Expanded features must be added by editing the existing source code. Thankfully this is less of a problem than you think, since you can simply type 'make' on UNIX systems to recompile, which takes less than 10 seconds on all but the slowest machines.		As aqu4bot is written in C99 and compiled into native executables, it does not support modules. Expanded features must be added by editing the existing source code. Thankfully this is less of a problem than you think, since you can simply type 'make' on UNIX systems to recompile, which takes less than 10 seconds on all but the slowest machines.

	=== Adding commands ===		=== Adding commands ===

Subsentient: aqu4bot uses C99 now, so update wiki to match.

2014-12-18T11:06:08Z

aqu4bot uses C99 now, so update wiki to match.

← Older revision		Revision as of 11:06, 18 December 2014
Line 36:		Line 36:
	Depending on the sophistication of your new command, editing irc.c's IRC_Loop may be necessary, and depending on the sophistication, you may wish to add a new source file. You'll need to edit src/Makefile to add it to the build process. Remember to edit the help list at the top of commands.c.		Depending on the sophistication of your new command, editing irc.c's IRC_Loop may be necessary, and depending on the sophistication, you may wish to add a new source file. You'll need to edit src/Makefile to add it to the build process. Remember to edit the help list at the top of commands.c.

	aqu4bot is written in ~~mostly-~~ANSI C ~~(mostly~~ C89~~). snprintf() and stdint.h are among the few C99 facilities we use~~, but ~~we do NOT~~ use ~~any~~ C99 language features, ~~just headers and functions, and only the ones that are almost always going to exist such as snprintf(). Using C99 code~~ will ~~result in a warning from~~ the ~~compiler~~.		aqu4bot is written in C99. Until recent revisions, aqu4bot was exclusively C89 aka ANSI C. Most code still conforms to C89, but as aqu4bot's use of C99 language features expands, so will the incompatibilities with C89.

	=== libcurl ===		=== libcurl ===

Subsentient: /* Logging */

2014-09-08T09:05:15Z

Logging

← Older revision		Revision as of 09:05, 8 September 2014
Line 26:		Line 26:
	== Logging ==		== Logging ==
	aqu4bot has an extensive and capable logging system, with the logs for the 'aqu4' instance being stored at http://universe2.us/irclogz		aqu4bot has an extensive and capable logging system, with the logs for the 'aqu4' instance being stored at http://universe2.us/irclogz
	You will need to request a password from the bot maintainer, [[User:Subsentient\|Subsentient]] to get access to the logs.		You will need to request a password from the bot maintainer, [[User:Subsentient\|Subsentient]], to get access to the logs.

	== Developing new commands ==		== Developing new commands ==

Subsentient: /* Basic usage */

2014-09-08T09:04:48Z

Basic usage

← Older revision		Revision as of 09:04, 8 September 2014
Line 5:		Line 5:
	== Basic usage ==		== Basic usage ==
	aqu4bot can be set to respond to any prefix on a per-channel basis, but by default		aqu4bot can be set to respond to any prefix on a per-channel basis, but by default
	she responds to the dollar sign $, but will always respond to her name presented as aqu4:, followed by a space, to produce 'aqu4: commands'.		she responds to the dollar sign $, but will always respond to her name presented as e.g. aqu4:, followed by a space, to produce 'aqu4: commands'.
	~~She~~ will not say anything if you specify an invalid command. Help is available with the 'help' command,		An aqu4bot will not say anything if you specify an invalid command. Help is available with the 'help' command,
	of course accessible via $help or ~~aqu4~~: help. No prefix is required in private messages, so /msg ~~aqu4~~ help will		of course accessible via $help or 'BotNameHere: help'. No prefix is required in private messages, so /msg BotNameHere help will
	indeed get you the help command. Likewise, the 'commands' command gives a list of available commands for the bot, but 'help'		indeed get you the help command. Likewise, the 'commands' command gives a list of available commands for the bot, but 'help'
	would have told you that.		would have told you that.

Subsentient at 08:54, 8 September 2014

2014-09-08T08:54:43Z

← Older revision		Revision as of 08:54, 8 September 2014
Line 13:		Line 13:
	== Source code ==		== Source code ==
	aqu4bot's source code is available at https://github.com/Subsentient/aqu4bot		aqu4bot's source code is available at https://github.com/Subsentient/aqu4bot

			== Bugs ==
			Please report all bugs to [[User:Subsentient\|Subsentient]]. Chat logs are helpful if they can be provided.
			Please provide the channel you were in, and any nicknames of users who encountered the bug, as well as any channels
			where the bug occurs. Case sensitivity bugs are common with aqu4bot for some reason, so please provide the correct
			case for nicks and channels.

	== Availability ==		== Availability ==

Subsentient: /* Logging */

2014-09-08T08:51:49Z

Logging

← Older revision		Revision as of 08:51, 8 September 2014
Line 19:		Line 19:

	== Logging ==		== Logging ==
	aqu4bot has an extensive and capable logging system, with the logs being stored at http://universe2.us/irclogz		aqu4bot has an extensive and capable logging system, with the logs for the 'aqu4' instance being stored at http://universe2.us/irclogz
	You will need to request a password from the bot maintainer, [[User:Subsentient\|Subsentient]] to get access to the logs.		You will need to request a password from the bot maintainer, [[User:Subsentient\|Subsentient]] to get access to the logs.

Subsentient: /* Blacklisting */

2014-09-08T08:51:06Z

Blacklisting

← Older revision		Revision as of 08:51, 8 September 2014
Line 58:		Line 58:
	To blackist someone, use 'blackist set'.		To blackist someone, use 'blackist set'.
	To unblacklist someone, use 'blacklist unset'.		To unblacklist someone, use 'blacklist unset'.
	It is not possible to blacklist an admin or owner		It is not possible to blacklist an admin or owner.

	=== Syntax ===		=== Syntax ===