tests, docs from dev
This commit is contained in:
Kwoth
parent
51f02233c6
commit
f468edbfc2
360
docs/Commands List.md
Normal file
360
docs/Commands List.md
Normal file
@ -0,0 +1,360 @@
|
|||||||
|
|
||||||
|
### Help
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`-h`, `-help`, `@BotName help`, `@BotName h`, `~h` | Either shows a help for a single command, or PMs you help link if no arguments are specified. | `-h !m q` or just `-h`
|
||||||
|
`-hgit` | Generates the commandlist.md file. **Bot Owner Only!** | `-hgit`
|
||||||
|
`-readme`, `-guide` | Sends a readme and a guide links to the channel. | `-readme` or `-guide`
|
||||||
|
`-donate`, `~donate` | Instructions for helping the project! | `-donate` or `~donate`
|
||||||
|
`-modules`, `.modules` | List all bot modules. | `-modules` or `.modules`
|
||||||
|
`-commands`, `.commands` | List all of the bot's commands from a certain module. | `-commands` or `.commands`
|
||||||
|
|
||||||
|
### Administration
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`.grdel` | Toggles automatic deletion of greet and bye messages. **Needs Manage Server Permissions.**| `.grdel`
|
||||||
|
`.greet` | Toggles anouncements on the current channel when someone joins the server. **Needs Manage Server Permissions.**| `.greet`
|
||||||
|
`.greetmsg` | Sets a new join announcement message. Type %user% if you want to mention the new member. Using it with no message will show the current greet message. **Needs Manage Server Permissions.**| `.greetmsg Welcome, %user%.`
|
||||||
|
`.bye` | Toggles anouncements on the current channel when someone leaves the server. | `.bye`
|
||||||
|
`.byemsg` | Sets a new leave announcement message. Type %user% if you want to mention the new member. Using it with no message will show the current bye message. **Needs Manage Server Permissions.**| `.byemsg %user% has left.`
|
||||||
|
`.byepm` | Toggles whether the good bye messages will be sent in a PM or in the text channel. **Needs Manage Server Permissions.**| `.byepm`
|
||||||
|
`.greetpm` | Toggles whether the greet messages will be sent in a PM or in the text channel. **Needs Manage Server Permissions.**| `.greetpm`
|
||||||
|
`.spmom` | Toggles whether mentions of other offline users on your server will send a pm to them. **Needs Manage Server Permissions.**| `.spmom`
|
||||||
|
`.logserver` | Toggles logging in this channel. Logs every message sent/deleted/edited on the server. **Bot Owner Only!** | `.logserver`
|
||||||
|
`.logignore` | Toggles whether the .logserver command ignores this channel. Useful if you have hidden admin channel and public log channel. **Bot Owner Only!**| `.logignore`
|
||||||
|
`.userpresence` | Starts logging to this channel when someone from the server goes online/offline/idle. **Needs Manage Server Permissions.**| `.userpresence`
|
||||||
|
`.voicepresence` | Toggles logging to this channel whenever someone joins or leaves a voice channel you are in right now. **Needs Manage Server Permissions.**| `.voicerpresence`
|
||||||
|
`.repeatinvoke`, `.repinv` | Immediately shows the repeat message and restarts the timer. **Needs Manage Messages Permissions.**| `.repinv`
|
||||||
|
`.repeat` | Repeat a message every X minutes. If no parameters are specified, repeat is disabled. **Needs Manage Messages Permissions.** |`.repeat 5 Hello there`
|
||||||
|
`.rotateplaying`, `.ropl` | Toggles rotation of playing status of the dynamic strings you specified earlier. **Bot Owner Only!** | `.ropl`
|
||||||
|
`.addplaying`, `.adpl` | Adds a specified string to the list of playing strings to rotate. Supported placeholders: %servers%, %users%, %playing%, %queued%, %trivia% **Bot Owner Only!**| `.adpl`
|
||||||
|
`.listplaying`, `.lipl` | Lists all playing statuses with their corresponding number. **Bot Owner Only!**| `.lipl`
|
||||||
|
`.removeplaying`, `.repl`, `.rmpl` | Removes a playing string on a given number. **Bot Owner Only!**| `.rmpl`
|
||||||
|
`.slowmode` | Toggles slow mode. When ON, users will be able to send only 1 message every 5 seconds. **Needs Manage Messages Permissions.**| `.slowmode`
|
||||||
|
`.cleanv+t`, `.cv+t` | Deletes all text channels ending in `-voice` for which voicechannels are not found. **Use at your own risk. Needs Manage Roles and Manage Channels Permissions.** | `.cleanv+t`
|
||||||
|
`.voice+text`, `.v+t` | Creates a text channel for each voice channel only users in that voice channel can see.If you are server owner, keep in mind you will see them all the time regardless. **Needs Manage Roles and Manage Channels Permissions.**| `.voice+text`
|
||||||
|
`.scsc` | Starts an instance of cross server channel. You will get a token as a DM that other people will use to tune in to the same instance. **Bot Owner Only.** | `.scsc`
|
||||||
|
`.jcsc` | Joins current channel to an instance of cross server channel using the token. **Needs Manage Server Permissions.**| `.jcsc`
|
||||||
|
`.lcsc` | Leaves Cross server channel instance from this channel. **Needs Manage Server Permissions.**| `.lcsc`
|
||||||
|
`.asar` | Adds a role, or list of roles separated by whitespace(use quotations for multiword roles) to the list of self-assignable roles. **Needs Manage Roles Permissions.**| `.asar Gamer`
|
||||||
|
`.rsar` | Removes a specified role from the list of self-assignable roles. | `.rsar`
|
||||||
|
`.lsar` | Lists all self-assignable roles. | `.lsar`
|
||||||
|
`.togglexclsar`, `.tesar` | toggle whether the self-assigned roles should be exclusive | `.tesar`
|
||||||
|
`.iam` | Adds a role to you that you choose. Role must be on a list of self-assignable roles. | `.iam Gamer`
|
||||||
|
`.iamnot`, `.iamn` | Removes a role to you that you choose. Role must be on a list of self-assignable roles. | `.iamn Gamer`
|
||||||
|
`.addcustreact`, `.acr` | Add a custom reaction. Guide here: <https://github.com/Kwoth/NadekoBot/wiki/Custom-Reactions> **Bot Owner Only!** | `.acr "hello" Hi there %user%`
|
||||||
|
`.listcustreact`, `.lcr` | Lists custom reactions (paginated with 30 commands per page). Use 'all' instead of page number to get all custom reactions DM-ed to you. |`.lcr 1`
|
||||||
|
`.showcustreact`, `.scr` | Shows all possible responses from a single custom reaction. |`.scr %mention% bb`
|
||||||
|
`.editcustreact`, `.ecr` | Edits a custom reaction, arguments are custom reactions name, index to change, and a (multiword) message **Bot Owner Only** | `.ecr "%mention% disguise" 2 Test 123`
|
||||||
|
`.delcustreact`, `.dcr` | Deletes a custom reaction with given name (and index). **Bot Owner Only.**| `.dcr index`
|
||||||
|
`.autoassignrole`, `.aar` | Automaticaly assigns a specified role to every user who joins the server. **Needs Manage Roles Permissions.** |`.aar` to disable, `.aar Role Name` to enable
|
||||||
|
`.leave` | Makes Nadeko leave the server. Either name or id required. **Bot Owner Only!**| `.leave 123123123331`
|
||||||
|
`.listincidents`, `.lin` | List all UNREAD incidents and flags them as read. **Needs Manage Server Permissions.**| `.lin`
|
||||||
|
`.listallincidents`, `.lain` | Sends you a file containing all incidents and flags them as read. **Needs Manage Server Permissions.**| `.lain`
|
||||||
|
`.delmsgoncmd` | Toggles the automatic deletion of user's successful command message to prevent chat flood. **Server Manager Only.** | `.delmsgoncmd`
|
||||||
|
`.restart` | Restarts the bot. Might not work. **Bot Owner Only** | `.restart`
|
||||||
|
`.setrole`, `.sr` | Sets a role for a given user. **Needs Manage Roles Permissions.**| `.sr @User Guest`
|
||||||
|
`.removerole`, `.rr` | Removes a role from a given user. **Needs Manage Roles Permissions.**| `.rr @User Admin`
|
||||||
|
`.renamerole`, `.renr` | Renames a role. Roles you are renaming must be lower than bot's highest role. **Manage Roles Permissions.** | `.renr "First role" SecondRole`
|
||||||
|
`.removeallroles`, `.rar` | Removes all roles from a mentioned user. **Needs Manage Roles Permissions.**| `.rar @User`
|
||||||
|
`.createrole`, `.cr` | Creates a role with a given name. **Needs Manage Roles Permissions.**| `.cr Awesome Role`
|
||||||
|
`.rolecolor`, `.rc` | Set a role's color to the hex or 0-255 rgb color value provided. **Needs Manage Roles Permissions.** | `.rc Admin 255 200 100` or `.rc Admin ffba55`
|
||||||
|
`.ban`, `.b` | Bans a user by id or name with an optional message. **Needs Ban Permissions.**| `.b "@some Guy" Your behaviour is toxic.`
|
||||||
|
`.softban`, `.sb` | Bans and then unbans a user by id or name with an optional message. **Needs Ban Permissions.**| `.sb "@some Guy" Your behaviour is toxic.`
|
||||||
|
`.kick`, `.k` | Kicks a mentioned user. **Needs Kick Permissions.**| `.k "@some Guy" Your behaviour is toxic.`
|
||||||
|
`.mute` | Mutes mentioned user or users. **Needs Mute Permissions.**| `.mute "@Someguy"` or `.mute "@Someguy" "@Someguy"`
|
||||||
|
`.unmute` | Unmutes mentioned user or users. **Needs Mute Permissions.**| `.unmute "@Someguy"` or `.unmute "@Someguy" "@Someguy"`
|
||||||
|
`.deafen`, `.deaf` | Deafens mentioned user or users. **Needs Deafen Permissions.**| `.deaf "@Someguy"` or `.deaf "@Someguy" "@Someguy"`
|
||||||
|
`.undeafen`, `.undef` | Undeafens mentioned user or users. **Needs Deafen Permissions.** | `.undef "@Someguy"` or `.undef "@Someguy" "@Someguy"`
|
||||||
|
`.delvoichanl`, `.dvch` | Deletes a voice channel with a given name. **Needs Manage Channel Permissions.**| `.dvch VoiceChannelName`
|
||||||
|
`.creatvoichanl`, `.cvch` | Creates a new voice channel with a given name. **Needs Manage Channel Permissions.** | `.cvch VoiceChannelName`
|
||||||
|
`.deltxtchanl`, `.dtch` | Deletes a text channel with a given name. **Needs Manage Channel Permissions.** | `.dtch TextChannelName`
|
||||||
|
`.creatxtchanl`, `.ctch` | Creates a new text channel with a given name. **Needs Manage Channel Permissions.** | `.ctch TextChannelName`
|
||||||
|
`.settopic`, `.st` | Sets a topic on the current channel. **Needs Manage Channel Permissions.** | `.st My new topic`
|
||||||
|
`.setchanlname`, `.schn` | Changed the name of the current channel. **Needs Manage Channel Permissions.**| `.schn NewName`
|
||||||
|
`.heap` | Shows allocated memory - **Bot Owner Only!** | `.heap`
|
||||||
|
`.prune`, `.clr` | `.prune` removes all nadeko's messages in the last 100 messages.`.prune X` removes last X messages from the channel (up to 100)`.prune @Someone` removes all Someone's messages in the last 100 messages.`.prune @Someone X` removes last X 'Someone's' messages in the channel. **Needs Manage Messages Permissions**| `.prune` or `.prune 5` or `.prune @Someone` or `.prune @Someone X`
|
||||||
|
`.die` | Shuts the bot down and notifies users about the restart. **Bot Owner Only!** | `.die`
|
||||||
|
`.setname`, `.newnm` | Give the bot a new name. **Bot Owner Only!** | `.newnm BotName`
|
||||||
|
`.newavatar`, `.setavatar` | Sets a new avatar image for the NadekoBot. Argument is a direct link to an image. **Bot Owner Only!** | `.setavatar http://i.imgur.com/xTG3a1I.jpg`
|
||||||
|
`.setgame` | Sets the bots game. **Bot Owner Only!** | `.setgame Playing with kwoth`
|
||||||
|
`.send` | Send a message to someone on a different server through the bot. **Bot Owner Only!** | `.send sid|u:uid Hello user!` or `.send sid|c:cid Message to channel!` (cid = channel id, sid = server id)
|
||||||
|
`.mentionrole`, `.menro` | Mentions every person from the provided role or roles (separated by a ',') on this server. Requires you to have mention everyone permission. | `.menro RoleName`
|
||||||
|
`.unstuck` | Clears the message queue. **Bot Owner Only!** | `.unstuck`
|
||||||
|
`.donators` | List of lovely people who donated to keep this project alive. | `.donators`
|
||||||
|
`.donadd` | Add a donator to the database. **Kwoth Only** | `.donadd Donate Amount`
|
||||||
|
`.announce` | Sends a message to all servers' general channel bot is connected to.**Bot Owner Only!** | `.announce Useless spam`
|
||||||
|
`.savechat` | Saves a number of messages to a text file and sends it to you. **Bot Owner Only** | `.savechat 150`
|
||||||
|
|
||||||
|
### Utility
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`.remind` | Sends a message to you or a channel after certain amount of time. First argument is me/here/'channelname'. Second argument is time in a descending order (mo>w>d>h>m) example: 1w5d3h10m. Third argument is a (multiword)message. | `.remind me 1d5h Do something` or `.remind #general Start now!`
|
||||||
|
`.remindmsg` | Sets message for when the remind is triggered. Available placeholders are %user% - user who ran the command, %message% - Message specified in the remind, %target% - target channel of the remind. **Bot Owner Only!** | `.remindmsg do something else`
|
||||||
|
`.serverinfo`, `.sinfo` | Shows info about the server the bot is on. If no channel is supplied, it defaults to current one. |`.sinfo Some Server`
|
||||||
|
`.channelinfo`, `.cinfo` | Shows info about the channel. If no channel is supplied, it defaults to current one. |`.cinfo #some-channel`
|
||||||
|
`.userinfo`, `.uinfo` | Shows info about the user. If no user is supplied, it defaults a user running the command. |`.uinfo @SomeUser`
|
||||||
|
`.whoplays` | Shows a list of users who are playing the specified game. | `.whoplays Overwatch`
|
||||||
|
`.inrole` | Lists every person from the provided role or roles (separated by a ',') on this server. If the list is too long for 1 message, you must have Manage Messages permission. | `.inrole Role`
|
||||||
|
`.checkmyperms` | Checks your userspecific permissions on this channel. | `.checkmyperms`
|
||||||
|
`.stats` | Shows some basic stats for Nadeko. | `.stats`
|
||||||
|
`.dysyd` | Shows some basic stats for Nadeko. | `.dysyd`
|
||||||
|
`.userid`, `.uid` | Shows user ID. | `.uid` or `.uid "@SomeGuy"`
|
||||||
|
`.channelid`, `.cid` | Shows current channel ID. | `.cid`
|
||||||
|
`.serverid`, `.sid` | Shows current server ID. | `.sid`
|
||||||
|
`.roles` | List all roles on this server or a single user if specified. | `.roles`
|
||||||
|
`.channeltopic`, `.ct` | Sends current channel's topic as a message. | `.ct`
|
||||||
|
|
||||||
|
### Permissions
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`;chnlfilterinv`, `;cfi` | Enables or disables automatic deleting of invites on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once. | `;cfi enable #general-chat`
|
||||||
|
`;srvrfilterinv`, `;sfi` | Enables or disables automatic deleting of invites on the server. | `;sfi disable`
|
||||||
|
`;chnlfilterwords`, `;cfw` | Enables or disables automatic deleting of messages containing banned words on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once. | `;cfw enable #general-chat`
|
||||||
|
`;addfilterword`, `;afw` | Adds a new word to the list of filtered words | `;afw poop`
|
||||||
|
`;rmvfilterword`, `;rfw` | Removes the word from the list of filtered words | `;rw poop`
|
||||||
|
`;lstfilterwords`, `;lfw` | Shows a list of filtered words | `;lfw`
|
||||||
|
`;srvrfilterwords`, `;sfw` | Enables or disables automatic deleting of messages containing forbidden words on the server. | `;sfw disable`
|
||||||
|
`;permrole`, `;pr` | Sets a role which can change permissions. Or supply no parameters to find out the current one. Default one is 'Nadeko'. | `;pr role`
|
||||||
|
`;rolepermscopy`, `;rpc` | Copies BOT PERMISSIONS (not discord permissions) from one role to another. |`;rpc Some Role ~ Some other role`
|
||||||
|
`;chnlpermscopy`, `;cpc` | Copies BOT PERMISSIONS (not discord permissions) from one channel to another. |`;cpc Some Channel ~ Some other channel`
|
||||||
|
`;usrpermscopy`, `;upc` | Copies BOT PERMISSIONS (not discord permissions) from one role to another. |`;upc @SomeUser ~ @SomeOtherUser`
|
||||||
|
`;verbose`, `;v` | Sets whether to show when a command/module is blocked. | `;verbose true`
|
||||||
|
`;srvrperms`, `;sp` | Shows banned permissions for this server. | `;sp`
|
||||||
|
`;roleperms`, `;rp` | Shows banned permissions for a certain role. No argument means for everyone. | `;rp AwesomeRole`
|
||||||
|
`;chnlperms`, `;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`
|
||||||
|
`;srvrmdl`, `;sm` | Sets a module's permission at the server level. | `;sm "module name" enable`
|
||||||
|
`;srvrcmd`, `;sc` | Sets a command's permission at the server level. | `;sc "command name" disable`
|
||||||
|
`;rolemdl`, `;rm` | Sets a module's permission at the role level. | `;rm "module name" enable MyRole`
|
||||||
|
`;rolecmd`, `;rc` | Sets a command's permission at the role level. | `;rc "command name" disable MyRole`
|
||||||
|
`;chnlmdl`, `;cm` | Sets a module's permission at the channel level. | `;cm "module name" enable SomeChannel`
|
||||||
|
`;chnlcmd`, `;cc` | Sets a command's permission at the channel level. | `;cc "command name" enable SomeChannel`
|
||||||
|
`;usrmdl`, `;um` | Sets a module's permission at the user level. | `;um "module name" enable SomeUsername`
|
||||||
|
`;usrcmd`, `;uc` | Sets a command's permission at the user level. | `;uc "command name" enable SomeUsername`
|
||||||
|
`;allsrvrmdls`, `;asm` | Sets permissions for all modules at the server level. | `;asm [enable/disable]`
|
||||||
|
`;allsrvrcmds`, `;asc` | Sets permissions for all commands from a certain module at the server level. | `;asc "module name" [enable/disable]`
|
||||||
|
`;allchnlmdls`, `;acm` | Sets permissions for all modules at the channel level. | `;acm [enable/disable] SomeChannel`
|
||||||
|
`;allchnlcmds`, `;acc` | Sets permissions for all commands from a certain module at the channel level. | `;acc "module name" [enable/disable] SomeChannel`
|
||||||
|
`;allrolemdls`, `;arm` | Sets permissions for all modules at the role level. | `;arm [enable/disable] MyRole`
|
||||||
|
`;allrolecmds`, `;arc` | Sets permissions for all commands from a certain module at the role level. | `;arc "module name" [enable/disable] MyRole`
|
||||||
|
`;ubl` | Blacklists a mentioned user. **Bot Owner Only!**| `;ubl [user_mention]`
|
||||||
|
`;uubl` | Unblacklists a mentioned user. **Bot Owner Only!** | `;uubl [user_mention]`
|
||||||
|
`;cbl` | Blacklists a mentioned channel (#general for example). | `;cbl #some_channel`
|
||||||
|
`;cubl` | Unblacklists a mentioned channel (#general for example). | `;cubl #some_channel`
|
||||||
|
`;sbl` | Blacklists a server by a name or id (#general for example). **BOT OWNER ONLY** | `;sbl [servername/serverid]`
|
||||||
|
`;cmdcooldown`, `;cmdcd` | Sets a cooldown per user for a command. Set 0 to clear. **Needs Manager Messages Permissions**| `;cmdcd "some cmd" 5`
|
||||||
|
`;allcmdcooldowns`, `;acmdcds` | Shows a list of all commands and their respective cooldowns. | `;acmdcds`
|
||||||
|
|
||||||
|
### Conversations
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`..` | Adds a new quote with the specified name (single word) and message (no limit). | `.. abc My message`
|
||||||
|
`...` | Shows a random quote with a specified name. | `... abc`
|
||||||
|
`..qdel`, `..quotedelete` | Deletes all quotes with the specified keyword. You have to either be bot owner or the creator of the quote to delete it. | `..qdel abc`
|
||||||
|
`@BotName rip` | Shows a grave image of someone with a start year | `@NadekoBot rip @Someone 2000`
|
||||||
|
`@BotName die` | Works only for the owner. Shuts the bot down. | `@NadekoBot die`
|
||||||
|
`@BotName do you love me` | Replies with positive answer only to the bot owner. | `@NadekoBot do you love me`
|
||||||
|
`@BotName how are you`, `@BotName how are you?` | Replies positive only if bot owner is online. | `@NadekoBot how are you`
|
||||||
|
`@BotName fire` | Shows a unicode fire message. Optional parameter [x] tells her how many times to repeat the fire. | `@NadekoBot fire [x]`
|
||||||
|
`@BotName dump` | Dumps all of the invites it can to dump.txt.** Owner Only.** | `@NadekoBot dump`
|
||||||
|
`@BotName ab` | Try to get 'abalabahaha'| `@NadekoBot ab`
|
||||||
|
|
||||||
|
### Gambling
|
||||||
|
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]`
|
||||||
|
`$shuffle`, `$sh` | Reshuffles all cards back into the deck.|`$shuffle`
|
||||||
|
`$flip` | Flips coin(s) - heads or tails, and shows an image. | `$flip` or `$flip 3`
|
||||||
|
`$betflip`, `$bf` | Bet to guess will the result be heads or tails. Guessing award you double flowers you've bet. | `$bf 5 heads` or `$bf 3 t`
|
||||||
|
`$roll` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y. | `$roll` or `$roll 7` or `$roll 3d5`
|
||||||
|
`$rolluo` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice (unordered). If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y. | `$rolluo` or `$rolluo 7` or `$rolluo 3d5`
|
||||||
|
`$nroll` | Rolls in a given range. | `$nroll 5` (rolls 0-5) or `$nroll 5-15`
|
||||||
|
`$race` | Starts a new animal race. | `$race`
|
||||||
|
`$joinrace`, `$jr` | Joins a new race. You can specify an amount of flowers for betting (optional). You will get YourBet*(participants-1) back if you win. | `$jr` or `$jr 5`
|
||||||
|
`$raffle` | Prints a name and ID of a random user from the online list from the (optional) role. | `$raffle` or `$raffle RoleName`
|
||||||
|
`$$$` | Check how much NadekoFlowers a person has. (Defaults to yourself) |`$$$` or `$$$ @Someone`
|
||||||
|
`$give` | Give someone a certain amount of NadekoFlowers|`$give 1 "@SomeGuy"`
|
||||||
|
`$award` | Gives someone a certain amount of flowers. **Bot Owner Only!** | `$award 100 @person`
|
||||||
|
`$take` | Takes a certain amount of flowers from someone. **Bot Owner Only!** | `$take 1 "@someguy"`
|
||||||
|
`$betroll`, `$br` | Bets a certain amount of NadekoFlowers and rolls a dice. Rolling over 66 yields x2 flowers, over 90 - x3 and 100 x10. | `$br 5`
|
||||||
|
`$leaderboard`, `$lb` | Displays bot currency leaderboard | `$lb`
|
||||||
|
|
||||||
|
### Games
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`>t` | Starts a game of trivia. You can add nohint to prevent hints.First player to get to 10 points wins by default. You can specify a different number. 30 seconds per question. |`>t nohint` or `>t 5 nohint`
|
||||||
|
`>tl` | Shows a current trivia leaderboard. | `>tl`
|
||||||
|
`>tq` | Quits current trivia after current question. | `>tq`
|
||||||
|
`>typestart` | Starts a typing contest. | `>typestart`
|
||||||
|
`>typestop` | Stops a typing contest on the current channel. | `>typestop`
|
||||||
|
`>typeadd` | Adds a new article to the typing contest. Owner only. | `>typeadd wordswords`
|
||||||
|
`>poll` | Creates a poll, only person who has manage server permission can do it. **Needs Manage Server Permissions**| `>poll Question?;Answer1;Answ 2;A_3`
|
||||||
|
`>pollend` | Stops active poll on this server and prints the results in this channel. | `>pollend`
|
||||||
|
`>pick` | Picks a flower planted in this channel. | `>pick`
|
||||||
|
`>plant` | Spend a flower to plant it in this channel. (If bot is restarted or crashes, flower will be lost) | `>plant`
|
||||||
|
`>gencurrency`, `>gc` | Toggles currency generation on this channel. Every posted message will have 2% chance to spawn a NadekoFlower. Optional parameter cooldown time in minutes, 5 minutes by default. Requires Manage Messages permission. | `>gc` or `>gc 60`
|
||||||
|
`>leet` | Converts a text to leetspeak with 6 (1-6) severity levels | `>leet 3 Hello`
|
||||||
|
`>choose` | Chooses a thing from a list of things | `>choose Get up;Sleep;Sleep more`
|
||||||
|
`>8ball` | Ask the 8ball a yes/no question. | `>8ball should i do something`
|
||||||
|
`>rps` | Play a game of rocket paperclip scissors with Nadeko. | `>rps scissors`
|
||||||
|
`>linux` | Prints a customizable Linux interjection | `>linux Spyware Windows`
|
||||||
|
|
||||||
|
### Music
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`!!next`, `!!n`, `!!skip` | Goes to the next song in the queue. You have to be in the same voice channel as the bot. | `!!n`
|
||||||
|
`!!stop`, `!!s` | Stops the music and clears the playlist. Stays in the channel. | `!!s`
|
||||||
|
`!!destroy`, `!!d` | Completely stops the music and unbinds the bot from the channel. (may cause weird behaviour) | `!!d`
|
||||||
|
`!!pause`, `!!p` | Pauses or Unpauses the song. | `!!p`
|
||||||
|
`!!queue`, `!!q`, `!!yq` | Queue a song using keywords or a link. Bot will join your voice channel.**You must be in a voice channel**. | `!!q Dream Of Venice`
|
||||||
|
`!!soundcloudqueue`, `!!sq` | Queue a soundcloud song using keywords. Bot will join your voice channel.**You must be in a voice channel**. | `!!sq Dream Of Venice`
|
||||||
|
`!!listqueue`, `!!lq` | Lists 15 currently queued songs per page. Default page is 1. | `!!lq` or `!!lq 2`
|
||||||
|
`!!nowplaying`, `!!np` | Shows the song currently playing. | `!!np`
|
||||||
|
`!!volume`, `!!vol` | Sets the music volume 0-100% | `!!vol 50`
|
||||||
|
`!!defvol`, `!!dv` | Sets the default music volume when music playback is started (0-100). Persists through restarts. | `!!dv 80`
|
||||||
|
`!!mute`, `!!min` | Sets the music volume to 0% | `!!min`
|
||||||
|
`!!max` | Sets the music volume to 100%. | `!!max`
|
||||||
|
`!!half` | Sets the music volume to 50%. | `!!half`
|
||||||
|
`!!shuffle`, `!!sh` | Shuffles the current playlist. | `!!sh`
|
||||||
|
`!!playlist`, `!!pl` | Queues up to 500 songs from a youtube playlist specified by a link, or keywords. | `!!pl playlist link or name`
|
||||||
|
`!!soundcloudpl`, `!!scpl` | Queue a soundcloud playlist using a link. | `!!scpl soundcloudseturl`
|
||||||
|
`!!localplaylst`, `!!lopl` | Queues all songs from a directory. **Bot Owner Only!** | `!!lopl C:/music/classical`
|
||||||
|
`!!radio`, `!!ra` | Queues a radio stream from a link. It can be a direct mp3 radio stream, .m3u, .pls .asx or .xspf (Usage Video: <https://streamable.com/al54>) | `!!ra radio link here`
|
||||||
|
`!!local`, `!!lo` | Queues a local file by specifying a full path. **Bot Owner Only!** | `!!lo C:/music/mysong.mp3`
|
||||||
|
`!!move`, `!!mv` | Moves the bot to your voice channel. (works only if music is already playing) | `!!mv`
|
||||||
|
`!!remove`, `!!rm` | Remove a song by its # in the queue, or 'all' to remove whole queue. | `!!rm 5`
|
||||||
|
`!!movesong`, `!!ms` | Moves a song from one position to another. | `!! ms 5>3`
|
||||||
|
`!!setmaxqueue`, `!!smq` | Sets a maximum queue size. Supply 0 or no argument to have no limit. | `!!smq 50` or `!!smq`
|
||||||
|
`!!cleanup` | Cleans up hanging voice connections. **Bot Owner Only!** | `!!cleanup`
|
||||||
|
`!!reptcursong`, `!!rcs` | Toggles repeat of current song. | `!!rcs`
|
||||||
|
`!!rpeatplaylst`, `!!rpl` | Toggles repeat of all songs in the queue (every song that finishes is added to the end of the queue). | `!!rpl`
|
||||||
|
`!!save` | Saves a playlist under a certain name. Name must be no longer than 20 characters and mustn't contain dashes. | `!!save classical1`
|
||||||
|
`!!load` | Loads a playlist under a certain name. | `!!load classical-1`
|
||||||
|
`!!playlists`, `!!pls` | Lists all playlists. Paginated. 20 per page. Default page is 0. |`!!pls 1`
|
||||||
|
`!!deleteplaylist`, `!!delpls` | Deletes a saved playlist. Only if you made it or if you are the bot owner. | `!!delpls animu-5`
|
||||||
|
`!!goto` | Goes to a specific time in seconds in a song. | `!!goto 30`
|
||||||
|
`!!getlink`, `!!gl` | Shows a link to the song in the queue by index, or the currently playing song by default. | `!!gl`
|
||||||
|
`!!autoplay`, `!!ap` | Toggles autoplay - When the song is finished, automatically queue a related youtube song. (Works only for youtube songs and when queue is empty) | `!!ap`
|
||||||
|
|
||||||
|
### Searches
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`~lolchamp` | Shows League Of Legends champion statistics. If there are spaces/apostrophes or in the name - omit them. Optional second parameter is a role. |`~lolchamp Riven` or `~lolchamp Annie sup`
|
||||||
|
`~lolban` | Shows top 6 banned champions ordered by ban rate. Ban these champions and you will be Plat 5 in no time. | `~lolban`
|
||||||
|
`~hitbox`, `~hb` | Notifies this channel when a certain user starts streaming. | `~hitbox SomeStreamer`
|
||||||
|
`~twitch`, `~tw` | Notifies this channel when a certain user starts streaming. | `~twitch SomeStreamer`
|
||||||
|
`~beam`, `~bm` | Notifies this channel when a certain user starts streaming. | `~beam SomeStreamer`
|
||||||
|
`~checkhitbox`, `~chhb` | Checks if a certain user is streaming on the hitbox platform. | `~chhb SomeStreamer`
|
||||||
|
`~checktwitch`, `~chtw` | Checks if a certain user is streaming on the twitch platform. | `~chtw SomeStreamer`
|
||||||
|
`~checkbeam`, `~chbm` | Checks if a certain user is streaming on the beam platform. | `~chbm SomeStreamer`
|
||||||
|
`~removestream`, `~rms` | Removes notifications of a certain streamer on this channel. | `~rms SomeGuy`
|
||||||
|
`~liststreams`, `~ls` | Lists all streams you are following on this server. | `~ls`
|
||||||
|
`~convert` | Convert quantities from>to. | `~convert m>km 1000`
|
||||||
|
`~convertlist` | List of the convertable dimensions and currencies.
|
||||||
|
`~wowjoke` | Get one of Kwoth's penultimate WoW jokes. | `~wowjoke`
|
||||||
|
`~calculate`, `~calc` | Evaluate a mathematical expression. | `~calc 1+1`
|
||||||
|
`~osu` | Shows osu stats for a player. | `~osu Name` or `~osu Name taiko`
|
||||||
|
`~osu b` | Shows information about an osu beatmap. |`~osu b https://osu.ppy.sh/s/127712`
|
||||||
|
`~osu top5` | Displays a user's top 5 plays. |`~osu top5 Name`
|
||||||
|
`~pokemon`, `~poke` | Searches for a pokemon. | `~poke Sylveon`
|
||||||
|
`~pokemonability`, `~pokeab` | Searches for a pokemon ability. | `~pokeab "water gun"`
|
||||||
|
`~memelist` | Pulls a list of memes you can use with `~memegen` from http://memegen.link/templates/ | `~memelist`
|
||||||
|
`~memegen` | Generates a meme from memelist with top and bottom text. | `~memegen biw "gets iced coffee" "in the winter"`
|
||||||
|
`~we` | Shows weather data for a specified city and a country. BOTH ARE REQUIRED. Use country abbrevations. | `~we Moscow RF`
|
||||||
|
`~yt` | Searches youtubes and shows the first result | `~yt query`
|
||||||
|
`~ani`, `~anime`, `~aq` | Queries anilist for an anime and shows the first result. | `~aq aquarion evol`
|
||||||
|
`~imdb` | Queries imdb for movies or series, show first result. | `~imdb Batman vs Superman`
|
||||||
|
`~mang`, `~manga`, `~mq` | Queries anilist for a manga and shows the first result. | `~mq Shingeki no kyojin`
|
||||||
|
`~randomcat`, `~meow` | Shows a random cat image. | `~meow`
|
||||||
|
`~randomdog`, `~woof` | Shows a random dog image. | `~woof`
|
||||||
|
`~i` | Pulls the first image found 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` | Google something for an idiot. | `~lmgtfy query`
|
||||||
|
`~google`, `~g` | Get a google search link for some terms. | `~google query`
|
||||||
|
`~hs` | Searches for a Hearthstone card and shows its image. Takes a while to complete. | `~hs Ysera`
|
||||||
|
`~ud` | Searches Urban Dictionary for a word. | `~ud Pineapple`
|
||||||
|
`~#` | Searches Tagdef.com for a hashtag. | `~# ff`
|
||||||
|
`~quote` | Shows a random quote. | `~quote`
|
||||||
|
`~catfact` | Shows a random catfact from <http://catfacts-api.appspot.com/api/facts> | `~catfact`
|
||||||
|
`~yomama`, `~ym` | Shows a random joke from <http://api.yomomma.info/> | `~ym`
|
||||||
|
`~randjoke`, `~rj` | Shows a random joke from <http://tambal.azurewebsites.net/joke/random> | `~rj`
|
||||||
|
`~chucknorris`, `~cn` | Shows a random chucknorris joke from <http://tambal.azurewebsites.net/joke/random> | `~cn`
|
||||||
|
`~magicitem`, `~mi` | Shows a random magicitem from <https://1d4chan.org/wiki/List_of_/tg/%27s_magic_items> | `~mi`
|
||||||
|
`~revav` | Returns a google reverse image search for someone's avatar. | `~revav "@SomeGuy"`
|
||||||
|
`~revimg` | Returns a google reverse image search for an image from a link. | `~revav Image link`
|
||||||
|
`~safebooru` | Shows a random image from safebooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~safebooru yuri+kissing`
|
||||||
|
`~wiki` | Gives you back a wikipedia link | `~wiki query`
|
||||||
|
`~clr` | Shows you what color corresponds to that hex. | `~clr 00ff00`
|
||||||
|
`~videocall` | Creates a private <http://www.appear.in> video call link for you and other mentioned people. The link is sent to mentioned people via a private message. | `~videocall "@SomeGuy"`
|
||||||
|
`~av`, `~avatar` | Shows a mentioned person's avatar. | `~av "@SomeGuy"`
|
||||||
|
|
||||||
|
### 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. (multiple tags are appended with +) | `~hentai yuri+kissing`
|
||||||
|
`~danbooru` | Shows a random hentai image from danbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~danbooru yuri+kissing`
|
||||||
|
`~gelbooru` | Shows a random hentai image from gelbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~gelbooru yuri+kissing`
|
||||||
|
`~rule34` | Shows a random image from rule34.xx with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~rule34 yuri+kissing`
|
||||||
|
`~e621` | Shows a random hentai image from e621.net with a given tag. Tag is optional but preffered. Use spaces for multiple tags. | `~e621 yuri kissing`
|
||||||
|
`~cp` | We all know where this will lead you to. | `~cp`
|
||||||
|
`~boobs` | Real adult content. | `~boobs`
|
||||||
|
`~butts`, `~ass`, `~butt` | Real adult content. | `~butts` or `~ass`
|
||||||
|
|
||||||
|
### ClashOfClans
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`,createwar`, `,cw` | Creates a new war by specifying a size (>10 and multiple of 5) and enemy clan name. | `,cw 15 The Enemy Clan`
|
||||||
|
`,startwar`, `,sw` | Starts a war with a given number. | `,sw 15`
|
||||||
|
`,listwar`, `,lw` | Shows the active war claims by a number. Shows all wars in a short way if no number is specified. | `,lw [war_number] or ,lw`
|
||||||
|
`,claim`, `,call`, `,c` | Claims a certain base from a certain war. You can supply a name in the third optional argument to claim in someone else's place. | `,call [war_number] [base_number] [optional_other_name]`
|
||||||
|
`,claimfinish`, `,cf`, `,cf3`, `,claimfinish3` | Finish your claim with 3 stars if you destroyed a base. Optional second argument finishes for someone else. | `,cf [war_number] [optional_other_name]`
|
||||||
|
`,claimfinish2`, `,cf2` | Finish your claim with 2 stars if you destroyed a base. Optional second argument finishes for someone else. | `,cf [war_number] [optional_other_name]`
|
||||||
|
`,claimfinish1`, `,cf1` | Finish your claim with 1 stars if you destroyed a base. Optional second argument finishes for someone else. | `,cf [war_number] [optional_other_name]`
|
||||||
|
`,unclaim`, `,uncall`, `,uc` | Removes your claim from a certain war. Optional second argument denotes a person in whose place to unclaim | `,uc [war_number] [optional_other_name]`
|
||||||
|
`,endwar`, `,ew` | Ends the war with a given index. | `,ew [war_number]`
|
||||||
|
|
||||||
|
### Pokegame
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`>attack` | Attacks a target with the given move. Use `>movelist` to see a list of moves your type can use. | `>attack "vine whip" @someguy`
|
||||||
|
`>movelist`, `>ml` | Lists the moves you are able to use | `>ml`
|
||||||
|
`>heal` | Heals someone. Revives those who fainted. Costs a NadekoFlower | `>heal @someone`
|
||||||
|
`>type` | Get the poketype of the target. | `>type @someone`
|
||||||
|
`>settype` | Set your poketype. Costs a NadekoFlower. | `>settype fire`
|
||||||
|
|
||||||
|
### Translator
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`~translate`, `~trans` | Translates from>to text. From the given language to the destiation language. | `~trans en>fr Hello`
|
||||||
|
`~translangs` | List the valid languages for translation. | `~translangs` or `~translangs language`
|
||||||
|
|
||||||
|
### Customreactions
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`\o\` | Custom reaction. | `\o\`
|
||||||
|
`/o/` | Custom reaction. | `/o/`
|
||||||
|
`moveto` | Custom reaction. | `moveto`
|
||||||
|
`comeatmebro` | Custom reaction. | `comeatmebro`
|
||||||
|
`e` | Custom reaction. | `e`
|
||||||
|
`@BotName insult`, `<@!116275390695079945> insult` | Custom reaction. | `%mention% insult`
|
||||||
|
`@BotName praise`, `<@!116275390695079945> praise` | Custom reaction. | `%mention% praise`
|
||||||
|
`@BotName pat`, `<@!116275390695079945> pat` | Custom reaction. | `%mention% pat`
|
||||||
|
`@BotName cry`, `<@!116275390695079945> cry` | Custom reaction. | `%mention% cry`
|
||||||
|
`@BotName are you real?`, `<@!116275390695079945> are you real?` | Custom reaction. | `%mention% are you real?`
|
||||||
|
`@BotName are you there?`, `<@!116275390695079945> are you there?` | Custom reaction. | `%mention% are you there?`
|
||||||
|
`@BotName draw`, `<@!116275390695079945> draw` | Custom reaction. | `%mention% draw`
|
||||||
|
`@BotName bb`, `<@!116275390695079945> bb` | Custom reaction. | `%mention% bb`
|
||||||
|
`@BotName call`, `<@!116275390695079945> call` | Custom reaction. | `%mention% call`
|
||||||
|
`@BotName disguise`, `<@!116275390695079945> disguise` | Custom reaction. | `%mention% disguise`
|
||||||
|
`@BotName inv`, `<@!116275390695079945> inv` | Custom reaction. | `%mention% inv`
|
||||||
|
`@BotName threaten`, `<@!116275390695079945> threaten` | Custom reaction. | `%mention% threaten`
|
||||||
|
`@BotName archer`, `<@!116275390695079945> archer` | Custom reaction. | `%mention% archer`
|
||||||
|
|
||||||
|
### Trello
|
||||||
|
Command and aliases | Description | Usage
|
||||||
|
----------------|--------------|-------
|
||||||
|
`trello bind` | Bind a trello bot to a single channel. You will receive notifications from your board when something is added or edited. **Bot Owner Only!**| `trello bind [board_id]`
|
||||||
|
`trello unbind` | Unbinds a bot from the channel and board. **Bot Owner Only!**| `trello unbind`
|
||||||
|
`trello lists`, `trello list` | Lists all lists, yo ;) **Bot Owner Only!**| `trello list`
|
||||||
|
`trello cards` | Lists all cards from the supplied list. You can supply either a name or an index. **Bot Owner Only!**| `trello cards index`
|
||||||
7
docs/Contribution Guide.md
Normal file
7
docs/Contribution Guide.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
### How to contribute
|
||||||
|
|
||||||
|
1. Make Pull Requests to **DEV BRANCH**
|
||||||
|
2. Keep 1 Pull Request to a single feature
|
||||||
|
3. Explain what you did in the PR message
|
||||||
|
|
||||||
|
Thanks for all the help ^_^
|
||||||
69
docs/Custom Reactions.md
Normal file
69
docs/Custom Reactions.md
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
##Custom Reactions
|
||||||
|
<p><strong>Every time you add or remove a custom reaction you will need to restart your bot with either <code>.restart</code> if you are hosting or Nadeko is on VPS, or <code>.die</code> if Nadeko is on Droplet</strong></p>
|
||||||
|
<h3>Important</h3>
|
||||||
|
<ul style="list-style-type:disc">
|
||||||
|
<li><strong><code>.acr</code>, <code>.dcr</code>, and <code>.ecr</code> Require you to be Bot Owner</strong></li>
|
||||||
|
<li>Adding multiple commands of the same name will make Nadeko randomly select one of the command's responses</li>
|
||||||
|
</ul>
|
||||||
|
###Commands and Their Use
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>Command Name</th>
|
||||||
|
<th>Description</th>
|
||||||
|
<th>Example</th>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>.acr</code></td>
|
||||||
|
<td>Adds a Custom Reaction</td>
|
||||||
|
<td><code>.acr Hello Hi!</code></td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>.dcr</code></td>
|
||||||
|
<td>Deletes an entire Custom Reaction or a Specified Response Index Number</td>
|
||||||
|
<td><code>.dcr "command name"</code> or <code>.dcr "command name" 3</code></td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>.lcr</code></td>
|
||||||
|
<td>Lists a specified page of Custom Commands</td>
|
||||||
|
<td><code>.lcr Number</code> i.e <code>.lcr 2</code></td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>.scr</code></td>
|
||||||
|
<td>Shows all responses to a command. Index Number will be in brackets <code>[ ]</code></td>
|
||||||
|
<td><code>.scr Hello</code></td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>.ecr</code></td>
|
||||||
|
<td>Edit a custom reaction, needs: reaction's name, index to change, and new multiword response.</td>
|
||||||
|
<td><code>.ecr Hello 3 What's up</code></td></table>
|
||||||
|
<h4>Now that we know the commands let's take a look at the arguments and placeholders available for <code>.acr</code>,</h4>
|
||||||
|
<p><code>.addcustreact</code> (<code>.acr</code>) takes two arguments:
|
||||||
|
<dl>
|
||||||
|
<dt><strong>● First, The name of the command; this directly follows the <code>.acr</code></strong></dt>
|
||||||
|
<dd>- If your command name is more than 1 word use quotation marks;<br> i.e <del><code>.acr Nice weather sure is</code></del> > <code>.acr "Nice weather" sure is</code></dd>
|
||||||
|
<dd>- Now everytime someone says "Nice weather" the bot will respond with, "sure is"</dd>
|
||||||
|
<dt><strong>● Next, The Response, this follows the name of the command.</strong><dt>
|
||||||
|
<dd>- i.e <code>.acr "Nice weather"</code><b><i><code>sure is</code></i></b></dd></dl><p>
|
||||||
|
###And finally on to the Placeholders
|
||||||
|
<p>There are currently four placeholders, which we will be looking at, with many more to come in the future.<p>
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>Placeholder</th>
|
||||||
|
<th>How the placeholder works</th>
|
||||||
|
<th>Examples</th>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>%mention%</code></td>
|
||||||
|
<td>The <code>%mention%</code> placeholder is triggered when you type <code>@botname</code></td>
|
||||||
|
<td><code>.acr "%mention% Hello" Hello!</code> > User input: @botname Hello | Bot Replies: Hello!</td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>%target%</code></td>
|
||||||
|
<td>The <code>%target%</code> placeholder is used to make Nadeko Mention another person</td>
|
||||||
|
<td><code>.acr "%mention% Hello" %target% Hi!</code> > User inputs: "@botname Hello @somebody"
|
||||||
|
Bot replies: "Hi @somebody"</td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>%user%</code></td>
|
||||||
|
<td>The <code>%user%</code> placeholder mentions the person who said the command</td>
|
||||||
|
<td><code>.acr "Who am i" You are %user%!</code></td>
|
||||||
|
</tr><tr>
|
||||||
|
<td align="center"><code>%rng%</code></td>
|
||||||
|
<td>The <code>%rng%</code> generates a random number</td>
|
||||||
|
<td><code>.acr Random %rng%</code>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
Thanks to Nekai for being creative. <3
|
||||||
|
|
||||||
17
docs/Donate.md
Normal file
17
docs/Donate.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
##Donate to NadekoBot
|
||||||
|
|
||||||
|
If you want to help Nadeko and Nadeko's team by donating, you can do that in the two of the following ways:
|
||||||
|
|
||||||
|
###Patreon
|
||||||
|
|
||||||
|
You can donate over [Patreon][Patreon] and support the project.
|
||||||
|
|
||||||
|
[![img][img]](https://www.patreon.com/nadekobot)
|
||||||
|
|
||||||
|
|
||||||
|
###PayPal
|
||||||
|
|
||||||
|
If you wish to donate over PayPal, you can send your donations to: `nadekodiscordbot@gmail.com`
|
||||||
|
|
||||||
|
[Patreon]: https://www.patreon.com/nadekobot
|
||||||
|
[img]: http://www.mister-and-me.com/wp-content/plugins/patron-button-and-widgets-by-codebard/images/patreon-medium-button.png
|
||||||
70
docs/Frequently Asked Questions.md
Normal file
70
docs/Frequently Asked Questions.md
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
#Frequently Asked Questions
|
||||||
|
|
||||||
|
|
||||||
|
###Question 1: How do I get Nadeko to join my server?
|
||||||
|
----
|
||||||
|
**Answer:** Simply send Nadeko a Direct Message with -h and follow the link. **Only Server Owners can add the bot to the server**
|
||||||
|
###Question 2: I want to change permissions, but it isn't working!
|
||||||
|
----
|
||||||
|
**Answer:** You must have the ;permsrole (by default this is the "Nadeko" role, for more details on permissions check [here](http://nadekobot.readthedocs.io/en/latest/Permissions%20System/ "Permissions"))
|
||||||
|
|
||||||
|
**Please note:** *Only the Server Owner can change permissions without the "Nadeko" role*.
|
||||||
|
###Question 3: Music isn't working on Mac!!
|
||||||
|
----
|
||||||
|
**Answer:** You will have to build `mono` from source. Simply follow the [mono-guide](http://www.mono-project.com/docs/compiling-mono/mac/ "Building mono").
|
||||||
|
###Question 4: I want to disable NSFW on my server.
|
||||||
|
----
|
||||||
|
**Answer:** To disable the NSFW Module for your server type, `;sm NSFW disable`. If this does not work refer to Question 2.
|
||||||
|
###Question 5: How do I get NadekoFlowers/Currency?
|
||||||
|
----
|
||||||
|
**Answer:** You get NadekoFlowers by answering Trivia questions or picking them up after they have been generated with `>gc`, which you can then either plant (give away to a channel so that someone can pick it), gamble it with `$betflip`, `$betroll` and `$jr`, or spend on healing and setting your type in the Pokemon game.
|
||||||
|
###Question 6: I have an issue/bug/suggestion, where do I put it so it gets noticed?
|
||||||
|
-----------
|
||||||
|
**Answer:** First, check [issues](https://github.com/Kwoth/NadekoBot/issues "GitHub NadekoBot Issues"), then check the `#suggestions` in the Nadeko [help server](https://discord.gg/0ehQwTK2RBjAxzEY).
|
||||||
|
|
||||||
|
If your problem or suggestion is not there, feel free to request it either in Issues or in `#suggestions`.
|
||||||
|
###Question 7: How do I use this command?
|
||||||
|
--------
|
||||||
|
**Answer:** You can see the description and usage of certain commands by using `-h command` **i.e** `-h ;sm`.
|
||||||
|
|
||||||
|
The whole list of commands can be found [here](http://nadekobot.readthedocs.io/en/latest/Commands%20List/ "Command List")
|
||||||
|
###Question 8: Music isn't working?
|
||||||
|
----
|
||||||
|
**Answer:** Music is disabled on public Nadeko, it will be re-enabled later in the future.
|
||||||
|
|
||||||
|
**If you would like music you must host Nadeko yourself**. Be sure you have FFMPEG installed correctly, read the [guide](http://nadekobot.readthedocs.io/en/latest/guides/Windows%20Guide/) for more info.
|
||||||
|
###Question 9: My music is still not working/very laggy?
|
||||||
|
----
|
||||||
|
**Answer:** Try changing your discord [location][1], if this doesn't work be sure you have enabled the correct permissions for Nadeko.
|
||||||
|
[1]: https://support.discordapp.com/hc/en-us/articles/216661717-How-do-I-change-my-Voice-Server-Region-
|
||||||
|
###Question 10: I want to change data in the database (like NadekoFlowers or the pokemontypes of users, but how?
|
||||||
|
----
|
||||||
|
**Answer:** Open data/nadekobot.sqlite using sqlitebrowser (or some alternative), Browse Data, select relevant table, change data, Write changes
|
||||||
|
###Question 11: The .greet and .bye commands doesn't work, but everything else is (From @Kong)
|
||||||
|
-----
|
||||||
|
**Answer:** Set a greeting message by using `.greetmsg YourMessageHere` and a bye-message by using `.byemsg YourMessageHere`
|
||||||
|
###Question 12: How do I import certs on linux?
|
||||||
|
-------
|
||||||
|
**Answer:**
|
||||||
|
|
||||||
|
`certmgr -ssl https://discordapp.com`
|
||||||
|
|
||||||
|
`certmgr -ssl https://gateway.discord.gg`
|
||||||
|
###Question 13: I want "BOT" tag with my bot a, is there a simple way?
|
||||||
|
----
|
||||||
|
**Answer:** Yes, you can create an application using your account and use the APP BOT USER TOKEN from here: [DiscordApp][1] **NOTE: This will create a new bot account**
|
||||||
|
[1]:https://discordapp.com/developers/applications/me
|
||||||
|
|
||||||
|
###Question 14: I made an application, but I can't add that new bot to my server, how do I invite it to my server?
|
||||||
|
----
|
||||||
|
**Answer:** You need to use oauth link to add it to you server, just copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in the link below: https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303
|
||||||
|
|
||||||
|
Follow this Detailed [Guide](http://discord.kongslien.net/guide.html) if you do not understand.
|
||||||
|
###Question 15:I'm building NadekoBot from source, but I get hundreds of (namespace) errors without changing anything!?
|
||||||
|
-----
|
||||||
|
**Answer:** Using Visual Studio, you can solve these errors by going to `Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution`. Go to the Installed tab, select the Packages that were missing (usually `Newtonsoft.json` and `RestSharp`) and install them for all projects
|
||||||
|
###Question 16: My bot has all permissions but it's still saying, "Failed to add roles. Bot has insufficient permissions.". How do I fix this?
|
||||||
|
----------
|
||||||
|
**Answer:** Discord has added a few new features and roles now follow hierarchy. This means you need to place your bot's role above every-other role your server has.
|
||||||
|
|
||||||
|
**Please Note:** *The bot can only set/add all roles below its own highest role. It can not assign it's "highest role" to anyone else.*
|
||||||
60
docs/JSON Explanations.md
Normal file
60
docs/JSON Explanations.md
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
###Setting up your Credentials
|
||||||
|
If you do not see `credentials.json` you will need to rename `credentials_example.json` to `credentials.json`.
|
||||||
|
|
||||||
|
**This is how the unedited credentials look:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"Token": "",
|
||||||
|
"ClientId": "116275390695079945",
|
||||||
|
"BotId": 1231231231231,
|
||||||
|
"OwnerIds": [
|
||||||
|
123123123123,
|
||||||
|
5675675679845
|
||||||
|
],
|
||||||
|
"GoogleAPIKey": "",
|
||||||
|
"SoundCloudClientID": "",
|
||||||
|
"MashapeKey": "",
|
||||||
|
"LOLAPIKEY": "",
|
||||||
|
"TrelloAPPKey": "",
|
||||||
|
"OsuAPIKey": "",
|
||||||
|
"CarbonKey": "",
|
||||||
|
}
|
||||||
|
```
|
||||||
|
####Required Parts
|
||||||
|
+ **Token** - Required to log in. Refer to this [guide](http://discord.kongslien.net/guide.html)
|
||||||
|
+ **OwnerIds** - Required for the **Owner-Only** commands. Seperate multiple Id's with a comma.
|
||||||
|
+ **BotId** - Required for custom reactions and conversation commands to work.
|
||||||
|
+ **Important : Bot ID and Client ID are the same in newer bot accounts due to recent Discord API changes.**
|
||||||
|
|
||||||
|
_BotId and the OwnerIds are **NOT** the names of the owner and the bot. If you do not know the id of your bot, keep the two random numbers in those fields and
|
||||||
|
run the bot then do `.uid @MyBotName` - this will give you your bot_id.
|
||||||
|
Do the same for yourself with `.uid @MyName` Put these numbers in their respective field of the credentials._
|
||||||
|
|
||||||
|
Setting up your API keys
|
||||||
|
====================
|
||||||
|
####This part is completely optional, **However it is necessary for music to work properly**
|
||||||
|
+ **GoogleAPIKey** - Required for Youtube Song Search, Playlist queuing, and URL Shortener. `~i` and `~img`.
|
||||||
|
+ You can get this api Key [here](https://console.developers.google.com/apis)
|
||||||
|
+ **SoundCloudClientID** - Required to queue soundloud songs from sc links.
|
||||||
|
+ You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud**
|
||||||
|
+ You should come to a page that looks like this 
|
||||||
|
+ Simply click Register a new application and enter a name.
|
||||||
|
+ After naming your app you will be brought to this page:  Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json`
|
||||||
|
+ **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards.
|
||||||
|
+ You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner.
|
||||||
|
+ Copy the key and paste it into `credentials.json`
|
||||||
|
+ **LOLAPIKey** - Required for all League of Legends commands.
|
||||||
|
+ You can get this key [here](http://api.champion.gg/)
|
||||||
|
+ **TrelloAppKey** - Required for the trello commands.
|
||||||
|
+ You can get this key [here](https://trello.com/app-key) **Be sure you are logged into Trello first**
|
||||||
|
+ **OsuAPIKey** - Required for Osu commands
|
||||||
|
+ You can get this key [here](https://osu.ppy.sh/p/api) **You will need to log in and like the soundcloud it may take a few tries**
|
||||||
|
+ **CarbonKey** -This key is for Carobnitex.net stats.
|
||||||
|
+ Most likely unnecessary **Needed only if your bot is listed on Carbonitex.net**
|
||||||
|
|
||||||
|
Config.json
|
||||||
|
===========
|
||||||
|
In the folder where `NadekoBot.exe` is located you should also see a `Data` folder. In this folder you will find `config.json` among other files.
|
||||||
|
`config.json` contains user specific commands, such as: if DM's sent to the bot are forwarded to you, Blacklisted Ids, Servers, and channels...etc.
|
||||||
|
|
||||||
|
**If you do not see** `config.json` **you need to rename** `config_example.json` **to** `config.json`
|
||||||
29
docs/Readme.md
Normal file
29
docs/Readme.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
##Readme for Commands List
|
||||||
|
|
||||||
|
###Bot Owner Only
|
||||||
|
|
||||||
|
- *Bot Owner Only* commands refer to the commands only the **owner** of the bot can use.
|
||||||
|
- *Bot Owner Only* commands do **not** refer to the owner of the **server**, just the owner of the **bot**.
|
||||||
|
- *Owner of the bot* is a person who is **hosting** his own bot, and his **ID** is inside of **credentials.json** file.
|
||||||
|
- You are **not** the bot **owner** if you invited the bot using **Carbonitex** or other invitation links.
|
||||||
|
|
||||||
|
###Music on the public Nadeko
|
||||||
|
|
||||||
|
- In case you got Nadeko in your server by the invitation from **Carbonitex**, our **GitHub** invite or **help (-h)**, music is disabled.
|
||||||
|
- Music is **disabled** due to large maintenance expenses, unless Kwoth is **testing** music module.
|
||||||
|
- If you want to have music module on your server, you will have to **host** the bot on your PC, or any of the external servers.
|
||||||
|
- How to **host** the bot, check the **guides** on the left side.
|
||||||
|
|
||||||
|
###NadekoFlowers
|
||||||
|
|
||||||
|
- NadekoFlowers is the **currency** of the public Nadeko.
|
||||||
|
- NadekoFlowers can be earned by playing **trivia**, or other games, like betting games.
|
||||||
|
- You can give NadekoFlowers to other users, using the command `$give X @person`.
|
||||||
|
- You can only give flowers you **own**.
|
||||||
|
- If you want to have **unlimited** number of flowers, you will have to **host** the bot.
|
||||||
|
- Command `$award X @person` can only be used by the *bot owner*.
|
||||||
|
- If you `>plant` the flower, flower will be avaliable for everyone to `>pick` it. In that case you will **lose** the flower.
|
||||||
|
|
||||||
|
###Manage Permissions
|
||||||
|
|
||||||
|
**These permissions refer to the permissions you can set in Discord settings for individual users or roles.**
|
||||||
13
docs/about.md
Normal file
13
docs/about.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
## Terms of Use
|
||||||
|
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2016 NadekoBot Team
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
@ -1,363 +0,0 @@
|
|||||||
######For more information and how to setup your own NadekoBot, go to: **http://github.com/Kwoth/NadekoBot/**
|
|
||||||
######You can donate on patreon: `https://patreon.com/nadekobot`
|
|
||||||
######or paypal: `nadekodiscordbot@gmail.com`
|
|
||||||
|
|
||||||
#NadekoBot List Of Commands
|
|
||||||
Version: `NadekoBot v0.9.6054.4837`
|
|
||||||
### Help
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`-h`, `-help`, `@BotName help`, `@BotName h`, `~h` | Either shows a help for a single command, or PMs you help link if no arguments are specified. | `-h !m q` or just `-h`
|
|
||||||
`-hgit` | Generates the commandlist.md file. **Bot Owner Only!** | `-hgit`
|
|
||||||
`-readme`, `-guide` | Sends a readme and a guide links to the channel. | `-readme` or `-guide`
|
|
||||||
`-donate`, `~donate` | Instructions for helping the project! | `{Prefix}donate` or `~donate`
|
|
||||||
`-modules`, `.modules` | List all bot modules. | `{Prefix}modules` or `.modules`
|
|
||||||
`-commands`, `.commands` | List all of the bot's commands from a certain module. | `{Prefix}commands` or `.commands`
|
|
||||||
|
|
||||||
### Administration
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`.grdel` | Toggles automatic deletion of greet and bye messages. | `.grdel`
|
|
||||||
`.greet` | Toggles anouncements on the current channel when someone joins the server. | `.greet`
|
|
||||||
`.greetmsg` | Sets a new join announcement message. Type %user% if you want to mention the new member. Using it with no message will show the current greet message. | `.greetmsg Welcome to the server, %user%.`
|
|
||||||
`.bye` | Toggles anouncements on the current channel when someone leaves the server. | `.bye`
|
|
||||||
`.byemsg` | Sets a new leave announcement message. Type %user% if you want to mention the new member. Using it with no message will show the current bye message. | `.byemsg %user% has left the server.`
|
|
||||||
`.byepm` | Toggles whether the good bye messages will be sent in a PM or in the text channel. | `.byepm`
|
|
||||||
`.greetpm` | Toggles whether the greet messages will be sent in a PM or in the text channel. | `.greetpm`
|
|
||||||
`.spmom` | Toggles whether mentions of other offline users on your server will send a pm to them. | `.spmom`
|
|
||||||
`.logserver` | Toggles logging in this channel. Logs every message sent/deleted/edited on the server. **Bot Owner Only!** | `.logserver`
|
|
||||||
`.logignore` | Toggles whether the .logserver command ignores this channel. Useful if you have hidden admin channel and public log channel. | `.logignore`
|
|
||||||
`.userpresence` | Starts logging to this channel when someone from the server goes online/offline/idle. | `.userpresence`
|
|
||||||
`.voicepresence` | Toggles logging to this channel whenever someone joins or leaves a voice channel you are in right now. | `{Prefix}voicerpresence`
|
|
||||||
`.repeatinvoke`, `.repinv` | Immediately shows the repeat message and restarts the timer. | `{Prefix}repinv`
|
|
||||||
`.repeat` | Repeat a message every X minutes. If no parameters are specified, repeat is disabled. Requires manage messages. | `.repeat 5 Hello there`
|
|
||||||
`.rotateplaying`, `.ropl` | Toggles rotation of playing status of the dynamic strings you specified earlier. | `.ropl`
|
|
||||||
`.addplaying`, `.adpl` | Adds a specified string to the list of playing strings to rotate. Supported placeholders: %servers%, %users%, %playing%, %queued%, %trivia% | `.adpl`
|
|
||||||
`.listplaying`, `.lipl` | Lists all playing statuses with their corresponding number. | `.lipl`
|
|
||||||
`.removeplaying`, `.repl`, `.rmpl` | Removes a playing string on a given number. | `.rmpl`
|
|
||||||
`.slowmode` | Toggles slow mode. When ON, users will be able to send only 1 message every 5 seconds. | `.slowmode`
|
|
||||||
`.cleanv+t`, `.cv+t` | Deletes all text channels ending in `-voice` for which voicechannels are not found. **Use at your own risk.** | `.cleanv+t`
|
|
||||||
`.voice+text`, `.v+t` | Creates a text channel for each voice channel only users in that voice channel can see.If you are server owner, keep in mind you will see them all the time regardless. | `.voice+text`
|
|
||||||
`.scsc` | Starts an instance of cross server channel. You will get a token as a DM that other people will use to tune in to the same instance. | `.scsc`
|
|
||||||
`.jcsc` | Joins current channel to an instance of cross server channel using the token. | `.jcsc`
|
|
||||||
`.lcsc` | Leaves Cross server channel instance from this channel. | `.lcsc`
|
|
||||||
`.asar` | Adds a role, or list of roles separated by whitespace(use quotations for multiword roles) to the list of self-assignable roles. | .asar Gamer
|
|
||||||
`.rsar` | Removes a specified role from the list of self-assignable roles. | `.rsar`
|
|
||||||
`.lsar` | Lists all self-assignable roles. | `.lsar`
|
|
||||||
`.togglexclsar`, `.tesar` | toggle whether the self-assigned roles should be exclusive | `.tesar`
|
|
||||||
`.iam` | Adds a role to you that you choose. Role must be on a list of self-assignable roles. | .iam Gamer
|
|
||||||
`.iamnot`, `.iamn` | Removes a role to you that you choose. Role must be on a list of self-assignable roles. | .iamn Gamer
|
|
||||||
`.addcustreact`, `.acr` | Add a custom reaction. Guide here: <https://github.com/Kwoth/NadekoBot/wiki/Custom-Reactions> **Bot Owner Only!** | `.acr "hello" I love saying hello to %user%`
|
|
||||||
`.listcustreact`, `.lcr` | Lists custom reactions (paginated with 30 commands per page). Use 'all' instead of page number to get all custom reactions DM-ed to you. | `.lcr 1`
|
|
||||||
`.showcustreact`, `.scr` | Shows all possible responses from a single custom reaction. | `.scr %mention% bb`
|
|
||||||
`.editcustreact`, `.ecr` | Edits a custom reaction, arguments are custom reactions name, index to change, and a (multiword) message **Bot Owner Only** | `.ecr "%mention% disguise" 2 Test 123`
|
|
||||||
`.delcustreact`, `.dcr` | Deletes a custom reaction with given name (and index). | `.dcr index`
|
|
||||||
`.autoassignrole`, `.aar` | Automaticaly assigns a specified role to every user who joins the server. Type `.aar` to disable, `.aar Role Name` to enable
|
|
||||||
`.leave` | Makes Nadeko leave the server. Either name or id required. | `.leave 123123123331`
|
|
||||||
`.listincidents`, `.lin` | List all UNREAD incidents and flags them as read. | `.lin`
|
|
||||||
`.listallincidents`, `.lain` | Sends you a file containing all incidents and flags them as read. | `.lain`
|
|
||||||
`.delmsgoncmd` | Toggles the automatic deletion of user's successful command message to prevent chat flood. Server Manager Only. | `.delmsgoncmd`
|
|
||||||
`.restart` | Restarts the bot. Might not work. **Bot Owner Only** | `.restart`
|
|
||||||
`.setrole`, `.sr` | Sets a role for a given user. | `.sr @User Guest`
|
|
||||||
`.removerole`, `.rr` | Removes a role from a given user. | `.rr @User Admin`
|
|
||||||
`.renamerole`, `.renr` | Renames a role. Role you are renaming must be lower than bot's highest role. | `.renr "First role" SecondRole`
|
|
||||||
`.removeallroles`, `.rar` | Removes all roles from a mentioned user. | `.rar @User`
|
|
||||||
`.createrole`, `.cr` | Creates a role with a given name. | `.cr Awesome Role`
|
|
||||||
`.rolecolor`, `.rc` | Set a role's color to the hex or 0-255 rgb color value provided. | `.rc Admin 255 200 100` or `.rc Admin ffba55`
|
|
||||||
`.ban`, `.b` | Bans a user by id or name with an optional message. | `.b "@some Guy" Your behaviour is toxic.`
|
|
||||||
`.softban`, `.sb` | Bans and then unbans a user by id or name with an optional message. | `.sb "@some Guy" Your behaviour is toxic.`
|
|
||||||
`.kick`, `.k` | Kicks a mentioned user. | `.k "@some Guy" Your behaviour is toxic.`
|
|
||||||
`.mute` | Mutes mentioned user or users. | `.mute "@Someguy"` or `.mute "@Someguy" "@Someguy"`
|
|
||||||
`.unmute` | Unmutes mentioned user or users. | `.unmute "@Someguy"` or `.unmute "@Someguy" "@Someguy"`
|
|
||||||
`.deafen`, `.deaf` | Deafens mentioned user or users | `.deaf "@Someguy"` or `.deaf "@Someguy" "@Someguy"`
|
|
||||||
`.undeafen`, `.undef` | Undeafens mentioned user or users | `.undef "@Someguy"` or `.undef "@Someguy" "@Someguy"`
|
|
||||||
`.delvoichanl`, `.dvch` | Deletes a voice channel with a given name. | `.dvch VoiceChannelName`
|
|
||||||
`.creatvoichanl`, `.cvch` | Creates a new voice channel with a given name. | `.cvch VoiceChannelName`
|
|
||||||
`.deltxtchanl`, `.dtch` | Deletes a text channel with a given name. | `.dtch TextChannelName`
|
|
||||||
`.creatxtchanl`, `.ctch` | Creates a new text channel with a given name. | `.ctch TextChannelName`
|
|
||||||
`.settopic`, `.st` | Sets a topic on the current channel. | `.st My new topic`
|
|
||||||
`.setchanlname`, `.schn` | Changed the name of the current channel.| `.schn NewName`
|
|
||||||
`.heap` | Shows allocated memory - **Bot Owner Only!** | `.heap`
|
|
||||||
`.prune`, `.clr` | `.prune` removes all nadeko's messages in the last 100 messages.`.prune X` removes last X messages from the channel (up to 100)`.prune @Someone` removes all Someone's messages in the last 100 messages.`.prune @Someone X` removes last X 'Someone's' messages in the channel. | `.prune` or `.prune 5` or `.prune @Someone` or `.prune @Someone X`
|
|
||||||
`.die` | Shuts the bot down and notifies users about the restart. **Bot Owner Only!** | `.die`
|
|
||||||
`.setname`, `.newnm` | Give the bot a new name. **Bot Owner Only!** | .newnm BotName
|
|
||||||
`.newavatar`, `.setavatar` | Sets a new avatar image for the NadekoBot. Argument is a direct link to an image. **Bot Owner Only!** | `.setavatar https://i.ytimg.com/vi/WDudkR1eTMM/maxresdefault.jpg`
|
|
||||||
`.setgame` | Sets the bots game. **Bot Owner Only!** | `.setgame Playing with kwoth`
|
|
||||||
`.send` | Send a message to someone on a different server through the bot. **Bot Owner Only!** | `.send serverid|u:user_id Send this to a user!` or `.send serverid|c:channel_id Send this to a channel!`
|
|
||||||
`.mentionrole`, `.menro` | Mentions every person from the provided role or roles (separated by a ',') on this server. Requires you to have mention everyone permission. | `.menro RoleName`
|
|
||||||
`.unstuck` | Clears the message queue. **Bot Owner Only!** | `.unstuck`
|
|
||||||
`.donators` | List of lovely people who donated to keep this project alive.
|
|
||||||
`.donadd` | Add a donator to the database. | `.donadd Donate Amount`
|
|
||||||
`.announce` | Sends a message to all servers' general channel bot is connected to.**Bot Owner Only!** | `.announce Useless spam`
|
|
||||||
`.savechat` | Saves a number of messages to a text file and sends it to you. **Bot Owner Only** | `.savechat 150`
|
|
||||||
|
|
||||||
### Utility
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`.remind` | Sends a message to you or a channel after certain amount of time. First argument is me/here/'channelname'. Second argument is time in a descending order (mo>w>d>h>m) example: 1w5d3h10m. Third argument is a (multiword)message. | `.remind me 1d5h Do something` or `.remind #general Start now!`
|
|
||||||
`.remindmsg` | Sets message for when the remind is triggered. Available placeholders are %user% - user who ran the command, %message% - Message specified in the remind, %target% - target channel of the remind. **Bot Owner Only!** | `.remindmsg do something else`
|
|
||||||
`.serverinfo`, `.sinfo` | Shows info about the server the bot is on. If no channel is supplied, it defaults to current one. | `.sinfo Some Server`
|
|
||||||
`.channelinfo`, `.cinfo` | Shows info about the channel. If no channel is supplied, it defaults to current one. | `.cinfo #some-channel`
|
|
||||||
`.userinfo`, `.uinfo` | Shows info about the user. If no user is supplied, it defaults a user running the command. | `.uinfo @SomeUser`
|
|
||||||
`.whoplays` | Shows a list of users who are playing the specified game. | `.whoplays Overwatch`
|
|
||||||
`.inrole` | Lists every person from the provided role or roles (separated by a ',') on this server. If the list is too long for 1 message, you must have Manage Messages permission. | `.inrole Role`
|
|
||||||
`.checkmyperms` | Checks your userspecific permissions on this channel. | `.checkmyperms`
|
|
||||||
`.stats` | Shows some basic stats for Nadeko. | `.stats`
|
|
||||||
`.dysyd` | Shows some basic stats for Nadeko. | `.dysyd`
|
|
||||||
`.userid`, `.uid` | Shows user ID. | `.uid` or `.uid "@SomeGuy"`
|
|
||||||
`.channelid`, `.cid` | Shows current channel ID. | `.cid`
|
|
||||||
`.serverid`, `.sid` | Shows current server ID. | `.sid`
|
|
||||||
`.roles` | List all roles on this server or a single user if specified.
|
|
||||||
`.channeltopic`, `.ct` | Sends current channel's topic as a message. | `.ct`
|
|
||||||
|
|
||||||
### Permissions
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`;chnlfilterinv`, `;cfi` | Enables or disables automatic deleting of invites on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once. | ;cfi enable #general-chat
|
|
||||||
`;srvrfilterinv`, `;sfi` | Enables or disables automatic deleting of invites on the server. | ;sfi disable
|
|
||||||
`;chnlfilterwords`, `;cfw` | Enables or disables automatic deleting of messages containing banned words on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once. | ;cfw enable #general-chat
|
|
||||||
`;addfilterword`, `;afw` | Adds a new word to the list of filtered words | ;afw poop
|
|
||||||
`;rmvfilterword`, `;rfw` | Removes the word from the list of filtered words | ;rw poop
|
|
||||||
`;lstfilterwords`, `;lfw` | Shows a list of filtered words | ;lfw
|
|
||||||
`;srvrfilterwords`, `;sfw` | Enables or disables automatic deleting of messages containing forbidden words on the server. | ;sfw disable
|
|
||||||
`;permrole`, `;pr` | Sets a role which can change permissions. Or supply no parameters to find out the current one. Default one is 'Nadeko'. | `;pr role`
|
|
||||||
`;rolepermscopy`, `;rpc` | Copies BOT PERMISSIONS (not discord permissions) from one role to another. | `;rpc Some Role ~ Some other role`
|
|
||||||
`;chnlpermscopy`, `;cpc` | Copies BOT PERMISSIONS (not discord permissions) from one channel to another. | `;cpc Some Channel ~ Some other channel`
|
|
||||||
`;usrpermscopy`, `;upc` | Copies BOT PERMISSIONS (not discord permissions) from one role to another. | `;upc @SomeUser ~ @SomeOtherUser`
|
|
||||||
`;verbose`, `;v` | Sets whether to show when a command/module is blocked. | `;verbose true`
|
|
||||||
`;srvrperms`, `;sp` | Shows banned permissions for this server. | `;sp`
|
|
||||||
`;roleperms`, `;rp` | Shows banned permissions for a certain role. No argument means for everyone. | `;rp AwesomeRole`
|
|
||||||
`;chnlperms`, `;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`
|
|
||||||
`;srvrmdl`, `;sm` | Sets a module's permission at the server level. | `;sm "module name" enable`
|
|
||||||
`;srvrcmd`, `;sc` | Sets a command's permission at the server level. | `;sc "command name" disable`
|
|
||||||
`;rolemdl`, `;rm` | Sets a module's permission at the role level. | `;rm "module name" enable MyRole`
|
|
||||||
`;rolecmd`, `;rc` | Sets a command's permission at the role level. | `;rc "command name" disable MyRole`
|
|
||||||
`;chnlmdl`, `;cm` | Sets a module's permission at the channel level. | `;cm "module name" enable SomeChannel`
|
|
||||||
`;chnlcmd`, `;cc` | Sets a command's permission at the channel level. | `;cc "command name" enable SomeChannel`
|
|
||||||
`;usrmdl`, `;um` | Sets a module's permission at the user level. | `;um "module name" enable SomeUsername`
|
|
||||||
`;usrcmd`, `;uc` | Sets a command's permission at the user level. | `;uc "command name" enable SomeUsername`
|
|
||||||
`;allsrvrmdls`, `;asm` | Sets permissions for all modules at the server level. | `;asm [enable/disable]`
|
|
||||||
`;allsrvrcmds`, `;asc` | Sets permissions for all commands from a certain module at the server level. | `;asc "module name" [enable/disable]`
|
|
||||||
`;allchnlmdls`, `;acm` | Sets permissions for all modules at the channel level. | `;acm [enable/disable] SomeChannel`
|
|
||||||
`;allchnlcmds`, `;acc` | Sets permissions for all commands from a certain module at the channel level. | `;acc "module name" [enable/disable] SomeChannel`
|
|
||||||
`;allrolemdls`, `;arm` | Sets permissions for all modules at the role level. | `;arm [enable/disable] MyRole`
|
|
||||||
`;allrolecmds`, `;arc` | Sets permissions for all commands from a certain module at the role level. | `;arc "module name" [enable/disable] MyRole`
|
|
||||||
`;ubl` | Blacklists a mentioned user. | `;ubl [user_mention]`
|
|
||||||
`;uubl` | Unblacklists a mentioned user. | `;uubl [user_mention]`
|
|
||||||
`;cbl` | Blacklists a mentioned channel (#general for example). | `;cbl #some_channel`
|
|
||||||
`;cubl` | Unblacklists a mentioned channel (#general for example). | `;cubl #some_channel`
|
|
||||||
`;sbl` | Blacklists a server by a name or id (#general for example). **BOT OWNER ONLY** | `;sbl [servername/serverid]`
|
|
||||||
`;cmdcooldown`, `;cmdcd` | Sets a cooldown per user for a command. Set 0 to clear. | `;cmdcd "some cmd" 5`
|
|
||||||
`;allcmdcooldowns`, `;acmdcds` | Shows a list of all commands and their respective cooldowns.
|
|
||||||
|
|
||||||
### Conversations
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`..` | Adds a new quote with the specified name (single word) and message (no limit). | `.. abc My message`
|
|
||||||
`...` | Shows a random quote with a specified name. | `... abc`
|
|
||||||
`..qdel`, `..quotedelete` | Deletes all quotes with the specified keyword. You have to either be bot owner or the creator of the quote to delete it. | `..qdel abc`
|
|
||||||
`@BotName rip` | Shows a grave image of someone with a start year | @NadekoBot rip @Someone 2000
|
|
||||||
`@BotName die` | Works only for the owner. Shuts the bot down. | `@NadekoBot die`
|
|
||||||
`@BotName do you love me` | Replies with positive answer only to the bot owner. | `@NadekoBot do you love me`
|
|
||||||
`@BotName how are you`, `@BotName how are you?` | Replies positive only if bot owner is online. | `@NadekoBot how are you`
|
|
||||||
`@BotName fire` | Shows a unicode fire message. Optional parameter [x] tells her how many times to repeat the fire. | `@NadekoBot fire [x]`
|
|
||||||
`@BotName dump` | Dumps all of the invites it can to dump.txt.** Owner Only.** | `@NadekoBot dump`
|
|
||||||
`@BotName ab` | Try to get 'abalabahaha'| `@NadekoBot ab`
|
|
||||||
|
|
||||||
### Gambling
|
|
||||||
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]`
|
|
||||||
`$shuffle`, `$sh` | Reshuffles all cards back into the deck.|`$shuffle`
|
|
||||||
`$flip` | Flips coin(s) - heads or tails, and shows an image. | `$flip` or `$flip 3`
|
|
||||||
`$betflip`, `$bf` | Bet to guess will the result be heads or tails. Guessing award you double flowers you've bet. | `$bf 5 heads` or `$bf 3 t`
|
|
||||||
`$roll` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y. | `$roll` or `$roll 7` or `$roll 3d5`
|
|
||||||
`$rolluo` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice (unordered). If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y. | `$roll` or `$roll` 7 or `$roll 3d5`
|
|
||||||
`$nroll` | Rolls in a given range. | `$nroll 5` (rolls 0-5) or `$nroll 5-15`
|
|
||||||
`$race` | Starts a new animal race. | `$race`
|
|
||||||
`$joinrace`, `$jr` | Joins a new race. You can specify an amount of flowers for betting (optional). You will get YourBet*(participants-1) back if you win. | `$jr` or `$jr 5`
|
|
||||||
`$raffle` | Prints a name and ID of a random user from the online list from the (optional) role. | `$raffle` or `$raffle RoleName`
|
|
||||||
`$$$` | Check how much NadekoFlowers a person has. (Defaults to yourself) | `$$$` or `$$$ @Someone`
|
|
||||||
`$give` | Give someone a certain amount of NadekoFlowers|`$give 1 "@SomeGuy"`
|
|
||||||
`$award` | Gives someone a certain amount of flowers. **Bot Owner Only!** | `$award 100 @person`
|
|
||||||
`$take` | Takes a certain amount of flowers from someone. **Bot Owner Only!** | `$take 1 "@someguy"`
|
|
||||||
`$betroll`, `$br` | Bets a certain amount of NadekoFlowers and rolls a dice. Rolling over 66 yields x2 flowers, over 90 - x3 and 100 x10. | `$br 5`
|
|
||||||
`$leaderboard`, `$lb` | Displays bot currency leaderboard | $lb
|
|
||||||
|
|
||||||
### Games
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`>t` | Starts a game of trivia. You can add nohint to prevent hints.First player to get to 10 points wins by default. You can specify a different number. 30 seconds per question. | `>t nohint` or `>t 5 nohint`
|
|
||||||
`>tl` | Shows a current trivia leaderboard. | `>tl`
|
|
||||||
`>tq` | Quits current trivia after current question. | `>tq`
|
|
||||||
`>typestart` | Starts a typing contest. | `>typestart`
|
|
||||||
`>typestop` | Stops a typing contest on the current channel. | `>typestop`
|
|
||||||
`>typeadd` | Adds a new article to the typing contest. Owner only. | `>typeadd wordswords`
|
|
||||||
`>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. | `>pollend`
|
|
||||||
`>pick` | Picks a flower planted in this channel. | `>pick`
|
|
||||||
`>plant` | Spend a flower to plant it in this channel. (If bot is restarted or crashes, flower will be lost) | `>plant`
|
|
||||||
`>gencurrency`, `>gc` | Toggles currency generation on this channel. Every posted message will have 2% chance to spawn a NadekoFlower. Optional parameter cooldown time in minutes, 5 minutes by default. Requires Manage Messages permission. | `>gc` or `>gc 60`
|
|
||||||
`>leet` | Converts a text to leetspeak with 6 (1-6) severity levels | `>leet 3 Hello`
|
|
||||||
`>choose` | Chooses a thing from a list of things | `>choose Get up;Sleep;Sleep more`
|
|
||||||
`>8ball` | Ask the 8ball a yes/no question. | `>8ball should i do something`
|
|
||||||
`>rps` | Play a game of rocket paperclip scissors with Nadeko. | `>rps scissors`
|
|
||||||
`>linux` | Prints a customizable Linux interjection | `>linux Spyware Windows`
|
|
||||||
|
|
||||||
### Music
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`!!next`, `!!n`, `!!skip` | Goes to the next song in the queue. You have to be in the same voice channel as the bot. | `!!n`
|
|
||||||
`!!stop`, `!!s` | Stops the music and clears the playlist. Stays in the channel. | `!!s`
|
|
||||||
`!!destroy`, `!!d` | Completely stops the music and unbinds the bot from the channel. (may cause weird behaviour) | `!!d`
|
|
||||||
`!!pause`, `!!p` | Pauses or Unpauses the song. | `!!p`
|
|
||||||
`!!queue`, `!!q`, `!!yq` | Queue a song using keywords or a link. Bot will join your voice channel.**You must be in a voice channel**. | `!!q Dream Of Venice`
|
|
||||||
`!!soundcloudqueue`, `!!sq` | Queue a soundcloud song using keywords. Bot will join your voice channel.**You must be in a voice channel**. | `!!sq Dream Of Venice`
|
|
||||||
`!!listqueue`, `!!lq` | Lists 15 currently queued songs per page. Default page is 1. | `!!lq` or `!!lq 2`
|
|
||||||
`!!nowplaying`, `!!np` | Shows the song currently playing. | `!!np`
|
|
||||||
`!!volume`, `!!vol` | Sets the music volume 0-100% | `!!vol 50`
|
|
||||||
`!!defvol`, `!!dv` | Sets the default music volume when music playback is started (0-100). Persists through restarts. | `!!dv 80`
|
|
||||||
`!!mute`, `!!min` | Sets the music volume to 0% | `!!min`
|
|
||||||
`!!max` | Sets the music volume to 100%. | `!!max`
|
|
||||||
`!!half` | Sets the music volume to 50%. | `!!half`
|
|
||||||
`!!shuffle`, `!!sh` | Shuffles the current playlist. | `!!sh`
|
|
||||||
`!!playlist`, `!!pl` | Queues up to 500 songs from a youtube playlist specified by a link, or keywords. | `!!pl playlist link or name`
|
|
||||||
`!!soundcloudpl`, `!!scpl` | Queue a soundcloud playlist using a link. | `!!scpl https://soundcloud.com/saratology/sets/symphony`
|
|
||||||
`!!localplaylst`, `!!lopl` | Queues all songs from a directory. **Bot Owner Only!** | `!!lopl C:/music/classical`
|
|
||||||
`!!radio`, `!!ra` | Queues a radio stream from a link. It can be a direct mp3 radio stream, .m3u, .pls .asx or .xspf (Usage Video: <https://streamable.com/al54>) | `!!ra radio link here`
|
|
||||||
`!!local`, `!!lo` | Queues a local file by specifying a full path. **Bot Owner Only!** | `!!lo C:/music/mysong.mp3`
|
|
||||||
`!!move`, `!!mv` | Moves the bot to your voice channel. (works only if music is already playing) | `!!mv`
|
|
||||||
`!!remove`, `!!rm` | Remove a song by its # in the queue, or 'all' to remove whole queue. | `!!rm 5`
|
|
||||||
`!!movesong`, `!!ms` | Moves a song from one position to another. | `!! ms` 5>3
|
|
||||||
`!!setmaxqueue`, `!!smq` | Sets a maximum queue size. Supply 0 or no argument to have no limit. | `!!smq` 50 or `!!smq`
|
|
||||||
`!!cleanup` | Cleans up hanging voice connections. **Bot Owner Only!** | `!!cleanup`
|
|
||||||
`!!reptcursong`, `!!rcs` | Toggles repeat of current song. | `!!rcs`
|
|
||||||
`!!rpeatplaylst`, `!!rpl` | Toggles repeat of all songs in the queue (every song that finishes is added to the end of the queue). | `!!rpl`
|
|
||||||
`!!save` | Saves a playlist under a certain name. Name must be no longer than 20 characters and mustn't contain dashes. | `!!save classical1`
|
|
||||||
`!!load` | Loads a playlist under a certain name. | `!!load classical-1`
|
|
||||||
`!!playlists`, `!!pls` | Lists all playlists. Paginated. 20 per page. Default page is 0. | `!!pls 1`
|
|
||||||
`!!deleteplaylist`, `!!delpls` | Deletes a saved playlist. Only if you made it or if you are the bot owner. | `!!delpls animu-5`
|
|
||||||
`!!goto` | Goes to a specific time in seconds in a song. | `!!goto 30`
|
|
||||||
`!!getlink`, `!!gl` | Shows a link to the currently playing song.
|
|
||||||
`!!autoplay`, `!!ap` | Toggles autoplay - When the song is finished, automatically queue a related youtube song. (Works only for youtube songs and when queue is empty)
|
|
||||||
|
|
||||||
### Searches
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`~lolchamp` | Shows League Of Legends champion statistics. If there are spaces/apostrophes or in the name - omit them. Optional second parameter is a role. | `~lolchamp Riven` or `~lolchamp Annie sup`
|
|
||||||
`~lolban` | Shows top 6 banned champions ordered by ban rate. Ban these champions and you will be Plat 5 in no time. | `~lolban`
|
|
||||||
`~hitbox`, `~hb` | Notifies this channel when a certain user starts streaming. | `~hitbox SomeStreamer`
|
|
||||||
`~twitch`, `~tw` | Notifies this channel when a certain user starts streaming. | `~twitch SomeStreamer`
|
|
||||||
`~beam`, `~bm` | Notifies this channel when a certain user starts streaming. | `~beam SomeStreamer`
|
|
||||||
`~checkhitbox`, `~chhb` | Checks if a certain user is streaming on the hitbox platform. | `~chhb SomeStreamer`
|
|
||||||
`~checktwitch`, `~chtw` | Checks if a certain user is streaming on the twitch platform. | `~chtw SomeStreamer`
|
|
||||||
`~checkbeam`, `~chbm` | Checks if a certain user is streaming on the beam platform. | `~chbm SomeStreamer`
|
|
||||||
`~removestream`, `~rms` | Removes notifications of a certain streamer on this channel. | `~rms SomeGuy`
|
|
||||||
`~liststreams`, `~ls` | Lists all streams you are following on this server. | `~ls`
|
|
||||||
`~convert` | Convert quantities from>to. | `~convert m>km 1000`
|
|
||||||
`~convertlist` | List of the convertable dimensions and currencies.
|
|
||||||
`~wowjoke` | Get one of Kwoth's penultimate WoW jokes. | `~wowjoke`
|
|
||||||
`~calculate`, `~calc` | Evaluate a mathematical expression. | ~calc 1+1
|
|
||||||
`~osu` | Shows osu stats for a player. | `~osu Name` or `~osu Name taiko`
|
|
||||||
`~osu b` | Shows information about an osu beatmap. | `~osu b` https://osu.ppy.sh/s/127712`
|
|
||||||
`~osu top5` | Displays a user's top 5 plays. | ~osu top5 Name
|
|
||||||
`~pokemon`, `~poke` | Searches for a pokemon. | `~poke Sylveon`
|
|
||||||
`~pokemonability`, `~pokeab` | Searches for a pokemon ability. | `~pokeab "water gun"`
|
|
||||||
`~memelist` | Pulls a list of memes you can use with `~memegen` from http://memegen.link/templates/ | `~memelist`
|
|
||||||
`~memegen` | Generates a meme from memelist with top and bottom text. | `~memegen biw "gets iced coffee" "in the winter"`
|
|
||||||
`~we` | Shows weather data for a specified city and a country. BOTH ARE REQUIRED. Use country abbrevations. | `~we Moscow RF`
|
|
||||||
`~yt` | Searches youtubes and shows the first result | `~yt query`
|
|
||||||
`~ani`, `~anime`, `~aq` | Queries anilist for an anime and shows the first result. | `~aq aquerion evol`
|
|
||||||
`~imdb` | Queries imdb for movies or series, show first result. | `~imdb query`
|
|
||||||
`~mang`, `~manga`, `~mq` | Queries anilist for a manga and shows the first result. | `~mq query`
|
|
||||||
`~randomcat`, `~meow` | Shows a random cat image.
|
|
||||||
`~randomdog`, `~woof` | Shows a random dog image.
|
|
||||||
`~i` | Pulls the first image found 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` | Google something for an idiot. | `~lmgtfy query`
|
|
||||||
`~google`, `~g` | Get a google search link for some terms. | `~google query`
|
|
||||||
`~hs` | Searches for a Hearthstone card and shows its image. Takes a while to complete. | `~hs Ysera`
|
|
||||||
`~ud` | Searches Urban Dictionary for a word. | `~ud Pineapple`
|
|
||||||
`~#` | Searches Tagdef.com for a hashtag. | `~# ff`
|
|
||||||
`~quote` | Shows a random quote. | `~quote`
|
|
||||||
`~catfact` | Shows a random catfact from <http://catfacts-api.appspot.com/api/facts> | `~catfact`
|
|
||||||
`~yomama`, `~ym` | Shows a random joke from <http://api.yomomma.info/> | `~ym`
|
|
||||||
`~randjoke`, `~rj` | Shows a random joke from <http://tambal.azurewebsites.net/joke/random> | `~rj`
|
|
||||||
`~chucknorris`, `~cn` | Shows a random chucknorris joke from <http://tambal.azurewebsites.net/joke/random> | `~cn`
|
|
||||||
`~magicitem`, `~mi` | Shows a random magicitem from <https://1d4chan.org/wiki/List_of_/tg/%27s_magic_items> | `~mi`
|
|
||||||
`~revav` | Returns a google reverse image search for someone's avatar. | `~revav "@SomeGuy"`
|
|
||||||
`~revimg` | Returns a google reverse image search for an image from a link. | `~revav Image link`
|
|
||||||
`~safebooru` | Shows a random image from safebooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~safebooru yuri+kissing`
|
|
||||||
`~wiki` | Gives you back a wikipedia link | `~wiki query`
|
|
||||||
`~clr` | Shows you what color corresponds to that hex. | `~clr 00ff00`
|
|
||||||
`~videocall` | Creates a private <http://www.appear.in> video call link for you and other mentioned people. The link is sent to mentioned people via a private message. | `~videocall "@SomeGuy"`
|
|
||||||
`~av`, `~avatar` | Shows a mentioned person's avatar. | `~av @X`
|
|
||||||
|
|
||||||
### 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. (multiple tags are appended with +) | `~hentai yuri+kissing`
|
|
||||||
`~danbooru` | Shows a random hentai image from danbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~danbooru yuri+kissing`
|
|
||||||
`~gelbooru` | Shows a random hentai image from gelbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~gelbooru yuri+kissing`
|
|
||||||
`~rule34` | Shows a random image from rule34.xx with a given tag. Tag is optional but preffered. (multiple tags are appended with +) | `~rule34 yuri+kissing`
|
|
||||||
`~e621` | Shows a random hentai image from e621.net with a given tag. Tag is optional but preffered. Use spaces for multiple tags. | `~e621 yuri kissing`
|
|
||||||
`~cp` | We all know where this will lead you to. | `~cp`
|
|
||||||
`~boobs` | Real adult content. | `~boobs`
|
|
||||||
`~butts`, `~ass`, `~butt` | Real adult content. | `~butts` or `~ass`
|
|
||||||
|
|
||||||
### ClashOfClans
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`,createwar`, `,cw` | Creates a new war by specifying a size (>10 and multiple of 5) and enemy clan name. | ,cw 15 The Enemy Clan
|
|
||||||
`,startwar`, `,sw` | Starts a war with a given number.
|
|
||||||
`,listwar`, `,lw` | Shows the active war claims by a number. Shows all wars in a short way if no number is specified. | ,lw [war_number] or ,lw
|
|
||||||
`,claim`, `,call`, `,c` | Claims a certain base from a certain war. You can supply a name in the third optional argument to claim in someone else's place. | ,call [war_number] [base_number] [optional_other_name]
|
|
||||||
`,claimfinish`, `,cf`, `,cf3`, `,claimfinish3` | Finish your claim with 3 stars if you destroyed a base. Optional second argument finishes for someone else. | ,cf [war_number] [optional_other_name]
|
|
||||||
`,claimfinish2`, `,cf2` | Finish your claim with 2 stars if you destroyed a base. Optional second argument finishes for someone else. | ,cf [war_number] [optional_other_name]
|
|
||||||
`,claimfinish1`, `,cf1` | Finish your claim with 1 stars if you destroyed a base. Optional second argument finishes for someone else. | ,cf [war_number] [optional_other_name]
|
|
||||||
`,unclaim`, `,uncall`, `,uc` | Removes your claim from a certain war. Optional second argument denotes a person in whose place to unclaim | ,uc [war_number] [optional_other_name]
|
|
||||||
`,endwar`, `,ew` | Ends the war with a given index. | ,ew [war_number]
|
|
||||||
|
|
||||||
### Pokegame
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`>attack` | Attacks a target with the given move. Use `>movelist` to see a list of moves your type can use. | `>attack "vine whip" @someguy`
|
|
||||||
`>movelist`, `>ml` | Lists the moves you are able to use | `>ml`
|
|
||||||
`>heal` | Heals someone. Revives those who fainted. Costs a NadekoFlower | `>heal @someone`
|
|
||||||
`>type` | Get the poketype of the target. | `>type @someone`
|
|
||||||
`>settype` | Set your poketype. Costs a NadekoFlower. | `>settype fire`
|
|
||||||
|
|
||||||
### Translator
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`~translate`, `~trans` | Translates from>to text. From the given language to the destiation language. | `~trans en>fr Hello`
|
|
||||||
`~translangs` | List the valid languages for translation. | `{Prefix}translangs` or `{Prefix}translangs language`
|
|
||||||
|
|
||||||
### Customreactions
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`\o\` | Custom reaction. | \o\
|
|
||||||
`/o/` | Custom reaction. | /o/
|
|
||||||
`moveto` | Custom reaction. | moveto
|
|
||||||
`comeatmebro` | Custom reaction. | comeatmebro
|
|
||||||
`e` | Custom reaction. | e
|
|
||||||
`@BotName insult`, `<@!116275390695079945> insult` | Custom reaction. | %mention% insult
|
|
||||||
`@BotName praise`, `<@!116275390695079945> praise` | Custom reaction. | %mention% praise
|
|
||||||
`@BotName pat`, `<@!116275390695079945> pat` | Custom reaction. | %mention% pat
|
|
||||||
`@BotName cry`, `<@!116275390695079945> cry` | Custom reaction. | %mention% cry
|
|
||||||
`@BotName are you real?`, `<@!116275390695079945> are you real?` | Custom reaction. | %mention% are you real?
|
|
||||||
`@BotName are you there?`, `<@!116275390695079945> are you there?` | Custom reaction. | %mention% are you there?
|
|
||||||
`@BotName draw`, `<@!116275390695079945> draw` | Custom reaction. | %mention% draw
|
|
||||||
`@BotName bb`, `<@!116275390695079945> bb` | Custom reaction. | %mention% bb
|
|
||||||
`@BotName call`, `<@!116275390695079945> call` | Custom reaction. | %mention% call
|
|
||||||
`@BotName disguise`, `<@!116275390695079945> disguise` | Custom reaction. | %mention% disguise
|
|
||||||
`~hentai` | Custom reaction. | ~hentai
|
|
||||||
|
|
||||||
### Trello
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`trello bind` | Bind a trello bot to a single channel. You will receive notifications from your board when something is added or edited. | `trello bind [board_id]`
|
|
||||||
`trello unbind` | Unbinds a bot from the channel and board.
|
|
||||||
`trello lists`, `trello list` | Lists all lists yo ;)
|
|
||||||
`trello cards` | Lists all cards from the supplied list. You can supply either a name or an index. | `trello cards index`
|
|
||||||
@ -1,311 +0,0 @@
|
|||||||
|
|
||||||
### Permissions
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`;verbose` `;v` | `;verbose true` | Sets whether to show when a command/module is blocked.
|
|
||||||
`;permrole` `;pr` | `;pr role` | Sets a role which can change permissions. Or supply no parameters to find out the current one. Default one is 'Nadeko'.
|
|
||||||
`;listperms` `;lp` | `;lp` or `;lp 3` | Lists whole permission chain with their indexes. You can specify optional page number if there are a lot of permissions
|
|
||||||
`;removeperm` `;rp` | `;rp 1` | Removes a permission from a given position
|
|
||||||
`;moveperm` `;mp` | `;mp 2 4` | Moves permission from one position to another.
|
|
||||||
`;srvrcmd` `;sc` | `;sc "command name" disable` | Sets a command's permission at the server level.
|
|
||||||
`;srvrmdl` `;sm` | `;sm "module name" enable` | Sets a module's permission at the server level.
|
|
||||||
`;usrcmd` `;uc` | `;uc "command name" enable SomeUsername` | Sets a command's permission at the user level.
|
|
||||||
`;usrmdl` `;um` | `;um "module name" enable SomeUsername` | Sets a module's permission at the user level.
|
|
||||||
`;rolecmd` `;rc` | `;rc "command name" disable MyRole` | Sets a command's permission at the role level.
|
|
||||||
`;rolemdl` `;rm` | `;rm "module name" enable MyRole` | Sets a module's permission at the role level.
|
|
||||||
`;chnlcmd` `;cc` | `;cc "command name" enable SomeChannel` | Sets a command's permission at the channel level.
|
|
||||||
`;chnlmdl` `;cm` | `;cm "module name" enable SomeChannel` | Sets a module's permission at the channel level.
|
|
||||||
`;allchnlmdls` `;acm` | `;acm enable #SomeChannel` | Enable or disable all modules in a specified channel.
|
|
||||||
`;allrolemdls` `;arm` | `;arm [enable/disable] MyRole` | Enable or disable all modules for a specific role.
|
|
||||||
`;allusrmdls` `;aum` | `;aum enable @someone` | Enable or disable all modules for a specific user.
|
|
||||||
`;allsrvrmdls` `;asm` | `;asm [enable/disable]` | Enable or disable all modules for your server.
|
|
||||||
`;ubl` | `;ubl add @SomeUser` or `;ubl rem 12312312313` | Either [add]s or [rem]oves a user specified by a mention or ID from a blacklist. **Bot owner only.**
|
|
||||||
`;ubl` | `;ubl add @SomeUser` or `;ubl rem 12312312313` | Either [add]s or [rem]oves a user specified by a mention or ID from a blacklist. **Bot owner only.**
|
|
||||||
`;cbl` | `;cbl rem 12312312312` | Either [add]s or [rem]oves a channel specified by an ID from a blacklist. **Bot owner only.**
|
|
||||||
`;sbl` | `;sbl add 12312321312` or `;sbl rem SomeTrashServer` | Either [add]s or [rem]oves a server specified by a Name or ID from a blacklist. **Bot owner only.**
|
|
||||||
`;sbl` | `;sbl add 12312321312` or `;sbl rem SomeTrashServer` | Either [add]s or [rem]oves a server specified by a Name or ID from a blacklist. **Bot owner only.**
|
|
||||||
`;cmdcooldown` `;cmdcd` | `;cmdcd "some cmd" 5` | Sets a cooldown per user for a command. Set 0 to clear.
|
|
||||||
`;allcmdcooldowns` `;acmdcds` | `;acmdcds` | Shows a list of all commands and their respective cooldowns.
|
|
||||||
`;srvrfilterinv` `;sfi` | `;sfi disable` | Enables or disables automatic deleting of invites on the server.
|
|
||||||
`;chnlfilterinv` `;cfi` | `;cfi enable #general-chat` | Enables or disables automatic deleting of invites on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once.
|
|
||||||
`;srvrfilterwords` `;sfw` | `;sfw disable` | Enables or disables automatic deleting of messages containing forbidden words on the server.
|
|
||||||
`;chnlfilterwords` `;cfw` | `;cfw enable #general-chat` | Enables or disables automatic deleting of messages containing banned words on the channel.If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once.
|
|
||||||
`;fw` | `;fw poop` | Adds or removes (if it exists) a word from the list of filtered words
|
|
||||||
`;lstfilterwords` `;lfw` | `;lfw` | Shows a list of filtered words
|
|
||||||
|
|
||||||
### Gambling
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`$raffle` | `$raffle` or `$raffle RoleName` | Prints a name and ID of a random user from the online list from the (optional) role.
|
|
||||||
`$cash` `$$$` | `$$$` or `$$$ @SomeGuy` | Check how much NadekoFlowers a person has. (Defaults to yourself)
|
|
||||||
`$cash` `$$$` | `$$$` or `$$$ @SomeGuy` | Check how much NadekoFlowers a person has. (Defaults to yourself)
|
|
||||||
`$give` | `$give 1 "@SomeGuy"` | Give someone a certain amount of NadekoFlowers
|
|
||||||
`$award` | `$award 100 @person` | Gives someone a certain amount of flowers. **Bot owner only.**
|
|
||||||
`$award` | `$award 100 @person` | Gives someone a certain amount of flowers. **Bot owner only.**
|
|
||||||
`$take` | `$take 1 "@someguy"` | Takes a certain amount of flowers from someone. **Bot owner only.**
|
|
||||||
`$take` | `$take 1 "@someguy"` | Takes a certain amount of flowers from someone. **Bot owner only.**
|
|
||||||
`$betroll` `$br` | `$br 5` | Bets a certain amount of NadekoFlowers and rolls a dice. Rolling over 66 yields x2 flowers, over 90 - x3 and 100 x10.
|
|
||||||
`$leaderboard` `$lb` | `$lb` | Displays bot currency leaderboard
|
|
||||||
`$race` | `$race` | Starts a new animal race.
|
|
||||||
`$joinrace` `$jr` | `$jr` or `$jr 5` | Joins a new race. You can specify an amount of flowers for betting (optional). You will get YourBet*(participants-1) back if you win.
|
|
||||||
`$roll` | `$roll` or `$roll 7` or `$roll 3d5` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y.
|
|
||||||
`$roll` | `$roll` or `$roll 7` or `$roll 3d5` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y.
|
|
||||||
`$roll` | `$roll` or `$roll 7` or `$roll 3d5` | Rolls 0-100. If you supply a number [x] it rolls up to 30 normal dice. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y.
|
|
||||||
`$rolluo` | `$rolluo` or `$rolluo 7` or `$rolluo 3d5` | Rolls X normal dice (up to 30) unordered. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y.
|
|
||||||
`$rolluo` | `$rolluo` or `$rolluo 7` or `$rolluo 3d5` | Rolls X normal dice (up to 30) unordered. If you split 2 numbers with letter d (xdy) it will roll x dice from 1 to y.
|
|
||||||
`$nroll` | `$nroll 5` (rolls 0-5) or `$nroll 5-15` | Rolls in a given range.
|
|
||||||
`$draw` | `$draw` or `$draw 5` | Draws a card from the deck.If you supply number X, she draws up to 5 cards from the deck.
|
|
||||||
`$shuffle` `$sh` | `$sh` | Reshuffles all cards back into the deck.
|
|
||||||
`$flip` | `$flip` or `$flip 3` | Flips coin(s) - heads or tails, and shows an image.
|
|
||||||
`$betflip` `$bf` | `$bf 5 heads` or `$bf 3 t` | Bet to guess will the result be heads or tails. Guessing award you double flowers you've bet.
|
|
||||||
|
|
||||||
### ClashOfClans
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`,createwar` `,cw` | `,cw 15 The Enemy Clan` | Creates a new war by specifying a size (>10 and multiple of 5) and enemy clan name.
|
|
||||||
`,startwar` `,sw` | `,sw 15` | Starts a war with a given number.
|
|
||||||
`,listwar` `,lw` | `,lw [war_number] or ,lw` | Shows the active war claims by a number. Shows all wars in a short way if no number is specified.
|
|
||||||
`,claim` `,call` `,c` | `,call [war_number] [base_number] [optional_other_name]` | Claims a certain base from a certain war. You can supply a name in the third optional argument to claim in someone else's place.
|
|
||||||
`,claimfinish1` `,cf1` | `,cf [war_number] [optional_other_name]` | Finish your claim with 1 stars if you destroyed a base. Optional second argument finishes for someone else.
|
|
||||||
`,claimfinish2` `,cf2` | `,cf [war_number] [optional_other_name]` | Finish your claim with 2 stars if you destroyed a base. Optional second argument finishes for someone else.
|
|
||||||
`,claimfinish` `,cf` `,cf3` `,claimfinish3` | `,cf [war_number] [optional_other_name]` | Finish your claim with 3 stars if you destroyed a base. Optional second argument finishes for someone else.
|
|
||||||
`,endwar` `,ew` | `,ew [war_number]` | Ends the war with a given index.
|
|
||||||
`,unclaim` `,ucall` `,uc` | `,uc [war_number] [optional_other_name]` | Removes your claim from a certain war. Optional second argument denotes a person in whose place to unclaim
|
|
||||||
|
|
||||||
### Games
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`>choose` | `>choose Get up;Sleep;Sleep more` | Chooses a thing from a list of things
|
|
||||||
`>8ball` | `>8ball should i do something` | Ask the 8ball a yes/no question.
|
|
||||||
`>rps` | `>rps scissors` | Play a game of rocket paperclip scissors with Nadeko.
|
|
||||||
`>linux` | `>linux Spyware Windows` | Prints a customizable Linux interjection
|
|
||||||
`>leet` | `>leet 3 Hello` | Converts a text to leetspeak with 6 (1-6) severity levels
|
|
||||||
`>poll` | `>poll Question?;Answer1;Answ 2;A_3` | Creates a poll, only person who has manage server permission can do it.
|
|
||||||
`>pollend` | `>pollend` | Stops active poll on this server and prints the results in this channel.
|
|
||||||
`>pick` | `>pick` | Picks a flower planted in this channel.
|
|
||||||
`>plant` | `>plant` | Spend a flower to plant it in this channel. (If bot is restarted or crashes, flower will be lost)
|
|
||||||
`>gencurrency` `>gc` | `>gc` | Toggles currency generation on this channel. Every posted message will have 2% chance to spawn a NadekoFlower. Requires Manage Messages permission. **Requires ManageMessages server permission.**
|
|
||||||
`>typestart` | `>typestart` | Starts a typing contest.
|
|
||||||
`>typestop` | `>typestop` | Stops a typing contest on the current channel.
|
|
||||||
`>typeadd` | `>typeadd wordswords` | Adds a new article to the typing contest. **Bot owner only.**
|
|
||||||
`>trivia` `>t` | `>t nohint` or `>t 5 nohint` | Starts a game of trivia. You can add nohint to prevent hints.First player to get to 10 points wins by default. You can specify a different number. 30 seconds per question.
|
|
||||||
`>tl` | `>tl` | Shows a current trivia leaderboard.
|
|
||||||
`>tq` | `>tq` | Quits current trivia after current question.
|
|
||||||
|
|
||||||
### Pokemon
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`>poke_cmd` | poke_usage | poke_desc
|
|
||||||
|
|
||||||
### Administration
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`.restart` | `.restart` | Restarts the bot. Might not work. **Bot owner only.**
|
|
||||||
`.delmsgoncmd` | `.delmsgoncmd` | Toggles the automatic deletion of user's successful command message to prevent chat flood. **Server Manager Only.** **Requires Administrator server permission.**
|
|
||||||
`.setrole` `.sr` | `.sr @User Guest` | Sets a role for a given user. **Requires ManageRoles server permission.**
|
|
||||||
`.removerole` `.rr` | `.rr @User Admin` | Removes a role from a given user. **Requires ManageRoles server permission.**
|
|
||||||
`.renamerole` `.renr` | `.renr "First role" SecondRole` | Renames a role. Roles you are renaming must be lower than bot's highest role. **Manage Roles Permissions.** **Requires ManageRoles server permission.**
|
|
||||||
`.removeallroles` `.rar` | `.rar @User` | Removes all roles from a mentioned user. **Requires ManageRoles server permission.**
|
|
||||||
`.createrole` `.cr` | `.cr Awesome Role` | Creates a role with a given name. **Requires ManageRoles server permission.**
|
|
||||||
`.rolecolor` `.rc` | `.rc Admin 255 200 100` or `.rc Admin ffba55` | Set a role's color to the hex or 0-255 rgb color value provided. **Requires ManageRoles server permission.**
|
|
||||||
`.ban` `.b` | `.b "@some Guy" Your behaviour is toxic.` | Bans a user by id or name with an optional message. **Requires BanMembers server permission.**
|
|
||||||
`.softban` `.sb` | `.sb "@some Guy" Your behaviour is toxic.` | Bans and then unbans a user by id or name with an optional message. **Requires BanMembers server permission.**
|
|
||||||
`.kick` `.k` | `.k "@some Guy" Your behaviour is toxic.` | Kicks a mentioned user. **Requires KickMembers server permission.**
|
|
||||||
`.mute` | `.mute @Someone` | Mutes a mentioned user in a voice channel. **Requires MuteMembers server permission.**
|
|
||||||
`.unmute` | `.unmute "@Someguy"` or `.unmute "@Someguy" "@Someguy"` | Unmutes mentioned user or users. **Requires MuteMembers server permission.**
|
|
||||||
`.deafen` `.deaf` | `.deaf "@Someguy"` or `.deaf "@Someguy" "@Someguy"` | Deafens mentioned user or users. **Requires DeafenMembers server permission.**
|
|
||||||
`.undeafen` `.undef` | `.undef "@Someguy"` or `.undef "@Someguy" "@Someguy"` | Undeafens mentioned user or users. **Requires DeafenMembers server permission.**
|
|
||||||
`.delvoichanl` `.dvch` | `.dvch VoiceChannelName` | Deletes a voice channel with a given name. **Requires ManageChannels server permission.**
|
|
||||||
`.creatvoichanl` `.cvch` | `.cvch VoiceChannelName` | Creates a new voice channel with a given name. **Requires ManageChannels server permission.**
|
|
||||||
`.deltxtchanl` `.dtch` | `.dtch TextChannelName` | Deletes a text channel with a given name. **Requires ManageChannels server permission.**
|
|
||||||
`.creatxtchanl` `.ctch` | `.ctch TextChannelName` | Creates a new text channel with a given name. **Requires ManageChannels server permission.**
|
|
||||||
`.settopic` `.st` | `.st My new topic` | Sets a topic on the current channel. **Requires ManageChannels server permission.**
|
|
||||||
`.setchanlname` `.schn` | `.schn NewName` | Changed the name of the current channel. **Requires ManageChannels server permission.**
|
|
||||||
`.prune` `.clr` | `.prune` or `.prune 5` or `.prune @Someone` or `.prune @Someone X` | `.prune` removes all nadeko's messages in the last 100 messages.`.prune X` removes last X messages from the channel (up to 100)`.prune @Someone` removes all Someone's messages in the last 100 messages.`.prune @Someone X` removes last X 'Someone's' messages in the channel.
|
|
||||||
`.prune` `.clr` | `.prune` or `.prune 5` or `.prune @Someone` or `.prune @Someone X` | `.prune` removes all nadeko's messages in the last 100 messages.`.prune X` removes last X messages from the channel (up to 100)`.prune @Someone` removes all Someone's messages in the last 100 messages.`.prune @Someone X` removes last X 'Someone's' messages in the channel. **Requires ManageMessages server permission.**
|
|
||||||
`.prune` `.clr` | `.prune` or `.prune 5` or `.prune @Someone` or `.prune @Someone X` | `.prune` removes all nadeko's messages in the last 100 messages.`.prune X` removes last X messages from the channel (up to 100)`.prune @Someone` removes all Someone's messages in the last 100 messages.`.prune @Someone X` removes last X 'Someone's' messages in the channel. **Requires ManageMessages server permission.**
|
|
||||||
`.die` | `@NadekoBot die` | Works only for the owner. Shuts the bot down. **Bot owner only.**
|
|
||||||
`.setname` `.newnm` | `.newnm BotName` | Give the bot a new name. **Bot owner only.**
|
|
||||||
`.setavatar` `.setav` | `.setav http://i.imgur.com/xTG3a1I.jpg` | Sets a new avatar image for the NadekoBot. Argument is a direct link to an image. **Bot owner only.**
|
|
||||||
`.setgame` | `.setgame Playing with kwoth` | Sets the bots game. **Bot owner only.**
|
|
||||||
`.send` | `.send sid` | Send a message to someone on a different server through the bot. **Bot owner only.**
|
|
||||||
`.announce` | `.announce Useless spam` | Sends a message to all servers' general channel bot is connected to. **Bot owner only.**
|
|
||||||
`.savechat` | `.savechat 150` | Saves a number of messages to a text file and sends it to you. **Bot owner only.**
|
|
||||||
`.mentionrole` `.menro` | `.menro RoleName` | Mentions every person from the provided role or roles (separated by a ',') on this server. Requires you to have mention everyone permission. **Requires MentionEveryone server permission.**
|
|
||||||
`.donators` | `.donators` | List of lovely people who donated to keep this project alive.
|
|
||||||
`.donadd` | `.donadd Donate Amount` | Add a donator to the database. **Kwoth Only** **Bot owner only.**
|
|
||||||
`.autoassignrole` `.aar` | `.aar` to disable, `.aar Role Name` to enable | Automaticaly assigns a specified role to every user who joins the server. **Requires ManageRoles server permission.**
|
|
||||||
`.scsc` | `.scsc` | Starts an instance of cross server channel. You will get a token as a DM that other people will use to tune in to the same instance. **Bot owner only.**
|
|
||||||
`.jcsc` | `.jcsc` | Joins current channel to an instance of cross server channel using the token. **Requires ManageServer server permission.**
|
|
||||||
`.lcsc` | `.lcsc` | Leaves Cross server channel instance from this channel. **Requires ManageServer server permission.**
|
|
||||||
`.logserver` | `.logserver` | Logs server activity in this channel. **Requires Administrator server permission.** **Bot owner only.**
|
|
||||||
`.logignore` | `.logignore` | Toggles whether the .logserver command ignores this channel. Useful if you have hidden admin channel and public log channel. **Requires Administrator server permission.** **Bot owner only.**
|
|
||||||
`.userpresence` | `.userpresence` | Starts logging to this channel when someone from the server goes online/offline/idle. **Requires Administrator server permission.**
|
|
||||||
`.voicepresence` | `.voicerpresence` | Toggles logging to this channel whenever someone joins or leaves a voice channel you are in right now. **Requires Administrator server permission.**
|
|
||||||
`.repeatinvoke` `.repinv` | `.repinv` | Immediately shows the repeat message and restarts the timer. **Requires ManageMessages server permission.**
|
|
||||||
`.repeat` | `.repeat 5 Hello there` | Repeat a message every X minutes. If no parameters are specified, repeat is disabled.
|
|
||||||
`.repeat` | `.repeat 5 Hello there` | Repeat a message every X minutes. If no parameters are specified, repeat is disabled.
|
|
||||||
`.migratedata` | `.migratedata` | Migrate data from old bot configuration **Bot owner only.**
|
|
||||||
`.rotateplaying` `.ropl` | `.ropl` | Toggles rotation of playing status of the dynamic strings you specified earlier. **Bot owner only.**
|
|
||||||
`.addplaying` `.adpl` | `.adpl` | Adds a specified string to the list of playing strings to rotate. Supported placeholders: %servers%, %users%, %playing%, %queued% **Bot owner only.**
|
|
||||||
`.listplaying` `.lipl` | `.lipl` | Lists all playing statuses with their corresponding number. **Bot owner only.**
|
|
||||||
`.removeplaying` `.rmlp` `.repl` | `.rmpl` | Removes a playing string on a given number. **Bot owner only.**
|
|
||||||
`.slowmode` | `.slowmode` | Toggles slow mode. When ON, users will be able to send only 1 message every 5 seconds.
|
|
||||||
`.asar` | `.asar Gamer` | Adds a role, or list of roles separated by whitespace(use quotations for multiword roles) to the list of self-assignable roles. **Requires ManageRoles server permission.**
|
|
||||||
`.rsar` | `.rsar` | Removes a specified role from the list of self-assignable roles. **Requires ManageRoles server permission.**
|
|
||||||
`.lsar` | `.lsar` | Lists all self-assignable roles.
|
|
||||||
`.togglexclsar` `.tesar` | `.tesar` | toggle whether the self-assigned roles should be exclusive **Requires ManageRoles server permission.**
|
|
||||||
`.iam` | `.iam Gamer` | Adds a role to you that you choose. Role must be on a list of self-assignable roles.
|
|
||||||
`.iamnot` `.iamn` | `.iamn Gamer` | Removes a role to you that you choose. Role must be on a list of self-assignable roles.
|
|
||||||
`.leave` | `.leave 123123123331` | Makes Nadeko leave the server. Either name or id required. **Bot owner only.**
|
|
||||||
`.greetdel` | `.greetdel` | Toggles automatic deletion of greet messages. **Requires ManageServer server permission.**
|
|
||||||
`.greet` | `.greet` | Toggles anouncements on the current channel when someone joins the server. **Requires ManageServer server permission.**
|
|
||||||
`.greetmsg` | `.greetmsg Welcome, %user%.` | Sets a new join announcement message which will be shown in the server's channel. Type %user% if you want to mention the new member. Using it with no message will show the current greet message. **Requires ManageServer server permission.**
|
|
||||||
`.greetdm` | `.greetdm` | Toggles whether the greet messages will be sent in a DM (This is separate from greet - you can have both, any or neither enabled). **Requires ManageServer server permission.**
|
|
||||||
`.greetdmmsg` | `.greetdmmsg Welcome to the server, %user%`. | Sets a new join announcement message which will be sent to the user who joined. Type %user% if you want to mention the new member. Using it with no message will show the current DM greet message. **Requires ManageServer server permission.**
|
|
||||||
`.bye` | `.bye` | Toggles anouncements on the current channel when someone leaves the server. **Requires ManageServer server permission.**
|
|
||||||
`.byemsg` | `.byemsg %user% has left.` | Sets a new leave announcement message. Type %user% if you want to mention the new member. Using it with no message will show the current bye message. **Requires ManageServer server permission.**
|
|
||||||
`.byedel` | `.byedel` | Toggles automatic deletion of bye messages. **Requires ManageServer server permission.**
|
|
||||||
`.voice+text` `.v+t` | `.voice+text` | Creates a text channel for each voice channel only users in that voice channel can see.If you are server owner, keep in mind you will see them all the time regardless. **Requires ManageRoles server permission.** **Requires ManageChannels server permission.**
|
|
||||||
`.cleanvplust` `.cv+t` | `.cleanv+t` | Deletes all text channels ending in `-voice` for which voicechannels are not found. **Use at your own risk. Needs Manage Roles and Manage Channels Permissions.** **Requires ManageChannels server permission.** **Requires ManageRoles server permission.**
|
|
||||||
|
|
||||||
### Music
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`!!next` `!!n` | `!!n` | Goes to the next song in the queue. You have to be in the same voice channel as the bot.
|
|
||||||
`!!stop` `!!s` | `!!s` | Stops the music and clears the playlist. Stays in the channel.
|
|
||||||
`!!destroy` `!!d` | `!!d` | Completely stops the music and unbinds the bot from the channel. (may cause weird behaviour)
|
|
||||||
`!!pause` `!!p` | `!!p` | Pauses or Unpauses the song.
|
|
||||||
`!!queue` `!!q` `!!yq` | `!!q Dream Of Venice` | Queue a song using keywords or a link. Bot will join your voice channel.**You must be in a voice channel**.
|
|
||||||
`!!soundcloudqueue` `!!sq` | `!!sq Dream Of Venice` | Queue a soundcloud song using keywords. Bot will join your voice channel.**You must be in a voice channel**.
|
|
||||||
`!!listqueue` `!!lq` | `!!lq` or `!!lq 2` | Lists 15 currently queued songs per page. Default page is 1.
|
|
||||||
`!!nowplaying` `!!np` | `!!np` | Shows the song currently playing.
|
|
||||||
`!!volume` `!!vol` | `!!vol 50` | Sets the music volume 0-100%
|
|
||||||
`!!defvol` `!!dv` | `!!dv 80` | Sets the default music volume when music playback is started (0-100). Persists through restarts.
|
|
||||||
`!!shuffle` `!!sh` | `!!sh` | Shuffles the current playlist.
|
|
||||||
`!!playlist` `!!pl` | `!!pl playlist link or name` | Queues up to 500 songs from a youtube playlist specified by a link, or keywords.
|
|
||||||
`!!soundcloudpl` `!!scpl` | `!!scpl soundcloudseturl` | Queue a soundcloud playlist using a link.
|
|
||||||
`!!localplaylst` `!!lopl` | `!!lopl C:/music/classical` | Queues all songs from a directory. **Bot owner only.**
|
|
||||||
`!!radio` `!!ra` | `!!ra radio link here` | Queues a radio stream from a link. It can be a direct mp3 radio stream, .m3u, .pls .asx or .xspf (Usage Video: <https://streamable.com/al54>)
|
|
||||||
`!!local` `!!lo` | `!!lo C:/music/mysong.mp3` | Queues a local file by specifying a full path. **Bot owner only.**
|
|
||||||
`!!move` `!!mv` | `!!mv` | Moves the bot to your voice channel. (works only if music is already playing)
|
|
||||||
`!!remove` `!!rm` | `!!rm 5` | Remove a song by its # in the queue, or 'all' to remove whole queue.
|
|
||||||
`!!remove` `!!rm` | `!!rm 5` | Remove a song by its # in the queue, or 'all' to remove whole queue.
|
|
||||||
`!!movesong` `!!ms` | `!! ms 5>3` | Moves a song from one position to another.
|
|
||||||
`!!setmaxqueue` `!!smq` | `!!smq 50` or `!!smq` | Sets a maximum queue size. Supply 0 or no argument to have no limit.
|
|
||||||
`!!reptcursong` `!!rcs` | `!!rcs` | Toggles repeat of current song.
|
|
||||||
`!!rpeatplaylst` `!!rpl` | `!!rpl` | Toggles repeat of all songs in the queue (every song that finishes is added to the end of the queue).
|
|
||||||
`!!save` | `!!save classical1` | Saves a playlist under a certain name. Name must be no longer than 20 characters and mustn't contain dashes.
|
|
||||||
`!!load` | `!!load classical-1` | Loads a playlist under a certain name.
|
|
||||||
`!!playlists` `!!pls` | `!!pls 1` | Lists all playlists. Paginated. 20 per page. Default page is 0.
|
|
||||||
`!!deleteplaylist` `!!delpls` | `!!delpls animu-5` | Deletes a saved playlist. Only if you made it or if you are the bot owner.
|
|
||||||
`!!goto` | `!!goto 30` | Goes to a specific time in seconds in a song.
|
|
||||||
`!!getlink` `!!gl` | `!!gl` | Shows a link to the song in the queue by index, or the currently playing song by default.
|
|
||||||
`!!autoplay` `!!ap` | `!!ap` | Toggles autoplay - When the song is finished, automatically queue a related youtube song. (Works only for youtube songs and when queue is empty)
|
|
||||||
|
|
||||||
### Help
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`-modules` `-mdls` | `-modules` or `.modules` | List all bot modules.
|
|
||||||
`-commands` `-cmds` | `-commands` or `.commands` | List all of the bot's commands from a certain module.
|
|
||||||
`-h` `-help` | `-h !m q` or just `-h` | Either shows a help for a single command, or PMs you help link if no arguments are specified.
|
|
||||||
`-hgit` | `-hgit` | Generates the commandlist.md file. **Bot owner only.**
|
|
||||||
`-readme` `-guide` | `-readme` or `-guide` | Sends a readme and a guide links to the channel.
|
|
||||||
`-donate` | `-donate` or `~donate` | Instructions for helping the project!
|
|
||||||
|
|
||||||
### Utility
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`.whosplaying` | `.whoplays Overwatch` | Shows a list of users who are playing the specified game.
|
|
||||||
`.inrole` | `.inrole Role` | Lists every person from the provided role or roles (separated by a ',') on this server. If the list is too long for 1 message, you must have Manage Messages permission.
|
|
||||||
`.checkmyperms` | `.checkmyperms` | Checks your userspecific permissions on this channel.
|
|
||||||
`.userid` `.uid` | `.uid` or `.uid "@SomeGuy"` | Shows user ID.
|
|
||||||
`.channelid` `.cid` | `.cid` | Shows current channel ID.
|
|
||||||
`.serverid` `.sid` | `.sid` | Shows current server ID.
|
|
||||||
`.roles` | `.roles` | List all roles on this server or a single user if specified.
|
|
||||||
`.channeltopic` `.ct` | `.ct` | Sends current channel's topic as a message.
|
|
||||||
`.stats` | `.stats` | Shows some basic stats for Nadeko.
|
|
||||||
`.showemojis` `.se` | `.se A message full of SPECIALemojis` | Shows a name and a link to every SPECIAL emoji in the message.
|
|
||||||
`.serverinfo` `.sinfo` | `.sinfo Some Server` | Shows info about the server the bot is on. If no channel is supplied, it defaults to current one.
|
|
||||||
`.channelinfo` `.cinfo` | `.cinfo #some-channel` | Shows info about the channel. If no channel is supplied, it defaults to current one.
|
|
||||||
`.userinfo` `.uinfo` | `.uinfo @SomeUser` | Shows info about the user. If no user is supplied, it defaults a user running the command.
|
|
||||||
`...` | `... abc` | Shows a random quote with a specified name.
|
|
||||||
`..` | `.. sayhi Hi` | Adds a new quote with the specified name and message.
|
|
||||||
`.deletequote` `.delq` | `.delq abc` | Deletes all quotes with the specified keyword. You have to either be bot owner or the creator of the quote to delete it.
|
|
||||||
`.delallq` `.daq` | `.delallq kek` | Deletes all quotes on a specified keyword.
|
|
||||||
`.remind` | `.remind me 1d5h Do something` or `.remind #general Start now!` | Sends a message to you or a channel after certain amount of time. First argument is me/here/'channelname'. Second argument is time in a descending order (mo>w>d>h>m) example: 1w5d3h10m. Third argument is a (multiword)message.
|
|
||||||
`.remindtemplate` | `.remindtemplate %user%, you gotta do %message%!` | Sets message for when the remind is triggered. Available placeholders are %user% - user who ran the command, %message% - Message specified in the remind, %target% - target channel of the remind. **Bot owner only.**
|
|
||||||
|
|
||||||
### Searches
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`~weather` `~we` | `~we Moscow RF` | Shows weather data for a specified city and a country. BOTH ARE REQUIRED. Use country abbrevations.
|
|
||||||
`~youtube` `~yt` | `~yt query` | Searches youtubes and shows the first result
|
|
||||||
`~imdb` | `~imdb Batman vs Superman` | Queries imdb for movies or series, show first result.
|
|
||||||
`~randomcat` `~meow` | `~meow` | Shows a random cat image.
|
|
||||||
`~randomdog` `~woof` | `~woof` | Shows a random dog image.
|
|
||||||
`~img` `~i` | `~i cute kitten` | Pulls the first image found using a search parameter. Use ~ir for different results.
|
|
||||||
`~ir` | `~ir cute kitten` | Pulls a random image using a search parameter.
|
|
||||||
`~lmgtfy` | `~lmgtfy query` | Google something for an idiot.
|
|
||||||
`~google` `~g` | `~google query` | Get a google search link for some terms.
|
|
||||||
`~hearthstone` `~hs` | `~hs Ysera` | Searches for a Hearthstone card and shows its image. Takes a while to complete.
|
|
||||||
`~urbandict` `~ud` | `~ud Pineapple` | Searches Urban Dictionary for a word.
|
|
||||||
`~#` | `~# ff` | Searches Tagdef.com for a hashtag.
|
|
||||||
`~catfact` | `~catfact` | Shows a random catfact from <http://catfacts-api.appspot.com/api/facts>
|
|
||||||
`~revav` | `~revav "@SomeGuy"` | Returns a google reverse image search for someone's avatar.
|
|
||||||
`~revimg` | `~revimg Image link` | Returns a google reverse image search for an image from a link.
|
|
||||||
`~safebooru` | `~safebooru yuri+kissing` | Shows a random image from safebooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +)
|
|
||||||
`~wikipedia` `~wiki` | `~wiki query` | Gives you back a wikipedia link
|
|
||||||
`~color` `~clr` | `~clr 00ff00` | Shows you what color corresponds to that hex.
|
|
||||||
`~videocall` | `~videocall "@SomeGuy"` | Creates a private <http://www.appear.in> video call link for you and other mentioned people. The link is sent to mentioned people via a private message.
|
|
||||||
`~av` `~avatar` | `~av "@SomeGuy"` | Shows a mentioned person's avatar.
|
|
||||||
`~calculate` `~calc` | `~calc 1+1` | Evaluate a mathematical expression.
|
|
||||||
`~calcops` | `~calcops` | Shows all available operations in .calc command
|
|
||||||
`~lolban` | `~lolban` | Shows top banned champions ordered by ban rate.
|
|
||||||
`~memelist` | `~memelist` | Pulls a list of memes you can use with `~memegen` from http://memegen.link/templates/
|
|
||||||
`~memegen` | `~memegen biw "gets iced coffee" "in the winter"` | Generates a meme from memelist with top and bottom text.
|
|
||||||
`~anime` `~ani` `~aq` | `~ani aquarion evol` | Queries anilist for an anime and shows the first result.
|
|
||||||
`~manga` `~mang` `~mq` | `~mq Shingeki no kyojin` | Queries anilist for a manga and shows the first result.
|
|
||||||
`~yomama` `~ym` | `~ym` | Shows a random joke from <http://api.yomomma.info/>
|
|
||||||
`~randjoke` `~rj` | `~rj` | Shows a random joke from <http://tambal.azurewebsites.net/joke/random>
|
|
||||||
`~chucknorris` `~cn` | `~cn` | Shows a random chucknorris joke from <http://tambal.azurewebsites.net/joke/random>
|
|
||||||
`~wowjoke` | `~wowjoke` | Get one of Kwoth's penultimate WoW jokes.
|
|
||||||
`~magicitem` `~mi` | `~mi` | Shows a random magicitem from <https://1d4chan.org/wiki/List_of_/tg/%27s_magic_items>
|
|
||||||
`~osu` | `~osu Name` or `~osu Name taiko` | Shows osu stats for a player.
|
|
||||||
`~osub` | `~osub https://osu.ppy.sh/s/127712` | Shows information about an osu beatmap.
|
|
||||||
`~osu5` | `~osu5 Name` | Displays a user's top 5 plays.
|
|
||||||
`~pokemon` `~poke` | `~poke Sylveon` | Searches for a pokemon.
|
|
||||||
`~pokemonability` `~pokeab` | `~pokeab "water gun"` | Searches for a pokemon ability.
|
|
||||||
`~hitbox` `~hb` | `~hitbox SomeStreamer` | Notifies this channel when a certain user starts streaming. **Requires ManageMessages server permission.**
|
|
||||||
`~twitch` `~tw` | `~twitch SomeStreamer` | Notifies this channel when a certain user starts streaming. **Requires ManageMessages server permission.**
|
|
||||||
`~beam` `~bm` | `~beam SomeStreamer` | Notifies this channel when a certain user starts streaming. **Requires ManageMessages server permission.**
|
|
||||||
`~liststreams` `~ls` | `~ls` | Lists all streams you are following on this server.
|
|
||||||
`~removestream` `~rms` | `~rms SomeGuy` | Removes notifications of a certain streamer on this channel.
|
|
||||||
`~checkstream` `~cs` | `~cs twitch MyFavStreamer` | Checks if a user is online on a certain streaming platform.
|
|
||||||
`~convertlist` | `~convertlist` | List of the convertable dimensions and currencies.
|
|
||||||
`~convert` | `~convert m>km 1000` | Convert quantities from>to.
|
|
||||||
|
|
||||||
### Translator
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`~translate` `~trans` | `~trans en>fr Hello` | Translates from>to text. From the given language to the destiation language.
|
|
||||||
`~translangs` | `~translangs` | List the valid languages for translation.
|
|
||||||
|
|
||||||
### NSFW
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`~hentai` | `~hentai yuri+kissing` | Shows a random NSFW hentai image from gelbooru and danbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +)
|
|
||||||
`~danbooru` | `~danbooru yuri+kissing` | Shows a random hentai image from danbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +)
|
|
||||||
`~gelbooru` | `~gelbooru yuri+kissing` | Shows a random hentai image from gelbooru with a given tag. Tag is optional but preffered. (multiple tags are appended with +)
|
|
||||||
`~rule34` | `~rule34 yuri+kissing` | Shows a random image from rule34.xx with a given tag. Tag is optional but preffered. (multiple tags are appended with +)
|
|
||||||
`~e621` | `~e621 yuri kissing` | Shows a random hentai image from e621.net with a given tag. Tag is optional but preffered. Use spaces for multiple tags.
|
|
||||||
`~cp` | `~cp` | We all know where this will lead you to.
|
|
||||||
`~boobs` | `~boobs` | Real adult content.
|
|
||||||
`~butts` `~ass` `~butt` | `~butts` or `~ass` | Real adult content.
|
|
||||||
|
|
||||||
### CustomReactions
|
|
||||||
Command and aliases | Description | Usage
|
|
||||||
----------------|--------------|-------
|
|
||||||
`.addcustreact` `.acr` | `.acr "hello" Hi there %user%` | Add a custom reaction with a trigger and a response. Running this command in server requires Administration permission. Running this command in DM is Bot Owner only and adds a new global custom reaction. Guide here: <https://github.com/Kwoth/NadekoBot/wiki/Custom-Reactions>
|
|
||||||
`.listcustreact` `.lcr` | `.lcr 1` | Lists global or server custom reactions (15 commands per page). Running the command in DM will list global custom reactions, while running it in server will list that server's custom reactions.
|
|
||||||
`.delcustreact` `.dcr` | `.dcr 5` | Deletes a custom reaction on a specific index. If ran in DM, it is bot owner only and deletes a global custom reaction. If ran in a server, it requires Administration priviledges and removes server custom reaction.
|
|
||||||
8
docs/guides/Building from Source.md
Normal file
8
docs/guides/Building from Source.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
###Building from Source
|
||||||
|
For easy setup and no programming knowledge, you can use [Updater](https://github.com/Kwoth/NadekoUpdater/releases/latest) or download release from [Releases](https://github.com/Kwoth/NadekoBot/releases) and follow the [Windows Guide](Windows Guide.md)
|
||||||
|
|
||||||
|
In your bin/debug folder (or next to your exe if you are using release version), you must have a file called 'credentials.json' in which you will store all the necessary data to make the bot know who the owner is, and your api keys.
|
||||||
|
|
||||||
|
When you clone the project, make sure to run `git submodule init` and `git submodule update` to get the correct discord.net version
|
||||||
|
|
||||||
|
Make sure you've read ComprehensiveGuide to get a grasp of basic config/credentials setup and then look at "Credentials and config" chapter.
|
||||||
@ -1,6 +1,6 @@
|
|||||||
## Docker guide with digitalocean
|
# Docker Guide with DigitalOcean
|
||||||
|
|
||||||
#####Prerequisites:
|
#####Prerequisites
|
||||||
- Digital ocean account (you can use my [reflink][reflink] to support the project and get 10$ after you register)
|
- Digital ocean account (you can use my [reflink][reflink] to support the project and get 10$ after you register)
|
||||||
- [PuTTY][PuTTY]
|
- [PuTTY][PuTTY]
|
||||||
- A bot account - follow this [guide][guide]
|
- A bot account - follow this [guide][guide]
|
||||||
@ -1,9 +1,9 @@
|
|||||||
#Setting up NadekoBot on Linux
|
##Setting up NadekoBot on Linux
|
||||||
|
|
||||||
####Setting up NadekoBot on Linux Digital Ocean Droplet
|
####Setting up NadekoBot on Linux Digital Ocean Droplet
|
||||||
######If you want Nadeko to play music for you 24/7 without having to hosting it on your PC and want to keep it cheap, reliable and convenient as possible, you can try Nadeko on Linux Digital Ocean Droplet using the link [DigitalOcean][DigitalOcean] (and using this link will be supporting Nadeko and will give you **$10 credit**)
|
If you want Nadeko to play music for you 24/7 without having to hosting it on your PC and want to keep it cheap, reliable and convenient as possible, you can try Nadeko on Linux Digital Ocean Droplet using the link [DigitalOcean][DigitalOcean] (and using this link will be supporting Nadeko and will give you **$10 credit**)
|
||||||
|
|
||||||
######Keep this helpful video handy [Linux Setup Video][Linux Setup Video] (thanks to klincheR) it contains how to set up the Digital Ocean droplet aswell.
|
Keep this helpful video handy [Linux Setup Video][Linux Setup Video] (thanks to klincheR) it contains how to set up the Digital Ocean droplet aswell.
|
||||||
|
|
||||||
####Setting up NadekoBot
|
####Setting up NadekoBot
|
||||||
Assuming you have followed the link above to created an account in Digital Ocean and video to set up the bot until you get the `IP address and root password (in email)` to login, its time to begin.
|
Assuming you have followed the link above to created an account in Digital Ocean and video to set up the bot until you get the `IP address and root password (in email)` to login, its time to begin.
|
||||||
@ -24,47 +24,52 @@ If you entered your Droplets IP address correctly, it should show **login as:**
|
|||||||
|
|
||||||
**Copy and just paste** using **mouse right-click** (it should paste automatically)
|
**Copy and just paste** using **mouse right-click** (it should paste automatically)
|
||||||
|
|
||||||
######MONO (Source: [Mono Source][Mono Source])
|
####Installing Mono
|
||||||
|
MONO (Source: [Mono Source][Mono Source])
|
||||||
|
|
||||||
**1) Installing Mono**
|
**1)**
|
||||||
|
|
||||||
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
|
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
|
||||||
|
|
||||||
`echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list`
|
`echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list`
|
||||||
|
|
||||||
`sudo apt-get update`
|
`sudo apt-get update`
|
||||||
|
|
||||||
Note if the command is not being initiated, hit **Enter**
|
Note if the command is not being initiated, hit **Enter**
|
||||||
|
|
||||||
**2)**
|
**2)**
|
||||||
|
|
||||||
`echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
`echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | sudo
|
||||||
|
tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
||||||
|
|
||||||
|
####Mono on Debian 8 and later
|
||||||
**2.5)**
|
**2.5)**
|
||||||
*ONLY DEBIAN 8 and later*
|
|
||||||
|
|
||||||
`echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
`echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" | sudo
|
||||||
|
tee -a /etc/apt/sources.list.d/mono-xamarin.list`
|
||||||
|
|
||||||
|
####Mono on CentOS 7, Fedora 19 (and later) and later
|
||||||
**2.6)**
|
**2.6)**
|
||||||
*ONLY CentOS 7, Fedora 19 (and later)*
|
|
||||||
|
|
||||||
`yum install yum-util`
|
`yum install yum-util`
|
||||||
|
|
||||||
`rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"`
|
`rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"`
|
||||||
|
|
||||||
`yum-config-manager --add-repo http://download.mono-project.com/repo/centos/`
|
`yum-config-manager --add-repo http://download.mono-project.com/repo/centos/`
|
||||||
|
|
||||||
|
####Mono Devel
|
||||||
**3)**
|
**3)**
|
||||||
*Mono Devel*
|
|
||||||
|
|
||||||
`apt-get install mono-devel`
|
`apt-get install mono-devel`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
|
####Mono Fix
|
||||||
|
**In case you are having issues with Mono where you get a random string and the bot won't run, do this:**
|
||||||
|
|
||||||
|
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
|
||||||
|
`echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list`
|
||||||
|
`apt-get install ca-certificates-mono`
|
||||||
|
`mozroots --import --sync`
|
||||||
|
|
||||||
|
####Installing Opus Voice Codec
|
||||||
**4)**
|
**4)**
|
||||||
Opus Voice Codec
|
|
||||||
|
|
||||||
`sudo apt-get install libopus0 opus-tools`
|
`sudo apt-get install libopus0 opus-tools`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
@ -72,17 +77,6 @@ Opus Voice Codec
|
|||||||
**5)**
|
**5)**
|
||||||
`sudo apt-get install libopus-dev`
|
`sudo apt-get install libopus-dev`
|
||||||
|
|
||||||
**In case you are having issues with Mono where you get a random string and the bot won't run, do this:**
|
|
||||||
|
|
||||||
`sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF`
|
|
||||||
|
|
||||||
`echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list`
|
|
||||||
|
|
||||||
`apt-get install ca-certificates-mono`
|
|
||||||
|
|
||||||
`mozroots --import --sync`
|
|
||||||
|
|
||||||
|
|
||||||
####FFMPEG
|
####FFMPEG
|
||||||
|
|
||||||
**6)**
|
**6)**
|
||||||
@ -95,9 +89,7 @@ NOTE: if its "not installing" then, follow the guide here: [FFMPEG Help Guide][F
|
|||||||
**All you need to do, if you are running UBUNTU 14.04 is initiate these:**
|
**All you need to do, if you are running UBUNTU 14.04 is initiate these:**
|
||||||
|
|
||||||
`sudo add-apt-repository ppa:mc3man/trusty-media`
|
`sudo add-apt-repository ppa:mc3man/trusty-media`
|
||||||
|
|
||||||
`sudo apt-get update`
|
`sudo apt-get update`
|
||||||
|
|
||||||
`sudo apt-get dist-upgrade`
|
`sudo apt-get dist-upgrade`
|
||||||
|
|
||||||
*Before executing* `sudo apt-get install ffmpeg`
|
*Before executing* `sudo apt-get install ffmpeg`
|
||||||
@ -109,11 +101,8 @@ NOTE: if its "not installing" then, follow the guide here: [FFMPEG Help Guide][F
|
|||||||
In case you are not able to install it with installer ^up there, follow these steps:
|
In case you are not able to install it with installer ^up there, follow these steps:
|
||||||
|
|
||||||
`sudo apt-get update`
|
`sudo apt-get update`
|
||||||
|
|
||||||
`echo "deb http://ftp.debian.org/debian jessie-backports main" | tee /etc/apt/sources.list.d/debian-backports.list`
|
`echo "deb http://ftp.debian.org/debian jessie-backports main" | tee /etc/apt/sources.list.d/debian-backports.list`
|
||||||
|
|
||||||
`sudo apt-get update`
|
`sudo apt-get update`
|
||||||
|
|
||||||
`sudo apt-get install ffmpeg -y`
|
`sudo apt-get install ffmpeg -y`
|
||||||
|
|
||||||
####Uncomplicated Firewall UFW
|
####Uncomplicated Firewall UFW
|
||||||
@ -134,30 +123,25 @@ In case you are not able to install it with installer ^up there, follow these st
|
|||||||
**10)**
|
**10)**
|
||||||
`sudo ufw allow ssh`
|
`sudo ufw allow ssh`
|
||||||
|
|
||||||
|
####Installing Unzip
|
||||||
|
|
||||||
**11)**
|
**11)**
|
||||||
Unzip
|
|
||||||
|
|
||||||
`apt-get install unzip`
|
`apt-get install unzip`
|
||||||
|
|
||||||
|
####Installing TMUX
|
||||||
**12)**
|
**12)**
|
||||||
TMUX
|
|
||||||
|
|
||||||
`apt-get install tmux`
|
`apt-get install tmux`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
####NOW WE NEED TO IMPORT SOME DISCORD CERTS
|
####Importing Discord certs
|
||||||
**13)**
|
**13)**
|
||||||
`certmgr -ssl https://discordapp.com`
|
`certmgr -ssl https://discordapp.com`
|
||||||
|
|
||||||
**14)**
|
**14)**
|
||||||
`certmgr -ssl https://gateway.discord.gg`
|
`certmgr -ssl https://gateway.discord.gg`
|
||||||
|
|
||||||
Type `yes` and hit Enter **(three times - as it will ask for three times)**
|
Type `yes` and hit Enter **(three times - as it will ask for three times)**
|
||||||
|
|
||||||
|
####Creating Nadeko folder
|
||||||
**15)**
|
**15)**
|
||||||
Create a new folder “nadeko” or anything you prefer
|
Create a new folder “nadeko” or anything you prefer
|
||||||
|
|
||||||
@ -168,7 +152,7 @@ Move to “nadeko” folder (note `cd --` to go back the directory)
|
|||||||
|
|
||||||
`cd nadeko`
|
`cd nadeko`
|
||||||
|
|
||||||
**NOW WE NEED TO GET NADEKO FROM RELEASES**
|
####Getting NadekoBot from Releases
|
||||||
|
|
||||||
Go to this link: [Releases][Releases] and **copy the zip file address** of the lalest version available,
|
Go to this link: [Releases][Releases] and **copy the zip file address** of the lalest version available,
|
||||||
it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
||||||
@ -181,14 +165,13 @@ Get the correct link, type `wget`, then *paste the link*, then hit **Enter**.
|
|||||||
**^Do not copy-paste it**
|
**^Do not copy-paste it**
|
||||||
|
|
||||||
**18)**
|
**18)**
|
||||||
|
|
||||||
Now we need to `unzip` the downloaded zip file and to do that, type the file name as it showed in your screen or just copy from the screen, should be like ` NadekoBot.vx.x.zip`
|
Now we need to `unzip` the downloaded zip file and to do that, type the file name as it showed in your screen or just copy from the screen, should be like ` NadekoBot.vx.x.zip`
|
||||||
|
|
||||||
`unzip NadekoBot.vx.x.zip`
|
`unzip NadekoBot.vx.x.zip`
|
||||||
|
|
||||||
**^Do not copy-paste it**
|
**^Do not copy-paste it**
|
||||||
|
|
||||||
#####NOW TO SETUP NADEKO
|
####Setting up NadekoBot
|
||||||
|
|
||||||
- Open **CyberDuck**
|
- Open **CyberDuck**
|
||||||
- Click on **Open Connection** (top-left corner), a new window should appear.
|
- Click on **Open Connection** (top-left corner), a new window should appear.
|
||||||
@ -201,15 +184,16 @@ Now we need to `unzip` the downloaded zip file and to do that, type the file nam
|
|||||||
- It should show you the new folder you created.
|
- It should show you the new folder you created.
|
||||||
- Open it.
|
- Open it.
|
||||||
|
|
||||||
#####MAKE SURE YOU READ THE README BEFORE PROCEEDING
|
####Renaming Credentials.json
|
||||||
|
|
||||||
- Copy the `credentials_example.json` to desktop
|
- Copy the `credentials_example.json` to desktop
|
||||||
- EDIT it as it is guided here: [Readme][Readme]
|
- EDIT it as it is guided here: [Setting up Credentials.json](Windows Guide.md#setting-up-credentialsjson-file)
|
||||||
|
- Read here how to [Create DiscordBot application](https://github.com/miraai/NadekoBot/blob/dev/docs/guides/Windows%20Guide.md#creating-discordbot-application)
|
||||||
- Rename it to `credentials.json` and paste/put it back in the folder. `(Yes, using CyberDuck)`
|
- Rename it to `credentials.json` and paste/put it back in the folder. `(Yes, using CyberDuck)`
|
||||||
- You should see two files `credentials_example.json` and `credentials.json`
|
- You should see two files `credentials_example.json` and `credentials.json`
|
||||||
- Also if you already have nadeko setup and have `credentials.json`, `config.json`, `nadekobot.sqlite`, and `"permissions" folder`, you can just copy and paste it to the Droplets folder using CyberDuck.
|
- Also if you already have nadeko setup and have `credentials.json`, `config.json`, `nadekobot.sqlite`, and `"permissions" folder`, you can just copy and paste it to the Droplets folder using CyberDuck.
|
||||||
|
|
||||||
######TIME TO RUN
|
####Running NadekoBot
|
||||||
|
|
||||||
Go back to **PuTTY**, `(hope its still running xD)`
|
Go back to **PuTTY**, `(hope its still running xD)`
|
||||||
|
|
||||||
@ -218,7 +202,8 @@ Type/ Copy and hit **Enter**.
|
|||||||
|
|
||||||
`tmux new -s nadeko`
|
`tmux new -s nadeko`
|
||||||
|
|
||||||
**^this will create a new session named “nadeko”** `(you can replace “nadeko” with anything you prefer and remember its your session name) so you can run the bot in background without having to keep running PuTTY in the background.`
|
**^this will create a new session named “nadeko”** `(you can replace “nadeko” with anything you prefer and remember
|
||||||
|
its your session name) so you can run the bot in background without having to keep running PuTTY in the background.`
|
||||||
|
|
||||||
`cd nadeko`
|
`cd nadeko`
|
||||||
|
|
||||||
@ -227,33 +212,33 @@ Type/ Copy and hit **Enter**.
|
|||||||
|
|
||||||
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
|
**CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING**
|
||||||
|
|
||||||
Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will ditach the nadeko session using TMUX), and you can finally close PuTTY now.
|
####Setting up Nadeko Music
|
||||||
|
|
||||||
|
For how to set up Nadeko for music and Google API Keys, follow [Setting up NadekoBot for Music](Windows Guide.md#setting-up-nadekobot-for-music)
|
||||||
|
|
||||||
|
Now time to **move bot to background** and to do that, press **CTRL+B+D** (this will detach the nadeko session using TMUX), and you can finally close PuTTY now.
|
||||||
|
|
||||||
Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server.
|
Copy your CLIENT ID (that's in the same Developer page where you brought your token) and replace `12345678` in this link: `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with it. Go to that link and you will be able to add your bot to your server.
|
||||||
|
|
||||||
**NOW YOU HAVE YOUR OWN NADEKO BOT** `Thanks to Kwoth <3`
|
**NOW YOU HAVE YOUR OWN NADEKO BOT** `Thanks to Kwoth <3`
|
||||||
|
|
||||||
######SOME MORE INFO (JUST TO KNOW):
|
####Some more Info (just in case)
|
||||||
|
|
||||||
-If you want to **see the sessions** after logging back again, type `tmux ls`, and that will give you the list of sessions running.
|
-If you want to **see the sessions** after logging back again, type `tmux ls`, and that will give you the list of sessions running.
|
||||||
-If you want to **switch to/ see that session**, type `tmux a -t nadeko` (**nadeko** is the name of the session we created before so, replace **“nadeko”** with the session name you created.)
|
-If you want to **switch to/ see that session**, type `tmux a -t nadeko` (**nadeko** is the name of the session we created before so, replace **“nadeko”** with the session name you created.)
|
||||||
|
|
||||||
**21)**
|
|
||||||
-If you want to **kill** NadekoBot **session**, type `tmux kill-session -t nadeko`
|
-If you want to **kill** NadekoBot **session**, type `tmux kill-session -t nadeko`
|
||||||
|
|
||||||
######TO RESTART YOUR BOT ALONG WITH THE WHOLE SERVER (for science):
|
####Restarting Nadeko with the Server
|
||||||
**22)**
|
|
||||||
Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
|
Open **PuTTY** and login as you have before, type `reboot` and hit Enter.
|
||||||
|
|
||||||
######IF YOU WANT TO UPDATE YOUR BOT
|
####Updating Nadeko
|
||||||
|
|
||||||
**FOLLOW THESE STEPS SERIALLY**
|
**FOLLOW THESE STEPS SERIALLY**
|
||||||
|
|
||||||
- **-21 OR 22**
|
|
||||||
- **-19**
|
|
||||||
- **-16**
|
- **-16**
|
||||||
- **-17**
|
- **-17**
|
||||||
- **-18**
|
- **-18**
|
||||||
|
- **-19**
|
||||||
- **-20**
|
- **-20**
|
||||||
|
|
||||||
HIT **CTRL+B+D** and close **PuTTY**
|
HIT **CTRL+B+D** and close **PuTTY**
|
||||||
167
docs/guides/OSX Guide.md
Normal file
167
docs/guides/OSX Guide.md
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
### Setting Up NadekoBot on OSX
|
||||||
|
#### Prerequisites
|
||||||
|
- 1) [Homebrew][Homebrew]
|
||||||
|
- 2) Mono
|
||||||
|
- 3) Google Account
|
||||||
|
- 4) Soundcloud Account (if you want soundcloud support)
|
||||||
|
- 5) Text Editor (TextWrangler, or equivalent) or outside editor such as [Atom][Atom]
|
||||||
|
|
||||||
|
####Installing Homebrew
|
||||||
|
|
||||||
|
`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
|
||||||
|
|
||||||
|
Run `brew update` to fetch the latest package data.
|
||||||
|
####Installing dependencies
|
||||||
|
```
|
||||||
|
brew install git
|
||||||
|
brew install ffmpeg
|
||||||
|
brew update && brew upgrade ffmpeg
|
||||||
|
brew install opus
|
||||||
|
brew install opus-tools
|
||||||
|
brew install opusfile
|
||||||
|
brew install libffi
|
||||||
|
brew install libsodium
|
||||||
|
brew install tmux
|
||||||
|
```
|
||||||
|
|
||||||
|
####Check your `FFMPEG`
|
||||||
|
|
||||||
|
**In case your `FFMPEG` wasnt installed properly**
|
||||||
|
|
||||||
|
- `brew options ffmpeg`
|
||||||
|
- `brew install ffmpeg --with-x --with-y --with-z` etc.
|
||||||
|
- `brew update && brew upgrade` (Update formulae and Homebrew itself && Install newer versions of outdated packages)
|
||||||
|
- `brew prune` (Remove dead symlinks from Homebrew’s prefix)
|
||||||
|
- `brew doctor` (Check your Homebrew installation for common issues)
|
||||||
|
- Then try `brew install ffmpeg` again.
|
||||||
|
|
||||||
|
####Installing xcode-select
|
||||||
|
Xcode command line tools. You will do this in Terminal.app by running the following command line:
|
||||||
|
|
||||||
|
`xcode-select --install`
|
||||||
|
|
||||||
|
A dialog box will open asking if you want to install `xcode-select`. Select install and finish the installation.
|
||||||
|
|
||||||
|
####Installing Mono
|
||||||
|
- Building Mono dependencies:
|
||||||
|
|
||||||
|
`brew install autoconf automake libtool pkg-config`
|
||||||
|
|
||||||
|
- Building Mono from Source:
|
||||||
|
|
||||||
|
To build Mono from a Git Source Code checkout, you will want to have the official Mono installed on the system, as the build requires a working C# compiler to run. Once you do this, run the following commands, remember to replace PREFIX with your installation prefix that you selected:
|
||||||
|
|
||||||
|
```
|
||||||
|
PATH=$PREFIX/bin:$PATH
|
||||||
|
git clone https://github.com/mono/mono.git
|
||||||
|
cd mono
|
||||||
|
CC='cc -m32' ./autogen.sh --prefix=$PREFIX --disable-nls --build=i386-apple-darwin11.2.0
|
||||||
|
make
|
||||||
|
make install
|
||||||
|
```
|
||||||
|
To build Mono in 64 bit mode instead use this to configure the build:
|
||||||
|
|
||||||
|
`./autogen.sh --prefix=$PREFIX --disable-nls`
|
||||||
|
|
||||||
|
####Nadeko Setup
|
||||||
|
- Create a new folder and name it `Nadeko`.
|
||||||
|
- Move to our `Nadeko` folder
|
||||||
|
|
||||||
|
`cd Nadeko`
|
||||||
|
- Go to [Releases][Releases] and copy the zip file address of the lalest version available, it should look like `https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
||||||
|
- Get the correct link, type `curl -O` and past the link, then hit `Enter`
|
||||||
|
- It should be something like this:
|
||||||
|
|
||||||
|
`curl -O https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
||||||
|
|
||||||
|
^ do not copy-paste it
|
||||||
|
|
||||||
|
- Unzip the downloaded file in our `Nadeko` folder
|
||||||
|
|
||||||
|
####Creating DiscordBot application
|
||||||
|
- Go to [DiscordApp][DiscordApp].
|
||||||
|
- Log in with your Discord account.
|
||||||
|
- On the left side, press `New Application`.
|
||||||
|
- Fill out the `App Name` (your bot's name, in this case), put the image you want, and add an app description(optional).
|
||||||
|
- Create the application.
|
||||||
|
- Once the application is created, click on `Create a Bot User` and confirm it.
|
||||||
|
- Keep this window open for now.
|
||||||
|
|
||||||
|
####Setting up Credentials.json file
|
||||||
|
- In our `NadekoBot` folder you should have `.json` file named `credentials_example.json`. (Note: If you do not see a **.json** after `credentials_example.json `, do not add the `**.json**`. You most likely have `"Hide file extensions"` enabled.)
|
||||||
|
- Rename `credentials_example.json` to `credentials.json`.
|
||||||
|
- Open the file with your Text editor.
|
||||||
|
- In there you will see fields like `Token`, `ClientId`, `BotId`, `OwnerIDs`.
|
||||||
|
- In your [DiscordApp][DiscordApp], under `Bot User` part, you will see the `Token:click to reveal` part, click to reveal it.
|
||||||
|
- Copy your bot's token, and put it between `" "` in your `credentials.json` file.
|
||||||
|
- Copy `Client ID` and replace it with the example one in your `credentials.json` in `Client ID` **and** `BotID` field.
|
||||||
|
- Save your `credentials.json` but keep it open. We need to put your `User ID` and owner.
|
||||||
|
|
||||||
|
####Running NadekoBot
|
||||||
|
- Copy/past and hit `Enter`
|
||||||
|
|
||||||
|
`tmux new -s nadeko`
|
||||||
|
|
||||||
|
^this will create a new session named “nadeko” `(you can replace “nadeko” with anything you prefer and remember its your
|
||||||
|
session name)`.
|
||||||
|
|
||||||
|
or if you want to use Screen, run:
|
||||||
|
|
||||||
|
`screen -S nadeko`
|
||||||
|
|
||||||
|
^this will create a new screen named “nadeko” `(you can replace “nadeko” with anything you prefer and remember its your
|
||||||
|
screen name)`.
|
||||||
|
|
||||||
|
`cd nadeko`
|
||||||
|
|
||||||
|
- Start NadekoBot.exe using Mono:
|
||||||
|
|
||||||
|
`mono NadekoBot.exe`
|
||||||
|
|
||||||
|
CHECK THE BOT IN DISCORD, IF EVERYTHING IS WORKING
|
||||||
|
|
||||||
|
Now time to move bot to background and to do that, press CTRL+B+D (this will ditach the nadeko session using TMUX)
|
||||||
|
|
||||||
|
*if you used Screen press CTRL+A+D (this will detach the nadeko screen)*
|
||||||
|
|
||||||
|
####Inviting your bot to your server - [Invite Guide][Invite Guide]
|
||||||
|
- Create a new server in Discord.
|
||||||
|
- Copy your `Client ID` from your [DiscordApp][DiscordApp].
|
||||||
|
- Replace `12345678` in this link `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
|
||||||
|
- Link should look like this: `https://discordapp.com/oauth2/authorize?client_id=**YOUR_CLENT_ID**&scope=bot&permissions=66186303`.
|
||||||
|
- Go to newly created link and pick the server we created, and click `Authorize`.
|
||||||
|
- Bot should be added to your server.
|
||||||
|
|
||||||
|
####Setting up OwnerIds
|
||||||
|
- In the server where your bot is, in a text channel, type `.uid`
|
||||||
|
- Your `User ID` should show, copy it.
|
||||||
|
- Close `NadekoBot.exe`
|
||||||
|
- Replace your `User ID` in the `credentials.json` between `[ ]` and save the changes.
|
||||||
|
- Run `NadekoBot.exe` again.
|
||||||
|
- Now you are the bot owner.
|
||||||
|
- You can add `User IDs` from the other users by separating IDs with a comma if you want to have more owners.
|
||||||
|
|
||||||
|
####Setting NadekoBot Music
|
||||||
|
|
||||||
|
For Music Setup and API keys check [Setting up NadekoBot for Music](Windows Guide.md#setting-up-nadekobot-for-music) and [JSON Explanations](JSON Explanations.md).
|
||||||
|
|
||||||
|
####Some more Info - TMUX
|
||||||
|
|
||||||
|
-If you want to see the sessions after logging back again, type `tmux ls`, and that will give you the list of sessions running.
|
||||||
|
-If you want to switch to/ see that session, type `tmux a -t nadeko` (nadeko is the name of the session we created before so, replace `“nadeko”` with the session name you created.)
|
||||||
|
-If you want to kill NadekoBot session, type `tmux kill-session -t nadeko`
|
||||||
|
|
||||||
|
####Some more Info - Screen
|
||||||
|
|
||||||
|
-If you want to see the sessions after logging back again, type `screen -ls`, and that will give you the list of screens.
|
||||||
|
-If you want to switch to/ see that screen, type `screen -r nadeko` (nadeko is the name of the screen we created before so, replace `“nadeko”` with the screen name you created.)
|
||||||
|
-If you want to kill the NadekoBot screen, type `screen -X -S nadeko quit`
|
||||||
|
|
||||||
|
[Homebrew]: http://brew.sh/
|
||||||
|
[Mono]: http://www.mono-project.com/docs/compiling-mono/mac/
|
||||||
|
[Releases]: https://github.com/Kwoth/NadekoBot/releases
|
||||||
|
[DiscordApp]: https://discordapp.com/developers/applications/me
|
||||||
|
[Atom]: https://atom.io/
|
||||||
|
[Invite Guide]: http://discord.kongslien.net/guide.html
|
||||||
|
[Google Console]: https://console.developers.google.com
|
||||||
|
[Soundcloud]: https://soundcloud.com/you/apps/new
|
||||||
@ -11,10 +11,10 @@ ________________________________________________________________________________
|
|||||||
- 5) [7zip][7zip] (or whatever you are using, WinRar)
|
- 5) [7zip][7zip] (or whatever you are using, WinRar)
|
||||||
- 6) [Notepad++][Notepad++]
|
- 6) [Notepad++][Notepad++]
|
||||||
|
|
||||||
####Guide:
|
####Guide
|
||||||
|
|
||||||
- Create a folder, name it `Nadeko`.
|
- Create a folder, name it `Nadeko`.
|
||||||
- Head to [Releases][Releases]* and download `WINDOWS.-.nadeupdater.7z`.
|
- Head to [Updater Releases Page][Updater] and download `WINDOWS.-.nadeupdater.7z`.
|
||||||
- Copy `WINDOWS.-.nadeupdater.7z` to the `Nadeko` (folder we created before) and extract everything.
|
- Copy `WINDOWS.-.nadeupdater.7z` to the `Nadeko` (folder we created before) and extract everything.
|
||||||
- You will see a file `NadekoUpdater.bat ` and a folder `publish ` after extraction.
|
- You will see a file `NadekoUpdater.bat ` and a folder `publish ` after extraction.
|
||||||
- Run/Launch/Open the file `NadekoUpdater.bat ` and you will see it running in cmd.exe asking you with **3 options** *1-3*.
|
- Run/Launch/Open the file `NadekoUpdater.bat ` and you will see it running in cmd.exe asking you with **3 options** *1-3*.
|
||||||
@ -40,11 +40,11 @@ ________________________________________________________________________________
|
|||||||
- In there you will see fields like `Token`, `ClientId`, `BotId`, `OwnerIDs`.
|
- In there you will see fields like `Token`, `ClientId`, `BotId`, `OwnerIDs`.
|
||||||
- In your [DiscordApp][DiscordApp], under `Bot User` part, you will see the `Token:click to reveal` part, click to reveal it.
|
- In your [DiscordApp][DiscordApp], under `Bot User` part, you will see the `Token:click to reveal` part, click to reveal it.
|
||||||
- Copy your bot's token, and put it between `" "` in your `credentials.json` file.
|
- Copy your bot's token, and put it between `" "` in your `credentials.json` file.
|
||||||
- Copy `Client ID` and replace it with the example one in your `credentials.json`.
|
- Copy `Client ID` and replace it with the example one in your `credentials.json` in `Client ID` **and** `BotID` field.
|
||||||
- Copy `Bot ID` and replace it with the example one in your `credentials.json`.
|
|
||||||
- Save your `credentials.json` but keep it open. We need to put your `User ID` and owner.
|
- Save your `credentials.json` but keep it open. We need to put your `User ID` and owner.
|
||||||
|
|
||||||
####Inviting your bot to your server [Invite Guide][Invite Guide]
|
####Inviting your bot to your server
|
||||||
|
- [Invite Guide][Invite Guide]
|
||||||
- Create a new server in Discord.
|
- Create a new server in Discord.
|
||||||
- Copy your `Client ID` from your [DiscordApp][DiscordApp].
|
- Copy your `Client ID` from your [DiscordApp][DiscordApp].
|
||||||
- Replace `12345678` in this link `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
|
- Replace `12345678` in this link `https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303` with your `Client ID`.
|
||||||
@ -58,7 +58,7 @@ ________________________________________________________________________________
|
|||||||
- Your bot should now be online in the server we added him to.
|
- Your bot should now be online in the server we added him to.
|
||||||
- Note: Your bot will be offline in case you close `NadekoBot.exe`.
|
- Note: Your bot will be offline in case you close `NadekoBot.exe`.
|
||||||
|
|
||||||
####Setting up OwnerIds:
|
####Setting up OwnerIds
|
||||||
- In the server where your bot is, in a text channel, type `.uid`
|
- In the server where your bot is, in a text channel, type `.uid`
|
||||||
- Your `User ID` should show, copy it.
|
- Your `User ID` should show, copy it.
|
||||||
- Close `NadekoBot.exe`
|
- Close `NadekoBot.exe`
|
||||||
@ -67,7 +67,10 @@ ________________________________________________________________________________
|
|||||||
- Now you are the bot owner.
|
- Now you are the bot owner.
|
||||||
- You can add `User IDs` from the other users by separating IDs with a comma if you want to have more owners.
|
- You can add `User IDs` from the other users by separating IDs with a comma if you want to have more owners.
|
||||||
|
|
||||||
`*Alternatively, you can download nadekobot from [Releases][Releases] and extract the zip yourself. That is what updater does, except it makes it easier for you to update because it doesn't overwrite important files. If you are downloading releases you will have to be careful about your config, credentials, and other files you edited in order to preserve your data every time you update.`
|
`*Alternatively, you can download nadekobot from` [Releases][Releases] `and extract the zip yourself.
|
||||||
|
That is what updater does, except it makes it easier for you to update because it doesn't overwrite
|
||||||
|
important files.If you are downloading releases you will have to be careful about your config,
|
||||||
|
credentials, and other files you edited in order to preserve your data every time you update.`
|
||||||
|
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
@ -80,7 +83,7 @@ ________________________________________________________________________________
|
|||||||
- Go to [Google Console][Google Console] and log in.
|
- Go to [Google Console][Google Console] and log in.
|
||||||
- Create a new project (name does not matter). Once the project is created, go into "Enable and manage APIs."
|
- Create a new project (name does not matter). Once the project is created, go into "Enable and manage APIs."
|
||||||
- Under the "Other Popular APIs" section, enable `URL Shortener API` and `Custom Search Api`. Under the `YouTube APIs` section, enable `YouTube Data API`.
|
- Under the "Other Popular APIs" section, enable `URL Shortener API` and `Custom Search Api`. Under the `YouTube APIs` section, enable `YouTube Data API`.
|
||||||
- On the left tab, access `Credentials`. Click `Create Credentials` button. Click on `API Key`, and then `Server Key` in the new window that appears. Enter in a name for the `Server Key`. A new window will appear with your `Google API key`.
|
- On the left tab, access `Credentials`. Click `Create Credentials` button. Click on `API Key`. A new window will appear with your `Google API key`.
|
||||||
- Copy the key.
|
- Copy the key.
|
||||||
- Open up `credentials.json`.
|
- Open up `credentials.json`.
|
||||||
- For `"GoogleAPIKey"`, fill in with the new key we copied.
|
- For `"GoogleAPIKey"`, fill in with the new key we copied.
|
||||||
@ -91,8 +94,9 @@ ________________________________________________________________________________
|
|||||||
- In `credentials.json`, fill in `"SoundcloudClientID"` with the copied ID.
|
- In `credentials.json`, fill in `"SoundcloudClientID"` with the copied ID.
|
||||||
- Restart your computer.
|
- Restart your computer.
|
||||||
|
|
||||||
##### Prerequisites for manual `ffmpeg` setup:
|
####Manual `ffmpeg` setup
|
||||||
**Do this step in case you were not able to install `ffmpeg` with the installer.**
|
**Do this step in case you were not able to install `ffmpeg` with the installer.**
|
||||||
|
|
||||||
- Create a folder named `ffmpeg` in your main Windows directory. We will use **C:\ffmpeg** (for our guide)
|
- Create a folder named `ffmpeg` in your main Windows directory. We will use **C:\ffmpeg** (for our guide)
|
||||||
- Download FFMPEG through the link https://ffmpeg.zeranoe.com/builds/ (download static build)
|
- Download FFMPEG through the link https://ffmpeg.zeranoe.com/builds/ (download static build)
|
||||||
- Extract it using `7zip` and place the folder `ffmpeg-xxxxx-git-xxxxx-xxxx-static` inside **C:\ffmpeg**
|
- Extract it using `7zip` and place the folder `ffmpeg-xxxxx-git-xxxxx-xxxx-static` inside **C:\ffmpeg**
|
||||||
@ -104,7 +108,8 @@ ________________________________________________________________________________
|
|||||||
[NET Framework]: https://www.microsoft.com/en-us/download/details.aspx?id=48130
|
[NET Framework]: https://www.microsoft.com/en-us/download/details.aspx?id=48130
|
||||||
[FFMPEG]: https://github.com/Soundofdarkness/FFMPEG-Installer
|
[FFMPEG]: https://github.com/Soundofdarkness/FFMPEG-Installer
|
||||||
[7zip]: http://www.7-zip.org/download.html
|
[7zip]: http://www.7-zip.org/download.html
|
||||||
[Releases]: //github.com/Kwoth/NadekoUpdater/releases/tag/v1.0
|
[Updater]: https://github.com/Kwoth/NadekoUpdater/releases
|
||||||
|
[Releases]: https://github.com/Kwoth/NadekoBot/releases
|
||||||
[DiscordApp]: https://discordapp.com/developers/applications/me
|
[DiscordApp]: https://discordapp.com/developers/applications/me
|
||||||
[Notepad++]: https://notepad-plus-plus.org/
|
[Notepad++]: https://notepad-plus-plus.org/
|
||||||
[Invite Guide]: http://discord.kongslien.net/guide.html
|
[Invite Guide]: http://discord.kongslien.net/guide.html
|
||||||
2
docs/guides/mii-chan.md
Normal file
2
docs/guides/mii-chan.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Docs are in the air.
|
||||||
|
Kwoth is magic.
|
||||||
@ -1 +1,47 @@
|
|||||||
Hai, this will be docs of nakeda
|
#NadekoBot Documentation
|
||||||
|
|
||||||
|
To invite NadekoBot to your server, click on the image bellow:
|
||||||
|
|
||||||
|
[![img][img]](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303)
|
||||||
|
|
||||||
|
In case you need any help, hop on [NadekoBot Server][NadekoBot Server], where we can provide support.
|
||||||
|
|
||||||
|
NadekoBot is an open source project, and it can be found on our [GitHub][GitHub] page.
|
||||||
|
|
||||||
|
Here you can read current [Issues][Issues].
|
||||||
|
|
||||||
|
If you want to contribute, be sure to PR on the **[dev][dev]** branch.
|
||||||
|
##Content
|
||||||
|
- [About](about.md)
|
||||||
|
- Guides
|
||||||
|
- [Windows Guide](guides/Windows Guide.md)
|
||||||
|
- [Linux Guide](guides/Linux Guide.md)
|
||||||
|
- [OSX Guide](guides/OSX Guide.md)
|
||||||
|
- [Building from Source](guides/Building from Source.md)
|
||||||
|
- [Docker Guide](guides/Docker Guide.md)
|
||||||
|
- Commands
|
||||||
|
- [Readme](Readme.md)
|
||||||
|
- [Commands List](Commands List.md)
|
||||||
|
- [Permissions System](Permissions System.md)
|
||||||
|
- [JSON Explanations](JSON Explanations.md)
|
||||||
|
- [Custom Reactions](Custom Reactions.md)
|
||||||
|
- [Frequently Asked Questions](Frequently Asked Questions.md)
|
||||||
|
- [Contribution Guide](Contribution Guide.md)
|
||||||
|
- [Donate](Donate.md)
|
||||||
|
|
||||||
|
[img]: https://discordcdn.com/attachments/202743183774318593/210580315381563392/discord.png
|
||||||
|
[NadekoBot Server]: https://discord.gg/0ehQwTK2RBjAxzEY
|
||||||
|
[GitHub]: https://github.com/Kwoth/NadekoBot
|
||||||
|
[Issues]: https://github.com/Kwoth/NadekoBot/issues
|
||||||
|
[dev]: https://github.com/Kwoth/NadekoBot/tree/dev
|
||||||
|
|
||||||
|
[Italian]: http://i.imgur.com/SsaTwOF.png?1
|
||||||
|
[Russian]: http://i.imgur.com/wf9bc5G.png?1
|
||||||
|
[German]: http://i.imgur.com/EM5qPzf.png?1
|
||||||
|
[Chinese]: http://i.imgur.com/MVCNOjT.png?1
|
||||||
|
[English]: http://i.imgur.com/jHTyZFS.png?1
|
||||||
|
[Spanish]: http://i.imgur.com/9BsusB6.png?1
|
||||||
|
[French]: http://i.imgur.com/g2ARPF6.png?1
|
||||||
|
[Dutch]: http://i.imgur.com/SadddLj.png?1
|
||||||
|
[Norwegian]: http://i.imgur.com/TCVa0V8.png?1
|
||||||
|
[Serbian]: http://i.imgur.com/5evoUbU.png
|
||||||
|
|||||||
@ -1 +0,0 @@
|
|||||||
Hai, this will be docs of nakeda
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
Copyright (c) 2015 Master Kwoth
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
@ -140,7 +140,7 @@ namespace NadekoBot.Modules.Help
|
|||||||
}
|
}
|
||||||
helpstr = helpstr.Replace(NadekoBot.Client.GetCurrentUser().Username , "@BotName");
|
helpstr = helpstr.Replace(NadekoBot.Client.GetCurrentUser().Username , "@BotName");
|
||||||
#if DEBUG
|
#if DEBUG
|
||||||
File.WriteAllText("../../docs/commandslist.md", helpstr.ToString());
|
File.WriteAllText("../../docs/Commands List.md", helpstr.ToString());
|
||||||
#else
|
#else
|
||||||
File.WriteAllText("commandlist.md", helpstr.ToString());
|
File.WriteAllText("commandlist.md", helpstr.ToString());
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@ -60,25 +60,25 @@ namespace Tests
|
|||||||
Assert.Throws(typeof(IndexOutOfRangeException), () => { root.GetAt(10); });
|
Assert.Throws(typeof(IndexOutOfRangeException), () => { root.GetAt(10); });
|
||||||
}
|
}
|
||||||
|
|
||||||
[Fact]
|
//[Fact]
|
||||||
public void InsertTest() {
|
//public void InsertTest() {
|
||||||
|
|
||||||
var root = GetRoot();
|
// var root = GetRoot();
|
||||||
|
|
||||||
root.Insert(5, new Permission() { SecondaryTargetName = "in2" });
|
// root.Insert(5, new Permission() { SecondaryTargetName = "in2" });
|
||||||
|
|
||||||
Assert.Equal(11, root.Count());
|
// Assert.Equal(11, root.Count());
|
||||||
Assert.Equal("in2", root.GetAt(5).SecondaryTargetName);
|
// Assert.Equal("in2", root.GetAt(5).SecondaryTargetName);
|
||||||
|
|
||||||
root.Insert(0, new Permission() { SecondaryTargetName = "Inserted" });
|
// root.Insert(0, new Permission() { SecondaryTargetName = "Inserted" });
|
||||||
|
|
||||||
root = root.Previous;
|
// root = root.Previous;
|
||||||
Assert.Equal("Inserted", root.SecondaryTargetName);
|
// Assert.Equal("Inserted", root.SecondaryTargetName);
|
||||||
Assert.Equal(12, root.Count());
|
// Assert.Equal(12, root.Count());
|
||||||
Assert.Equal("Root", root.GetAt(1).SecondaryTargetName);
|
// Assert.Equal("Root", root.GetAt(1).SecondaryTargetName);
|
||||||
|
|
||||||
Assert.Throws(typeof(IndexOutOfRangeException), () => { root.GetAt(12); });
|
// Assert.Throws(typeof(IndexOutOfRangeException), () => { root.GetAt(12); });
|
||||||
}
|
//}
|
||||||
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void RemoveAtTest()
|
public void RemoveAtTest()
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user