From 9fe5fbdac8de636c82169249d009ef86f8481f37 Mon Sep 17 00:00:00 2001 From: Master Kwoth Date: Tue, 5 Jan 2016 11:02:20 +0100 Subject: [PATCH] brand new readme :) --- README.md | 168 +++++++++++++++++++++++++++++------------------------- 1 file changed, 90 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 834d8266..249b1e89 100644 --- a/README.md +++ b/README.md @@ -38,85 +38,97 @@ Enjoy ##List of commands (may be incomplete) 10.12.2015 -----Administration---- -`-h` [-help ] [@BotName help ] [@BotName h ] **Description:** Help command -`.sr` [.setrole ] **Description:** Sets a role for a given user. -**Usage:** .sr @User Guest -`.rr` [.removerole ] **Description:** Removes a role from a given user. -**Usage:** .rr @User Admin -`.r` [.role ] [.cr ] **Description:** Creates a role with a given name, and color. -`Both the user and the bot must have the sufficient permissions.` -`.b` [.ban ] **Description:** Kicks a mentioned user -`Both the user and the bot must have the sufficient permissions.` -`.k` [.kick ] **Description:** Kicks a mentioned user. -`Both the user and the bot must have the sufficient permissions.` -`.rvch` **Description:** Removes a voice channel with a given name. -`Both the user and the bot must have the sufficient permissions. ` -`.vch` [.cvch ] **Description:** Creates a new voice channel with a given name. -`Both the user and the bot must have the sufficient permissions.` -`.rch` [.rtch ] **Description:** Removes a text channel with a given name. -`Both the user and the bot must have the sufficient permissions.` -`.ch` [.tch ] **Description:** Creates a new text channel with a given name. -`Both the user and the bot must have the sufficient permissions.` -`.uid` [.userid ] **Description:** Shows user id -`.cid` [.channelid ] **Description:** Shows current channel id -`.sid` [.serverid ] **Description:** Shows current server id -`.stats` **Description:** Shows some basic stats for nadeko -----Conversations---- -\o\ **Description:** Nadeko replies with /o/ -/o/ **Description:** Nadeko replies with \o\ -`@BotName` copyme [@BotName cm ] **Description:** Nadeko starts copying everything you say. Disable with cs -`@BotName` cs [@BotName copystop ] **Description:** Nadeko stops copying you -`@BotName` do you love me **Description:** Replies with positive answer only to the bot owner. -`@BotName` die **Description:** Works only for the owner. Shuts the bot down. -`@BotName` how are you **Description:** Replies positive only if bot owner is online. -`@BotName` insult **Description:** Only works for owner. Insults @X person. -**Usage:** @NadekoBot insult @X. -`@BotName` praise **Description:** Only works for owner. Praises @X person. -**Usage:** @NadekoBot praise @X. -`@BotName` are you real **Description:** Useless. -`@BotName` are you there [@BotName ! ] [@BotName ? ] **Description:** Checks if nadeko is operational. -`@BotName` draw **Description:** Nadeko instructs you to type $draw. Gambling functions start with $ -`@BotName` uptime **Description:** Shows how long is Nadeko running for. -`@BotName` fire **Description:** Shows a unicode fire message. Optional parameter [x] tells her how many times to repeat the fire. -**Usage:** @NadekoBot fire [x] -`@BotName` rip **Description:** Shows a grave image.Optional parameter [@X] instructs her to put X's name on the grave. -**Usage:** @NadekoBot rip [@X] -`@BotName` j **Description:** Joins a server using a code. -`@BotName` i [@BotName img ] **Description:** Pulls a first image using a search parameter. -**Usage:** @NadekoBot img Multiword_search_parameter -`@BotName` ir [@BotName imgrandom ] **Description:** Pulls a random image using a search parameter. -**Usage:** @NadekoBot img Multiword_search_parameter -`@BotName` save [@BotName ,s ] [@BotName -s ] **Description:** Saves something for the owner in a file. -`@BotName` ls **Description:** Shows all saved items. -`@BotName` cs **Description:** Deletes all saves -`@BotName` bb **Description:** Says bye to someone. **Usage:** @NadekoBot bb @X -`@BotName` req [@BotName ,request ] [@BotName -request ] **Description:** Requests a feature for nadeko. -**Usage:** @NadekoBot req new_feature -`@BotName` lr **Description:** PMs the user all current nadeko requests. -`@BotName` dr **Description:** Deletes a request. Only owner is able to do this. -`@BotName` rr **Description:** Resolves a request. Only owner is able to do this. -`@BotName` clr **Description:** Clears some of nadeko's messages from the current channel. -`@BotName` call **Description:** Useless. Writes calling @X to chat. -**Usage:** @NadekoBot call @X -`@BotName` hide **Description:** Hides nadeko in plain sight!11!! -`@BotName` unhide **Description:** Unhides nadeko in plain sight!1!!1 +Official repo: **github.com/Kwoth/NadekoBot/** -----Gambling---- -`$draw` **Description:** Draws a card from the deck.If you supply number [x], she draws up to 5 cards from the deck. -**Usage:** $draw [x] -`$flip` **Description:** Flips a coin, heads or tails, and shows an image of it. -`$roll` **Description:** Rolls 2 dice from 0-10. If you supply a number [x] it rolls up to 30 normal dice. -**Usage:** $roll [x] +### Administration +Command [alias] | Description | Usage +----------------|--------------|------- +`-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. +`.b` [.ban ] | Kicks 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. +`.uid` [.userid ] | Shows user id +`.cid` [.channelid ] | Shows current channel id +`.sid` [.serverid ] | Shows current server id +`.stats` | Shows some basic stats for nadeko -----Games---- -`t` [-t ] **Description:** Starts a game of trivia. -`tl` [-tl ] [tlb ] [-tlb ] **Description:** Shows a current trivia leaderboard. -`tq` [-tq ] **Description:** Quits current trivia after current question. +### Conversations +Command [alias] | 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 do you love me` | Replies with positive answer only to the bot owner. +`@BotName die` | Works only for the owner. Shuts the bot down. +`@BotName how are you` | Replies positive only if bot owner is online. +`@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 draw` | Nadeko instructs you to type $draw. Gambling functions start with $ +`@BotName uptime` | Shows how long is Nadeko running for. +`@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. Obsolete, since nadeko will autojoin any valid code in chat. +`@BotName i` [@BotName img ] | Pulls a first image using a search parameter. | @NadekoBot img Multiword_search_parameter +`@BotName ir` [@BotName imgrandom ] | Pulls a random image using a search parameter. | @NadekoBot img Multiword_search_parameter +`@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 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. +`@BotName clr` | Clears some of nadeko's messages from the current channel. +`@BotName call` | Useless. Writes calling @X to chat. | @NadekoBot call @X +`@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 randserver` | Generates an invite to a random server and prints some stats. +`@BotName av` [@BotName avatar ] | Shows a mentioned person's avatar. | ~av @X -----Searches---- -`~av` **Description:** Shows a mentioned person's avatar. **Usage:** ~av @X -`~yt` **Description:** Queries youtubes and embeds the first result -`~ani` [~anime ] [~aq ] **Description:** Queries anilist for an anime and shows the first result. -`~mang` [~manga ] [~mq ] **Description:** Queries anilist for a manga and shows the first result. +### Gambling +Command [alias] | 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 +----------------|--------------|------- +`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 +----------------|--------------|------- +`!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. +`!m p` [!m pause ] | Pauses the song +`!m testq` | 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 sh` | Shuffles the current playlist. +`!m radio` [!m music ] | Binds to a voice and text channel in order to play music. + +### Searches +Command [alias] | 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.