Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nuclearace committed Aug 16, 2014
1 parent 36d0ffe commit 0e3f6f9
Showing 1 changed file with 29 additions and 27 deletions.
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,40 +41,42 @@ Commands
--------
Require rank/permission:

- `$mute/$unmute` Mutes/Unmutes the bot. Requires mod on the channel or "M" permission.
- `$kick user [reason]` Kicks user. Requires mod or kick permission.
- `$ban user [reason]` Namebans user. Requires mod or ban permission.
- `$ipban user [reason]` IPbans user. Requires mod or ban permission.
- `$addrandom [n]` Adds n random videos from database. Requires mod on channel or "R" permission.
- `$blacklist` Blacklists currently playing video so that the bot doesn't add it randomly. Users can still add video. See $autodelete. Irreversible without going into database. Requires admin on the channel.
- `$autodelete` Makes it so non-mods cannot add currently playing video. Irreversible without going into database. Requires owner on channel.
- `$skip` Skips the current video. Requires mod on channel or "S" permission.
- `$delete username [all | n]` Deletes all or n videos added by username. Deletes the videos from the botton up. Leaving out all or n deletes the last video. Requires mod on channel or "D" permission
- `$bump -(user|title) (username| title to be matched) [all|n]` Bumps all or n videos by username, or bumps videos matching the given title. Ex: `$bump -title the dog 2` Will bump the last two videos matching `.*the dog.*`.
- `$add link` Adds link, requires mod because of potential for media limit abuse.
- `$permissions` example: `$permissions +x bob` gives permission x to bob. To take away use `$permissions -x bob`. To list permissions just do `$permissions bob`. To give or take away all permissions do `$permissions +all bob`/`$permissions -all bob`. See https://github.com/nuclearace/CytubeBot/wiki/Permissions
- `$mute/$unmute` - Mutes/Unmutes the bot. Requires mod on the channel or "M" permission.
- `$kick user [reason]` - Kicks user. Requires mod or kick permission.
- `$ban user [reason]` - Namebans user. Requires mod or ban permission.
- `$ipban user [reason]` - IPbans user. Requires mod or ban permission.
- `$addrandom [n]` - Adds n random videos from database. Requires mod on channel or "R" permission.
- `$blacklist` - Blacklists currently playing video so that the bot doesn't add it randomly. Users can still add video. See $autodelete. Irreversible without going into database. Requires admin on the channel.
- `$blacklistuser (username) (true|false)` - Makes it so this users videos are not randomly added if the bot is leading
- `$autodelete` - Makes it so non-mods cannot add currently playing video. Irreversible without going into database. Requires owner on channel.
- `$skip` - Skips the current video. Requires mod on channel or "S" permission.
- `$delete username [all | n]` - Deletes all or n videos added by username. Deletes the videos from the botton up. Leaving out all or n deletes the last video. Requires mod on channel or "D" permission
- `$bump -(user|title) (username| title to be matched) [all|n]` - Bumps all or n videos by username, or bumps videos matching the given title. Ex: `$bump -title the dog 2` - Will bump the last two videos matching `.*the dog.*`.
- `$add link [next]` - Adds link, requires mod because of potential for media limit abuse.
- `$permissions` - example: `$permissions +x bob` gives permission x to bob. To take away use `$permissions -x bob`. To list permissions just do `$permissions bob`. To give or take away all permissions do `$permissions +all bob`/`$permissions -all bob`. See https://github.com/nuclearace/CytubeBot/wiki/Permissions
- `$poll the name of the poll.option1. option 2.etc.[true]` - Opens a poll, use . to seperate options. The last option, if "true", makes it an obscured poll (votes are hidden to non-mods). Requires mod or "P" permission
- `$endpoll` - Ends a poll. Requires mod or "P" permission
- `$userlimit (true|false) | n` Limits the number of videos users can add. Mods are not exempt. Ex: `$userlimit true 5`
- `$shuffle` Shuffles the playlist. Requries mod or permission
- `$blockuser username [true|false]` Stops username from adding videos. Requires owner rank to use
- `$settime time` Sets the time on the video to time. Whereas time is in seconds. Requires mod or "T" permission.
- `$userlimit (true|false) | n` - Limits the number of videos users can add. Mods are not exempt. Ex: `$userlimit true 5`
- `$shuffle` - Shuffles the playlist. Requries mod or permission
- `$blockuser username [true|false]` - Stops username from adding videos. Requires owner rank to use
- `$settime time` - Sets the time on the video to time. Whereas time is in seconds. Requires mod or "T" permission.

Don't require rank/permission:

- `$wolfram query` Requires a [WolframAlpha API key](http://products.wolframalpha.com/api/)
- `$anagram message` Anagrams a message
- `$talk message` Cleverbot talk bot
- `$processinfo` Shows basic node process memory usage
- `$quote [username]` Fetches a quote from the user given, otherwise fetches a random quote
- `$weather (US zip code | city/town country)` Looks up current conditions. Requires [WeatherUnderground API key](http://www.wunderground.com/weather/api/)
- `$forecast (US zip code | city/town country) [tomorrow]` Looks up forecast for that day, or if tomorrow is given, the next day. [Requires WeatherUnderground API key](http://www.wunderground.com/weather/api/)
- `$status` Sends status ie. if the bot is muted
- `$choose (choice1 choice2...)` Chooses a random item from the choices given.
- `$translate [[bb] | [aa>bb] | [aa->bb]] string`
- `$wolfram query` - Requires a [WolframAlpha API key](http://products.wolframalpha.com/api/)
- `$anagram message` - Anagrams a message
- `$talk message` - Cleverbot talk bot
- `$processinfo` - Shows basic node process memory usage
- `$quote [username]` - Fetches a quote from the user given, otherwise fetches a random quote
- `$weather (US zip code | city/town country)` - Looks up current conditions. Requires [WeatherUnderground API key](http://www.wunderground.com/weather/api/)
- `$forecast (US zip code | city/town country) [tomorrow]` - Looks up forecast for that day, or if tomorrow is given, the next day. [Requires WeatherUnderground API key](http://www.wunderground.com/weather/api/)
- `$status` - Sends status ie. if the bot is muted
- `$choose (choice1 choice2...)` - Chooses a random item from the choices given.
- `$translate [[bb] | [aa>bb] | [aa->bb]] string` -
Translates the given string from aa, which defaults to detecting the language, to bb, which defaults to en, using Microsoft Translate.
The languages aa and bb must be specified as an ISO two letter language code. Requires Microsoft Translate api. See http://www.microsofttranslator.com/dev/ and http://msdn.microsoft.com/en-us/library/hh454950.aspx
- `$blockedusers` Lists the blocked users
- `$blockedusers` - Lists the blocked users
- `$blacklistedusers` - Lists the blacklisted users


Custom Commands
Expand Down

0 comments on commit 0e3f6f9

Please sign in to comment.