User:Void-bot/Help

From Meta
Jump to: navigation, search

A full list of commands that Void-bot will listen to on IRC and the conditions needed for them to work. All commands can be used by Void whenever he so chooses to use them.

General commands[edit | edit source]

These commands can be used by anyone in any channel
  • $help - provides a link to this page
  • $part - makes the bot leave the current channel (this is logged, so don't think about abusing it)
  • $part <#channel> - makes the bot leave the current channel if it is equal to the channel provided (this will make more sense later) (this too is logged)

Permission specific commands[edit | edit source]

Op requirement[edit | edit source]

These commands require that the user is opped in the channel that the command is used in
  • $voice list - (requires that the current channel is being maintained by Void-bot) makes Void-bot display the current list of users who should have voice
  • $voice add <nick> - (requires that the current channel is being maintained by Void-bot) adds <nick> to the voice list. <nick> will be voiced once they join the channel
  • $voice remove <nick> - (requires that the current channel is being maintained by Void-bot) removes the nick from the voice list if it was on the list
  • $maintain-off - (requires that the current channel is being maintained by Void-bot) Void-bot will no longer maintain the current channel

Voice requirement[edit | edit source]

These commands require that the user is voiced in the channel that the command is used in
  • $log <string> - writes <string> into a file on Void's computer (Why would you use this? (Hold on, this will make sense later too))

Channel specific commands[edit | edit source]

These commands must be used in a specific channel to have an effect. They may have additional requirements

#miraheze-cvt[edit | edit source]

  • $log <string> - requires voice; writes <string> into a file on Void's computer and a page on cvtwiki

##voidwalker[edit | edit source]

The development channel where weird things can and will happen.
  • $kill - requires op; disconnects Void-bot from the IRC network
  • $nick <nick> - requires voice; changes the nick of Void|bot
  • $join <#channel> - requires voice; makes Void-bot join the specified channel
  • $part <#channel> - requires voice; makes Void-bot part from the specified channel
  • $log <string> - requires voice; writes <string> into a file on Void's computer and a page on a wiki
  • $status - Void-bot will respond by telling you if you are an op, have voice, or nothing
  • $maintain <#channel> - requires op makes Void-bot join #channel and maintain the voiced users
  • $maintain-off - requires op Void-bot will no longer maintain the channel it is currently maintaining
  • $update - requires op makes Void-bot re-fetch User:Void-bot/List

Maintain feature[edit | edit source]

Void-bot can be used to easily maintain a list of voiced users in a channel without needing to set +V flags for users with ChanServ. This feature needs to be enabled by an opped user in ##voidwalker. This feature can only be enabled on one channel at a time due to current limitations. Once the command is passed in the form of $maintain #channel, Void-bot will join #channel and fetch the current voiced users and add them to a list. You can add users to the voice list by using $voice add, or by giving the nick voice. Be aware that when using $voice add, Void-bot will not voice the user until they join the channel, even if they are present when they are added to the list. Users can only be removed from the list through the use of $voice remove. Void-bot will not remove users from this list if their voice is removed. Whenever a user joins the maintained channel, it checks their nick against the list, and if they need voice, it grants them voice by using the command MSG CHANSERV VOICE <NICK>. This means that Void-bot must have +v with ChanServ (the account is Void|bot, will fix later; recommend setting flags +v @miraheze/bots/Void). This may be subject to change later, but it's easier to do this for now.

Lockdown[edit | edit source]

This command can only be done in #miraheze by an op or trusted user. To run the command, simply enter the string $lockdown in the #miraheze channel. Void-bot will op itself, set channel mode +mz, op current ops, voice users on it's list, and finally de-op itself. It will also enable the maintain feature on the channel. The lockdown mode can be removed by the command $lockdown-off, or by setting either or both of mz off. The bot will op itself, set channel mode -mz, remove the current ops, remove the current voiced, and finally de-op itself. If the maintain feature was enabled, it will be turned off.

Void-bot list[edit | edit source]

User:Void-bot/List is a list of trusted users. New entries must always be separated by a newline, and all entries must be in order. First come the operator hostmasks prefixed with the character '%'. Then the ops, prefixed with '$'. Finally the voice list, prefixed with nothing. The '#' denotes the end of the list. Anything added after that won't be looked at. If you have an operator hostmask, you should know what you can do. Ops simply denotes nicks that will be oped when $lockdown is enabled, and the voice list should be self explanatory.