diff --git a/README.md b/README.md index 0b954a06..096e0174 100644 --- a/README.md +++ b/README.md @@ -52,24 +52,24 @@ Enjoy Official repo: **github.com/Kwoth/NadekoBot/** ### Administration -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- -`-h` [-help ] [@BotName help ] [@BotName h ] | Help command +`-h`, `-help`, `@BotName help`, `@BotName h` | Help command `-hgit` | Help command stylized for github readme -`.sr` [.setrole ] | Sets a role for a given user. | .sr @User Guest -`.rr` [.removerole ] | Removes a role from a given user. | .rr @User Admin -`.r` [.role ] [.cr ] | Creates a role with a given name, and color. | .r AwesomeRole Orange -`.b` [.ban ] | Bans a mentioned user -`.ub` [.unban ] | Unbans a mentioned user -`.k` [.kick ] | Kicks a mentioned user. +`.sr`, `.setrole` | Sets a role for a given user. | .sr @User Guest +`.rr`, `.removerole` | Removes a role from a given user. | .rr @User Admin +`.r`, `.role`, `.cr` | Creates a role with a given name, and color. | .r AwesomeRole Orange +`.b`, `.ban` | Bans a mentioned user +`.ub`, `.unban` | Unbans a mentioned user +`.k`, `.kick` | Kicks a mentioned user. `.rvch` | Removes a voice channel with a given name. -`.vch` [.cvch ] | Creates a new voice channel with a given name. -`.rch` [.rtch ] | Removes a text channel with a given name. -`.ch` [.tch ] | Creates a new text channel with a given name. -`.st` [.settopic ] | Sets a topic on the current channel. -`.uid` [.userid ] | Shows user id -`.cid` [.channelid ] | Shows current channel id -`.sid` [.serverid ] | Shows current server id +`.vch`, `.cvch` | Creates a new voice channel with a given name. +`.rch`, `.rtch` | Removes a text channel with a given name. +`.ch`, `.tch` | Creates a new text channel with a given name. +`.st`, `.settopic` | Sets a topic on the current channel. +`.uid`, `.userid` | Shows user id +`.cid`, `.channelid` | Shows current channel id +`.sid`, `.serverid` | Shows current server id `.stats` | Shows some basic stats for nadeko `.leaveall` | Nadeko leaves all servers `.prune` | Prunes a number of messages from the current channel. | .prune 50 @@ -82,12 +82,12 @@ Command [alias] | Description | Usage `.byemsg` | Sets a new announce leave message. Type %user% if you want to mention the new member. | .byemsg %user% has left the server. ### Conversations -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- `\o\` | Nadeko replies with /o/ `/o/` | Nadeko replies with \o\ -`@BotName copyme` [@BotName cm ] | Nadeko starts copying everything you say. Disable with cs -`@BotName cs` [@BotName copystop ] | Nadeko stops copying you +`@BotName copyme`, `@BotName cm` | Nadeko starts copying everything you say. Disable with cs +`@BotName cs`, `@BotName copystop` | Nadeko stops copying you `@BotName uptime` | Shows how long is Nadeko running for. `@BotName die` | Works only for the owner. Shuts the bot down. `@BotName randserver` | Generates an invite to a random server and prints some stats. @@ -96,17 +96,17 @@ Command [alias] | Description | Usage `@BotName insult` | Only works for owner. Insults @X person. | @NadekoBot insult @X. `@BotName praise` | Only works for owner. Praises @X person. | @NadekoBot praise @X. `@BotName are you real` | Useless. -`@BotName are you there` [@BotName ! ] [@BotName ? ] | Checks if nadeko is operational. +`@BotName are you there`, `@BotName !`, `@BotName ?` | Checks if nadeko is operational. `@BotName draw` | Nadeko instructs you to type $draw. Gambling functions start with $ `@BotName fire` | Shows a unicode fire message. Optional parameter [x] tells her how many times to repeat the fire. | @NadekoBot fire [x] `@BotName rip` | Shows a grave image.Optional parameter [@X] instructs her to put X's name on the grave. | @NadekoBot rip [@X] `@BotName j` | Joins a server using a code. -`@BotName save` [@BotName ,s ] [@BotName -s ] | Saves something for the owner in a file. +`@BotName save`, `@BotName ,s`, `@BotName -s` | Saves something for the owner in a file. `@BotName ls` | Shows all saved items. `@BotName slm` | Shows the message where you were last mentioned in this channel (checks last 10k messages) `@BotName cs` | Deletes all saves `@BotName bb` | Says bye to someone. | @NadekoBot bb @X -`@BotName req` [@BotName ,request ] [@BotName -request ] | Requests a feature for nadeko. | @NadekoBot req new_feature +`@BotName req`, `@BotName ,request`, `@BotName -request` | Requests a feature for nadeko. | @NadekoBot req new_feature `@BotName lr` | PMs the user all current nadeko requests. `@BotName dr` | Deletes a request. Only owner is able to do this. `@BotName rr` | Resolves a request. Only owner is able to do this. @@ -114,38 +114,38 @@ Command [alias] | Description | Usage `@BotName hide` | Hides nadeko in plain sight!11!! `@BotName unhide` | Unhides nadeko in plain sight!1!!1 `@BotName dump` | Dumps all of the invites it can to dump.txt -`@BotName av` [@BotName avatar ] | Shows a mentioned person's avatar. | ~av @X +`@BotName av`, `@BotName avatar` | Shows a mentioned person's avatar. | ~av @X ### Gambling -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- `$draw` | Draws a card from the deck.If you supply number [x], she draws up to 5 cards from the deck. | $draw [x] `$flip` | Flips a coin, heads or tails, and shows an image of it. `$roll` | Rolls 2 dice from 0-10. If you supply a number [x] it rolls up to 30 normal dice. | $roll [x] ### Games -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- -`t` [-t ] | Starts a game of trivia. -`tl` [-tl ] [tlb ] [-tlb ] | Shows a current trivia leaderboard. -`tq` [-tq ] | Quits current trivia after current question. +`t`, `-t` | Starts a game of trivia. +`tl`, `-tl`, `tlb`, `-tlb` | Shows a current trivia leaderboard. +`tq`, `-tq` | Quits current trivia after current question. `>` | Attack a person. Supported attacks: 'splash', 'strike', 'burn', 'surge'. | > strike @User `poketype` | Gets the users element type. Use this to do more damage with strike ### Music -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- -`!m n` [!m next ] | Goes to the next song in the queue. -`!m s` [!m stop ] | Completely stops the music and unbinds the bot from the channel and cleanes up files. -`!m p` [!m pause ] | Pauses the song -`!m q` [!m yq ] | Queue a song using a multi/single word name. | `!m q Dream Of Venice` -`!m lq` [!m ls ] [!m lp ] | Lists up to 10 currently queued songs. +`!m n`, `!m next` | Goes to the next song in the queue. +`!m s`, `!m stop` | Completely stops the music and unbinds the bot from the channel and cleanes up files. +`!m p`, `!m pause` | Pauses the song +`!m q`, `!m yq` | Queue a song using a multi/single word name. | `!m q Dream Of Venice` +`!m lq`, `!m ls`, `!m lp` | Lists up to 10 currently queued songs. `!m sh` | Shuffles the current playlist. ### Searches -Command [alias] | Description | Usage +Command and aliases | Description | Usage ----------------|--------------|------- `~yt` | Queries youtubes and embeds the first result -`~ani` [~anime ] [~aq ] | Queries anilist for an anime and shows the first result. -`~mang` [~manga ] [~mq ] | Queries anilist for a manga and shows the first result. +`~ani`, `~anime`, `~aq` | Queries anilist for an anime and shows the first result. +`~mang`, `~manga`, `~mq` | Queries anilist for a manga and shows the first result. `~randomcat` | Shows a random cat image.