-
Notifications
You must be signed in to change notification settings - Fork 0
modular IRC bot (stylized Anna^)
License
yugecin/anna
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
anna (stylized Anna^) --------------------- Modular IRC mod. Named after Anna^, from the 2006 BASSHUNTER song named Boten Anna. https://youtu.be/RYQUsp-jxDQ basics ------ java -jar anna.jar Config files can be found as properties file in the config folder in the working directory. https://docs.oracle.com/cd/E23095_01/Platform.93/ATGProgGuide/html/ s0204propertiesfileformat01.html When running for the first time, the default config file will be made (together with the config folder if necessary) and anna will exit, prompting you to change the defaults. mods ---- Modules (mods) should be placed as jar files in the same working directory, following the name mod_xxx.jar. A mod should have a class annamod.Mod that implements either net.basdon.anna.api.IMod or net.basdon.anna.api.IModLoader. For an example, check mod_test or any of the other default mods. commands -------- Default command prefix is & Most of these need owner privileges (see config file). amiowner -- tells you if you have owner permissions raw <string> -- send a raw message say <target> <string> -- send a message to a user or channel action <target> <string> -- send an action message to a user or channel die -- exit restart -- restart (does not actually restart, just reconnects) channels -- print all channels the bot is in users <channel> -- print all users in the channel stats -- check status of the stats server killstats -- kill the stats server loadmod mod_<modname> -- load a mod unloadmod mod_<modname> -- unload a mod reloadmod mod_<modname> -- reload a mod enablemod mod_<modname> -- enables a mod, meaning the mod will be loaded whenever anna starts. If the mod is not loaded now, it will be loaded. To not load the mod now but do add it to the startup, append the mod_modname to the end of the conf setting mods.enabled disablemod mod_<modname> -- analogue to enablemod modinfo mod_<modname> -- show info about a (loaded) mod conf <modname> <setting> -- view or change a configuration setting, [newvalue] use 'anna' as modname for core settings. Newvalue may can be an empty string, in that case the last character after the setting must be a single space. Changing a setting will immediately save the conf file and notice the mod that settings have been changed. The setting must already exist, use the 'confadd' command otherwise. confadd <modname> -- add a configuration setting, analogue <setting> to the 'conf' command <value> reloadconf <modname> -- reload the configuration file of a mod. Use 'anna' as modname for core config. mods -- print the list of loaded mods stats ----- Anna^ has a built-in stats/info server by means of a very primitive HTTP server running on port 7755. This can be changed in the config. configuration ------------- command.prefix -- command prefix, should be one character long (&) bot.nick -- nickname of the bot (Anna^) bot.user -- username of the bot (Anna^) bot.userinfo -- user info of the bot server.host -- server to connect to server.port -- port to connect to server.ssl.protocol -- SSL/TLS protocol to use. Omit to use an unencrypted connection. Provide a garbage value to list the available protocols. server.ssl.trustall -- Do not validate certificates when using a secure connection connection.retrytimeoutseconds -- amount of seconds to wait before reconnecting when connection drops (2) stats.enable -- if stats should be enabled (true) stats.port -- port for the stats HTTP server (7755) mods.enabled -- mods to load at boot debug.channel -- channel to send debug info to debug.print.incoming -- print incoming messages to console (false) debug.print.outgoing -- print outgoing messages to console (false) owners -- comma separated list of users that are owners (robin_be\!*@cyber.space) ownerpw -- password to become owner, send a privmsg to bot with 'identify password'. Permissions will be gone again when you and Anna don't share channels anymore. Omit to disable. messages.restart -- quit message when reconnecting messages.part -- part message when leaving a channel channels -- comma separated list of channels to join upon connecting. Anna will not part channels when they are removed from the list. --- https://web.archive.org/web/20150112230732/http://qdb.us/296934 <Indogutsu> Is that that Basshunter song? <Slime_Master> Yeah <Indogutsu> ...only in Sweden can a dance rap song about IRC hit #1 on the charts.
About
modular IRC bot (stylized Anna^)