diff --git a/README.md b/README.md index e9424f7f..30aa74fd 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,15 @@ Command and aliases | Description | Usage `.greetmsg` | Sets a new announce message. Type %user% if you want to mention the new member. | .greetmsg Welcome to the server, %user%. `.bye` | Enables or Disables anouncements on the current channel when someone leaves 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. +`.byepm` | Toggles whether the good bye messages will be sent in a PM or in the text channel. +`.greetpm` | Toggles whether the greet messages will be sent in a PM or in the text channel. `.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 -`.rolecolor`, `.rc` | Set a role's color to the hex or 0-255 color value provided. | **Usage*: .color Admin 255 200 100 or .color Admin ffba55 -`.roles` | List all roles on this server +`.r`, `.role`, `.cr` | Creates a role with a given name. | .r Awesome Role +`.rolecolor`, `.rc` | Set a role's color to the hex or 0-255 color value provided. | .color Admin 255 200 100 or .color Admin ffba55 +`.roles` | List all roles on this server or a single user if specified. +`.modules` | List all bot modules +`.commands` | List all of the bot's commands from a certain module. `.b`, `.ban` | Bans a mentioned user `.ub`, `.unban` | Unbans a mentioned user `.k`, `.kick` | Kicks a mentioned user. @@ -82,18 +86,46 @@ Command and aliases | Description | Usage `.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 +`.leaveall` | Nadeko leaves all servers **OWNER ONLY** +`.prune` | Prunes a number of messages from the current channel. | .prune 5 `.die`, `.graceful` | Works only for the owner. Shuts the bot down and notifies users about the restart. `.clr` | Clears some of nadeko's messages from the current channel. -`.newname` | Give the bot a new name. +`.newname`, `.setname` | Give the bot a new name. `.setgame` | Sets the bots game. `.checkmyperms` | Checks your userspecific permissions on this channel. `.commsuser` | Sets a user for through-bot communication. Only works if server is set. Resets commschannel.**Owner only**. `.commsserver` | Sets a server for through-bot communication.**Owner only**. `.commschannel` | Sets a channel for through-bot communication. Only works if server is set. Resets commsuser.**Owner only**. `.send` | Send a message to someone on a different server through the bot.**Owner only.** -`.menrole`, `.mentionrole` | Mentions every person from the provided role or roles (separated by a comma) on this server. Requires you to have mention @everyone permission. + | .send Message text multi word! +`.menrole`, `.mentionrole` | Mentions every person from the provided role or roles (separated by a ',') on this server. Requires you to have mention everyone permission. +`.parsetosql` | Loads exported parsedata from /data/parsedata/ into sqlite database. +`.unstuck` | Clears the message queue. **OWNER ONLY** +`.donators` | List of lovely people who donated to keep this project alive. +`.adddon`, `.donadd` | Add a donator to the database. + +### Permissions +Command and aliases | Description | Usage +----------------|--------------|------- +`;verbose` | Sets whether to show when a command/module is blocked. | ;verbose true +`;serverperms`, `;sp` | Shows banned permissions for this server. +`;roleperms`, `;rp` | Shows banned permissions for a certain role. No argument means for everyone. | ;rp AwesomeRole +`;channelperms`, `;cp` | Shows banned permissions for a certain channel. No argument means for this channel. | ;cp #dev +`;userperms`, `;up` | Shows banned permissions for a certain user. No argument means for yourself. | ;up Kwoth +`;sm`, `;servermodule` | Sets a module's permission at the server level. | ;sm enable +`;sc`, `;servercommand` | Sets a command's permission at the server level. | ;sc disable +`;rm`, `;rolemodule` | Sets a module's permission at the role level. | ;rm enable +`;rc`, `;rolecommand` | Sets a command's permission at the role level. | ;rc disable +`;cm`, `;channelmodule` | Sets a module's permission at the channel level. | ;cm enable +`;cc`, `;channelcommand` | Sets a command's permission at the channel level. | ;cm enable +`;um`, `;usermodule` | Sets a module's permission at the user level. | ;um enable +`;uc`, `;usercommand` | Sets a command's permission at the user level. | ;uc enable +`;asm`, `;allservermodules` | Sets permissions for all modules at the server level. | ;asm +`;asc`, `;allservercommands` | Sets permissions for all commands from a certain module at the server level. | ;asc +`;acm`, `;allchannelmodules` | Sets permissions for all modules at the server level. | ;acm +`;acc`, `;allchannelcommands` | Sets permissions for all commands from a certain module at the server level. | ;acc +`;arm`, `;allrolemodules` | Sets permissions for all modules at the role level. | ;arm +`;arc`, `;allrolecommands` | Sets permissions for all commands from a certain module at the role level. | ;arc ### Conversations Command and aliases | Description | Usage @@ -139,6 +171,7 @@ Command and aliases | Description | Usage `$roll` | Rolls 2 dice from 0-10. If you supply a number [x] it rolls up to 30 normal dice. | $roll [x] `$nroll` | Rolls in a given range. | `$nroll 5` (rolls 0-5) or `$nroll 5-15` `$raffle` | Prints a name and ID of a random user from the online list from the (optional) role. +`$$$` | Check how many NadekoFlowers you have. ### Games Command and aliases | Description | Usage @@ -149,6 +182,10 @@ Command and aliases | Description | Usage `typestart` | Starts a typing contest. `typestop` | Stops a typing contest on the current channel. `typeadd` | Adds a new article to the typing contest. Owner only. +`>poll` | Creates a poll, only person who has manage server permission can do it. | >poll Question?;Answer1;Answ 2;A_3 +`>pollend` | Stops active poll on this server and prints the results in this channel. +`>choose` | Chooses a thing from a list of things | >choose Get up;Sleep;Sleep more +`>8ball` | Ask the 8ball a yes/no 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 @@ -157,7 +194,7 @@ 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 p`, `!m pause` | Pauses or Unpauses the song `!m q`, `!m yq` | Queue a song using keywords or link. Bot will join your voice channel. **You must be in a voice channel**. | `!m q Dream Of Venice` `!m lq`, `!m ls`, `!m lp` | Lists up to 10 currently queued songs. `!m np`, `!m playing` | Shows the song currently playing. @@ -168,6 +205,7 @@ Command and aliases | Description | Usage `!m sh` | Shuffles the current playlist. `!m setgame` | Sets the game of the bot to the number of songs playing.**Owner only** `!m pl` | Queues up to 25 songs from a youtube playlist specified by a link, or keywords. +`!m radio`, `!m ra` | Queues a direct radio stream from a link. `!m debug` | Writes some music data to console. **BOT OWNER ONLY** ### Searches @@ -177,11 +215,17 @@ Command and aliases | Description | Usage `~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. -`~i`, `img` | Pulls a first image using a search parameter. | @NadekoBot img Multiword_search_parameter -`~ir`, `imgrandom` | Pulls a random image using a search parameter. | @NadekoBot img Multiword_search_parameter +`~i` | Pulls a first image using a search parameter. Use ~ir for different results. | ~i cute kitten +`~ir` | Pulls a random image using a search parameter. | ~ir cute kitten +`lmgtfy`, `~lmgtfy` | Google something for an idiot. +`~hs` | Searches for a Hearthstone card and shows its image. Takes a while to complete. | ~hs Ysera +`~osu` | Shows osu stats for a player | ~osu Name + +### NSFW +Command and aliases | Description | Usage +----------------|--------------|------- `~hentai` | Shows a random NSFW hentai image from gelbooru and danbooru with a given tag. Tag is optional but preffered. | ~hentai yuri -`~danbooru` | Shows a random hentai image from danbooru with a given tag. Tag is optional but preffered. | ~hentai yuri -`~gelbooru` | Shows a random hentai image from gelbooru with a given tag. Tag is optional but preffered. | ~hentai yuri +`~danbooru` | Shows a random hentai image from danbooru with a given tag. Tag is optional but preffered. | ~danbooru yuri +`~gelbooru` | Shows a random hentai image from gelbooru with a given tag. Tag is optional but preffered. | ~gelbooru yuri `~cp` | We all know where this will lead you to. -`lmgtfy` | Google something for an idiot. -`~hs` | Searches for a Hearthstone card and shows its image. +`~boobs` | Real adult content.