User:Nixeagle/UnblockBot

The bot is intended to help admins with unblock requests by providing links and being an additional resource for admins in the freenode IRC channel, #wikipedia-en-unblock.

All Users
The bot has some standard commands for use in the IRC channel:
 * !bl  - Tells you if has been blocked. If there are results, they it will show the blocks given to the user.
 * !contribs  - Gives you a link to the 's contributions.
 * !config get unblock_results - Tells you you the number of unblock requests that will show up with the use of the !bl command.
 * !config get  -- Displays in IRC the contents of a config value. This is useful for seeing who has access, and exploring the config settings.

Adding a User

 * !config set  
 * The keys are admin_hosts and developer_hosts (shouldn't use developer_hosts).
 * Note that this command is restricted to those in "admin_hosts". If you think you should have access, feel free to ask but this is a safeguard to keep untrusted folks from messing up the bot too severely.
 * Also note that this does give admins the technical capacity to mark themselves as developers by running !config set developer_hosts add . Admins should be trusted enough not to do this! The reason for the separation is to mark commands with no other use then debugging as developer only.

Other interesting config commands

 * !config save -- Saves the configuration file to disk, don't do this unless you know the changes you made are good as it may be difficult to undo. (ie you may have to wait for me to fix it by manually editing it's config file).
 * !config reload -- Loads the config file. This is a safe command, if you did something you want to undo, this loads the config file from disk and resets everything to the last prior saved state.

Access system related

 * admin_hosts - Admins are considered to be anyone permitted to edit the configuration files. Normal users will be allowed to query the bot, but won't be allowed to change any of the configuration files or settings. Admins can add or remove other admins by following the instructions listed at.
 * These values are the irc hostmask. You can see these by typing /whois, and looking for the output from nickserv: it should look like "=== nixeagle  “Wilhelm”" where the bolded portion is the part you want to add to the array for the bot.
 * developer_hosts - This is for debugging purposes only, and to restart the bot using !restart.
 * These values are the irc hostmask. You can see these by typing /whois, and looking for the output from nickserv: it should look like "=== nixeagle  “Wilhelm”" where the bolded portion is the part you want to add to the array for the bot.