User:DeadBot/irc

The DeadBot IRC Bot is a system allowing anyone to run DeadBot on a pre-approved task. At the moment, only dep pages and some minor other commands are allowed. It uses the registered nick "WikipediaDeadBot".

It is currently run in #deadbot on irc.freenode.net.

= Permissions = Commands/tasks are grouped into several permission levels, which are defined below. If you are a member of a higher group, you are automatically included in the below groups. Therefore, members of the Mod group are also in the Aproved group.

Approved
This is a group of people who are approved to use hte more advanced/potentially damaging commands, such as messaging and joining/parting commands. It also allows access to the slower and more CPU intensive bot tasks, such as the DEP task.

Requirements

 * Edits: 500
 * Groups: None
 * Misc: Nothing

Mod
This is a group of people who have some extra abilities, such as the ability to list the queue, and remove selected items.

Requirements

 * Edits: 1000
 * Groups: none
 * Misc: No entries in block log that weren't accidental or easily explainable

Admin
This group is basically for sysops, the extra powers invlove shutting down the bot as well as some debug messages.

Requirements

 * Edits: 1000
 * Groups: sysop
 * Misc: Any member of BAG can also get this permission level. I will also give this to other non-sysops, at my discretion, but I will be rather strict.

Owner
This group is mainly for me, and anyone else who helps with programming. I will also give it to some other higher-level users.

Requirements

 * Edits: 1
 * Groups: bureaucrat, developer, oversight, checkuser, steward
 * Misc: You can be in any one of the above groups, you don't have to be in all. This is also available to ArbCom.

Addtask
To make the bot do something, type !addtask TASKNAME TASKPARAMS. Taskname is the name of the task, and taskparams can be any number of parameters, seperated by spaces, that depend on the specific task.

dep
!addtask dep A-C This task takes one parameter, the name of the DEP subpage that it will run on.

Permission level required: Approved

uaa
!addtask uaa This task will scan the newusers log and reports username violations it finds.

Permission level required: None

msg
!addtask msg This_is_a_message This task takes one parameter, the message to send to the #deadbot channel. Replace all spaces in the message with underscores.

Permission level required: Approved

chanmsg
!addtask chanmsg #wikipedia-en Message_here This is the same as above, however with two parameters, the first of which is the channel name. The bot will join the channel, say the text, then part the channel.

Permission level required: Approved

join
!addtask join #my-deadbot-channel This will make the bot join the specified channel. The bot will still output normal messages to #deadbot, however it will listen to requests from this channel, and answer status requests.

Permission level required: Approved

part
!addtask part #my-deadbot-channel This is the same as above, however it parts the channel.

Permission level required: Approved (to part the #deadbot channel, you need to be Admin)

msgall
!addtask msgall Task_complete This is the same as msg, however it will send the message to all channels it is in. Useful for important task complete notices.

Permission level required: Mod

Status
!status This will output the bots version number and the number of jobs in the queue.

Permission level required: None

quit
!quit Causes the bot to disconnect from IRC, and completely exit upon completion of the queue.

Permission level required: Admin

quit NOW
!quit NOW Causes the bot to immediately quit, stopping all tasks. This is used as an emergency stop mechanism.

Permission level required: Admin

listqueue
!listqueue Causes the bot to list all the items in the queue, and who added them, as well as their ID for remqueue

Permission level required: Mod

remqueue
!remqueue 3 Removed the item from the queue with the ID of the first parameter. If a task is started or completed between when you check the ID and post this message, you will remove the wrong one, so list the queue again!

Permission level required: Mod

clearqueue
!clearqueue Removes all items from the queue. The current task will still complete.

Permission level required: Admin

Alerts
Alerts are notices that users can subscribe to, and the bot will message them when certain things happen.

listalerts
!listalerts This will list all current available alerts

Permission level required: None

myalerts
!myalerts Lists the alerts you are currently subscribed to.

Permission level required: None

alerton
!alerton rcnamewatcher Subscribes you to the alert specified in the first parameter

Permission level required: None

alertoff
!alertoff rcnamewatcher Sams as above, but unsubscribes

Permission level required: None

Page Watching
These are for watching pages, that will make the bot notify the users watching it and #deadbot channel if it is edited.

watchpage
!watchpage Wikipedia:Sandbox Add's you to the pages watchlist

Permission level required: None

unwatchpage
!unwatchpage Wikipedia:Sandbox Removes you from the pages watchlist

Permission level required: None

load
!load User:TheFearow/DeadBotAuto Executes the contents of the specified wiki file as commands. Lines starting with # are treated as comments. The file must have "#DeadBot-AutoLoadScriptAllow" wihtout the quotes as the first line.