mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

prettier readme

Browse Source
This commit is contained in:
Master Kwoth 2016-01-20 19:00:43 +01:00
parent 93d2fc9c36
commit 56cdd6ec66
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -52,24 +52,24 @@ Enjoy
Official repo: **github.com/Kwoth/NadekoBot/** Official repo: **github.com/Kwoth/NadekoBot/**
### Administration ### 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 `-hgit` | Help command stylized for github readme
`.sr` [.setrole ] | Sets a role for a given user. | .sr @User Guest `.sr`, `.setrole` | Sets a role for a given user. | .sr @User Guest
`.rr` [.removerole ] | Removes a role from a given user. | .rr @User Admin `.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 `.r`, `.role`, `.cr` | Creates a role with a given name, and color. | .r AwesomeRole Orange
`.b` [.ban ] | Bans a mentioned user `.b`, `.ban` | Bans a mentioned user
`.ub` [.unban ] | Unbans a mentioned user `.ub`, `.unban` | Unbans a mentioned user
`.k` [.kick ] | Kicks a mentioned user. `.k`, `.kick` | Kicks a mentioned user.
`.rvch` | Removes a voice channel with a given name. `.rvch` | Removes a voice channel with a given name.
`.vch` [.cvch ] | Creates a new 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. `.rch`, `.rtch` | Removes a text channel with a given name.
`.ch` [.tch ] | Creates a new 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. `.st`, `.settopic` | Sets a topic on the current channel.
`.uid` [.userid ] | Shows user id `.uid`, `.userid` | Shows user id
`.cid` [.channelid ] | Shows current channel id `.cid`, `.channelid` | Shows current channel id
`.sid` [.serverid ] | Shows current server id `.sid`, `.serverid` | Shows current server id
`.stats` | Shows some basic stats for nadeko `.stats` | Shows some basic stats for nadeko
`.leaveall` | Nadeko leaves all servers `.leaveall` | Nadeko leaves all servers
`.prune` | Prunes a number of messages from the current channel. | .prune 50 `.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. `.byemsg` | Sets a new announce leave message. Type %user% if you want to mention the new member. | .byemsg %user% has left the server.
### Conversations ### Conversations
Command [alias] | Description | Usage Command and aliases | Description | Usage
----------------|--------------|------- ----------------|--------------|-------
`\o\` | Nadeko replies with /o/ `\o\` | Nadeko replies with /o/
`/o/` | Nadeko replies with \o\ `/o/` | Nadeko replies with \o\
`@BotName copyme` [@BotName cm ] | Nadeko starts copying everything you say. Disable with cs `@BotName copyme`, `@BotName cm` | Nadeko starts copying everything you say. Disable with cs
`@BotName cs` [@BotName copystop ] | Nadeko stops copying you `@BotName cs`, `@BotName copystop` | Nadeko stops copying you
`@BotName uptime` | Shows how long is Nadeko running for. `@BotName uptime` | Shows how long is Nadeko running for.
`@BotName die` | Works only for the owner. Shuts the bot down. `@BotName die` | Works only for the owner. Shuts the bot down.
`@BotName randserver` | Generates an invite to a random server and prints some stats. `@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 insult` | Only works for owner. Insults @X person. | @NadekoBot insult @X.
`@BotName praise` | Only works for owner. Praises @X person. | @NadekoBot praise @X. `@BotName praise` | Only works for owner. Praises @X person. | @NadekoBot praise @X.
`@BotName are you real` | Useless. `@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 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 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 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 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 ls` | Shows all saved items.
`@BotName slm` | Shows the message where you were last mentioned in this channel (checks last 10k messages) `@BotName slm` | Shows the message where you were last mentioned in this channel (checks last 10k messages)
`@BotName cs` | Deletes all saves `@BotName cs` | Deletes all saves
`@BotName bb` | Says bye to someone. | @NadekoBot bb @X `@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 lr` | PMs the user all current nadeko requests.
`@BotName dr` | Deletes a request. Only owner is able to do this. `@BotName dr` | Deletes a request. Only owner is able to do this.
`@BotName rr` | Resolves 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 hide` | Hides nadeko in plain sight!11!!
`@BotName unhide` | Unhides nadeko in plain sight!1!!1 `@BotName unhide` | Unhides nadeko in plain sight!1!!1
`@BotName dump` | Dumps all of the invites it can to dump.txt `@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 ### 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] `$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. `$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] `$roll` | Rolls 2 dice from 0-10. If you supply a number [x] it rolls up to 30 normal dice. | $roll [x]
### Games ### Games
Command [alias] | Description | Usage Command and aliases | Description | Usage
----------------|--------------|------- ----------------|--------------|-------
`t` [-t ] | Starts a game of trivia. `t`, `-t` | Starts a game of trivia.
`tl` [-tl ] [tlb ] [-tlb ] | Shows a current trivia leaderboard. `tl`, `-tl`, `tlb`, `-tlb` | Shows a current trivia leaderboard.
`tq` [-tq ] | Quits current trivia after current question. `tq`, `-tq` | Quits current trivia after current question.
`>` | Attack a person. Supported attacks: 'splash', 'strike', 'burn', 'surge'. | > strike @User `>` | 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 `poketype` | Gets the users element type. Use this to do more damage with strike
### Music ### Music
Command [alias] | Description | Usage Command and aliases | Description | Usage
----------------|--------------|------- ----------------|--------------|-------
`!m n` [!m next ] | Goes to the next song in the queue. `!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 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 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 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 lq`, `!m ls`, `!m lp` | Lists up to 10 currently queued songs.
`!m sh` | Shuffles the current playlist. `!m sh` | Shuffles the current playlist.
### Searches ### Searches
Command [alias] | Description | Usage Command and aliases | Description | Usage
----------------|--------------|------- ----------------|--------------|-------
`~yt` | Queries youtubes and embeds the first result `~yt` | Queries youtubes and embeds the first result
`~ani` [~anime ] [~aq ] | Queries anilist for an anime 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. `~mang`, `~manga`, `~mq` | Queries anilist for a manga and shows the first result.
`~randomcat` | Shows a random cat image. `~randomcat` | Shows a random cat image.