ok fixing mirai's PR xD
This commit is contained in:
Kwoth
parent
fd02792bfa
commit
50a8b9a80e
@ -1,40 +1,40 @@
|
|||||||
Frequently Asked Questions
|
Frequently Asked Questions
|
||||||
####Q1: How do I get @Nadeko to join my server?
|
####Q1: How do I get @Nadeko to join my server?
|
||||||
A: Send her a Direct Message with -h to get the link. Only Server Owners can allow the bot to join
|
A: Send her a Direct Message with -h to get the link. Only Server Owners can allow the bot to join
|
||||||
####Q2: I want to change permissions, but it doesn't work D:
|
####Q2: I want to change permissions, but it doesn't work D:
|
||||||
A: To change permissions, you have to set the ;permsrole (default permission role is called `Nadeko`, you can create a role named like that and assign it to yourself). *Only the owner of the server can change permissions without having this role.*
|
A: To change permissions, you have to set the ;permsrole (default permission role is called `Nadeko`, you can create a role named like that and assign it to yourself). *Only the owner of the server can change permissions without having this role.*
|
||||||
####Q3: Music doesn't work on a Mac?!
|
####Q3: Music doesn't work on a Mac?!
|
||||||
You have to build `mono` from source. <http://www.mono-project.com/docs/compiling-mono/mac/>.
|
You have to build `mono` from source. <http://www.mono-project.com/docs/compiling-mono/mac/>.
|
||||||
####Q5: I want to disable NSFW on my server, please?
|
####Q5: I want to disable NSFW on my server, please?
|
||||||
A: You would first have to be able to change permissions (see Q4 ), and then run `;sm NSFW disable`
|
A: You would first have to be able to change permissions (see Q4 ), and then run `;sm NSFW disable`
|
||||||
####Q6: How do I get NadekoFlowers/whatever I changed my currency to?
|
####Q6: How do I get NadekoFlowers/whatever I changed my currency to?
|
||||||
A: 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.
|
A: 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.
|
||||||
####Q7: I have an issue/bug/suggestion, where can I get it noticed?
|
####Q7: I have an issue/bug/suggestion, where can I get it noticed?
|
||||||
A: First of all, check https://github.com/Kwoth/NadekoBot/issues and #suggestions for your problem/improvement. If it's not there, create a new issue on https://github.com/Kwoth/NadekoBot/issues.
|
A: First of all, check https://github.com/Kwoth/NadekoBot/issues and #suggestions for your problem/improvement. If it's not there, create a new issue on https://github.com/Kwoth/NadekoBot/issues.
|
||||||
####Q8: How do I use the command XXXX?
|
####Q8: How do I use the command XXXX?
|
||||||
A: most commands have a description, with a usage guide if required; use -h command, like -h ;pr
|
A: most commands have a description, with a usage guide if required; use -h command, like -h ;pr
|
||||||
####Q9: Music doesn't work!?
|
####Q9: Music doesn't work!?
|
||||||
A: Music on @Nadeko will be re-enabled in the future, but for now your only option is to host yourself
|
A: Music on @Nadeko will be re-enabled in the future, but for now your only option is to host yourself
|
||||||
If you are hosting your own bot, make sure ffmpeg is working correctly; running ffmpeg in the commandline should have a response. see https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.md#setting-up-nadekobot-for-music for more
|
If you are hosting your own bot, make sure ffmpeg is working correctly; running ffmpeg in the commandline should have a response. see https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.md#setting-up-nadekobot-for-music for more
|
||||||
####Q10: My music is still not working/very laggy?
|
####Q10: My music is still not working/very laggy?
|
||||||
A: Try switching server location, try giving the bot permissions on the server you want to use it on.
|
A: Try switching server location, try giving the bot permissions on the server you want to use it on.
|
||||||
####Q12: I want to change data in the database (like NadekoFlowers or the pokemontypes of users, but how?
|
####Q12: I want to change data in the database (like NadekoFlowers or the pokemontypes of users, but how?
|
||||||
A: Open data/nadekobot.sqlite using sqlitebrowser (or some alternative), Browse Data, select relevant table, change data, Write changes
|
A: Open data/nadekobot.sqlite using sqlitebrowser (or some alternative), Browse Data, select relevant table, change data, Write changes
|
||||||
####Q13: The .greet and .bye commands doesn't work, but everything else is (From @Kong)
|
####Q13: The .greet and .bye commands doesn't work, but everything else is (From @Kong)
|
||||||
A: Set a greeting message by using .greetmsg YourMessageHere
|
A: Set a greeting message by using .greetmsg YourMessageHere
|
||||||
and a bye-message by using .byemsg YourMessageHere
|
and a bye-message by using .byemsg YourMessageHere
|
||||||
####Q15: How to import certs on linux?
|
####Q15: How to import certs on linux?
|
||||||
A:
|
A:
|
||||||
`certmgr -ssl https://discordapp.com`
|
`certmgr -ssl https://discordapp.com`
|
||||||
`certmgr -ssl https://gateway.discord.gg`
|
`certmgr -ssl https://gateway.discord.gg`
|
||||||
####Q16: I want "BOT" tag with my bot and I can't follow up with Q14, is there a simple way?
|
####Q16: I want "BOT" tag with my bot and I can't follow up with Q14, is there a simple way?
|
||||||
A: Yes, you can create an application using your account and use the APP BOT USER TOKEN from here: https://discordapp.com/developers/applications/me
|
A: Yes, you can create an application using your account and use the APP BOT USER TOKEN from here: https://discordapp.com/developers/applications/me
|
||||||
NOTE: This will create a new bot account
|
NOTE: This will create a new bot account
|
||||||
####Q17: I made an application following Q16, but I can't add that new bot to my server, how do I invite it to my server?
|
####Q17: I made an application following Q16, but I can't add that new bot to my server, how do I invite it to my server?
|
||||||
A: 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:
|
A: 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
|
https://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303
|
||||||
FOLLOW THIS DETAILED GUIDE IF IT IS HARD FOR YOU TO UNDERSTAND http://discord.kongslien.net/guide.html
|
FOLLOW THIS DETAILED GUIDE IF IT IS HARD FOR YOU TO UNDERSTAND http://discord.kongslien.net/guide.html
|
||||||
####Q18: I'm building NadekoBot from source, but I get hundreds of (namespace) errors without changing anything!?
|
####Q18: I'm building NadekoBot from source, but I get hundreds of (namespace) errors without changing anything!?
|
||||||
A: 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
|
A: 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
|
||||||
####Q19: My bot has all permissions but it's still saying, "Failed to add roles. Bot has insufficient permissions.", how do I fix this?
|
####Q19: My bot has all permissions but it's still saying, "Failed to add roles. Bot has insufficient permissions.", how do I fix this?
|
||||||
A: Discord has added few new features and roles now follow hierarchy, that means you need to place your bot role above every-other role your server has. Also do NOTE that bot can only set/add all roles below its own highest role. And can not assign it's "highest role" to anyone else.
|
A: Discord has added few new features and roles now follow hierarchy, that means you need to place your bot role above every-other role your server has. Also do NOTE that bot can only set/add all roles below its own highest role. And can not assign it's "highest role" to anyone else.
|
||||||
@ -1,13 +1,13 @@
|
|||||||
## Terms of Use
|
## Terms of Use
|
||||||
|
|
||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2016 NadekoBot Team
|
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:
|
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 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.
|
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,7 +1,7 @@
|
|||||||
### How to contribute
|
### How to contribute
|
||||||
|
|
||||||
1. Make Pull Requests to **DEV BRANCH**
|
1. Make Pull Requests to **DEV BRANCH**
|
||||||
2. Keep 1 Pull Request to a single feature
|
2. Keep 1 Pull Request to a single feature
|
||||||
3. Explain what you did in the PR message
|
3. Explain what you did in the PR message
|
||||||
|
|
||||||
Thanks for all the help ^_^
|
Thanks for all the help ^_^
|
||||||
@ -1,21 +1,21 @@
|
|||||||
**After you add/delete custom commands, you should restart the bot. (either by typing `.restart` if you are on WINDOWS or just manually restarting if you prefer/are on other platform)**
|
**After you add/delete custom commands, you should restart the bot. (either by typing `.restart` if you are on WINDOWS or just manually restarting if you prefer/are on other platform)**
|
||||||
|
|
||||||
`.acr` and `.dcr` require you to be a bot owner.
|
`.acr` and `.dcr` require you to be a bot owner.
|
||||||
|
|
||||||
`.acr`
|
`.acr`
|
||||||
Adds a new custom command. **If you add multiple commands with the same name, it will pick random one.** First argument is the name, second one is the response. For example `.acr hello hi`. Now the bot will reply `hi` whenever someone types `hello`. For more than 1 word command, wrap it in `"`.
|
Adds a new custom command. **If you add multiple commands with the same name, it will pick random one.** First argument is the name, second one is the response. For example `.acr hello hi`. Now the bot will reply `hi` whenever someone types `hello`. For more than 1 word command, wrap it in `"`.
|
||||||
For example: `.acr "hello there" hi there` - now it will print "hi there" whenever someone types "hello there". Currently you can add this placeholders which will get replaced with appropriate text:
|
For example: `.acr "hello there" hi there` - now it will print "hi there" whenever someone types "hello there". Currently you can add this placeholders which will get replaced with appropriate text:
|
||||||
`%mention%` - replaces it with bot mention
|
`%mention%` - replaces it with bot mention
|
||||||
`%user%` - replaces it with the user runner's mention
|
`%user%` - replaces it with the user runner's mention
|
||||||
`%target%` - replaces it with a mention of another person from within the original message
|
`%target%` - replaces it with a mention of another person from within the original message
|
||||||
`%rng%` replaces it with a random number
|
`%rng%` replaces it with a random number
|
||||||
for example: `.acr "%mention% hello" Hello %user%`
|
for example: `.acr "%mention% hello" Hello %user%`
|
||||||
(we will add much more of these over time)
|
(we will add much more of these over time)
|
||||||
|
|
||||||
|
|
||||||
`.dcr "command name" (optional index)`
|
`.dcr "command name" (optional index)`
|
||||||
Deletes either whole custom command and all its responses or a single command's response via an index (if you have multiple responses for the same command).
|
Deletes either whole custom command and all its responses or a single command's response via an index (if you have multiple responses for the same command).
|
||||||
For example: `.dcr "hi there"` or `.dcr "hi there" 1`. You can get an index by using `.lcr [page number]`
|
For example: `.dcr "hi there"` or `.dcr "hi there" 1`. You can get an index by using `.lcr [page number]`
|
||||||
|
|
||||||
`.lcr [number]`
|
`.lcr [number]`
|
||||||
Prints a list of custom reactions. Paginated. (for example: `.lcr 1` or `.lcr 4`)
|
Prints a list of custom reactions. Paginated. (for example: `.lcr 1` or `.lcr 4`)
|
||||||
@ -1,38 +1,38 @@
|
|||||||
###Credentials.json and config.json
|
###Credentials.json and config.json
|
||||||
**This is how unedited credentials.json looks like:**
|
**This is how unedited credentials.json looks like:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"Token": "",
|
"Token": "",
|
||||||
"ClientId": "116275390695079945",
|
"ClientId": "116275390695079945",
|
||||||
"BotId": 1231231231231,
|
"BotId": 1231231231231,
|
||||||
"OwnerIds": [
|
"OwnerIds": [
|
||||||
123123123123,
|
123123123123,
|
||||||
5675675679845
|
5675675679845
|
||||||
],
|
],
|
||||||
"GoogleAPIKey": "",
|
"GoogleAPIKey": "",
|
||||||
"SoundCloudClientID": "",
|
"SoundCloudClientID": "",
|
||||||
"MashapeKey": "",
|
"MashapeKey": "",
|
||||||
"LOLAPIKey": "",
|
"LOLAPIKey": "",
|
||||||
"TrelloAppKey": "",
|
"TrelloAppKey": "",
|
||||||
"OsuAPIKey": "",
|
"OsuAPIKey": "",
|
||||||
"CarbonKey": ""
|
"CarbonKey": ""
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
#### Required
|
#### Required
|
||||||
- **Token** - Required to log in. See this [guide](http://discord.kongslien.net/guide.html)
|
- **Token** - Required to log in. See this [guide](http://discord.kongslien.net/guide.html)
|
||||||
- **OwnerIds** - Required for Owner-Only commands to work. Separate multiple IDs with a comma
|
- **OwnerIds** - Required for Owner-Only commands to work. Separate multiple IDs with a comma
|
||||||
- **BotId** - Required for custom reactions and conversation commands to work.
|
- **BotId** - Required for custom reactions and conversation commands to work.
|
||||||
|
|
||||||
*BotId and OwnerIds are NOT names of the owner and the bot. If you do not know the id of your bot, put 2 random numbers in those fields, run the bot and do `.uid @MyBotName` - that will give you your bot\_id, do the same for yourself `.uid @MyName` and you will get a number to put inside brackets in OwnerIds field.*
|
*BotId and OwnerIds are NOT names of the owner and the bot. If you do not know the id of your bot, put 2 random numbers in those fields, run the bot and do `.uid @MyBotName` - that will give you your bot\_id, do the same for yourself `.uid @MyName` and you will get a number to put inside brackets in OwnerIds field.*
|
||||||
|
|
||||||
#### Optional
|
#### Optional
|
||||||
- **GoogleAPIKey** - Youtube song search. Playlist queuing. URL Shortener. ~i and ~img.
|
- **GoogleAPIKey** - Youtube song search. Playlist queuing. URL Shortener. ~i and ~img.
|
||||||
- **SoundCloudClientID** - Needed in order to queue soundcloud songs from sc links. For the Soundcloud Api key you need a Soundcloud account. You need to create a new app on http://soundcloud.com/you/apps/new and after that go here http://soundcloud.com/you/apps click on the name of your created your app and copy the Client ID. Paste it into credentials.json.
|
- **SoundCloudClientID** - Needed in order to queue soundcloud songs from sc links. For the Soundcloud Api key you need a Soundcloud account. You need to create a new app on http://soundcloud.com/you/apps/new and after that go here http://soundcloud.com/you/apps click on the name of your created your app and copy the Client ID. Paste it into credentials.json.
|
||||||
- **MashapeKey** - Urban dictionary, hashtag search, hearthstone cards.You need to create an account on their api marketplace here https://market.mashape.com/. After that you need to go to market.mashape.com/YOURNAMEHERE/applications/default-application and press GET THE KEYS in the right top corner copy paste it into your credentials.json and you are ready to race!
|
- **MashapeKey** - Urban dictionary, hashtag search, hearthstone cards.You need to create an account on their api marketplace here https://market.mashape.com/. After that you need to go to market.mashape.com/YOURNAMEHERE/applications/default-application and press GET THE KEYS in the right top corner copy paste it into your credentials.json and you are ready to race!
|
||||||
- **LOLAPIKey** - www.champion.gg api key needed for LoL commands
|
- **LOLAPIKey** - www.champion.gg api key needed for LoL commands
|
||||||
- **TrelloAppKey** - Needed for trello commands
|
- **TrelloAppKey** - Needed for trello commands
|
||||||
- **OsuAPIKey** - needed for osu top5 and beatmap commands.
|
- **OsuAPIKey** - needed for osu top5 and beatmap commands.
|
||||||
- **CarbonKey** - carbonitex.net key if your bot is listed there in order to send stats (probably nobody needs this)
|
- **CarbonKey** - carbonitex.net key if your bot is listed there in order to send stats (probably nobody needs this)
|
||||||
|
|
||||||
Next to your exe you must also have a data folder in which there is config.json (among other things) which will contain some user specific config, like should the Bot join servers, should DMs to bot be forwarded to you and a list of IDs of blacklisted users, channels and servers. If you do not have config.json, you can should config_example.json to config.json.
|
Next to your exe you must also have a data folder in which there is config.json (among other things) which will contain some user specific config, like should the Bot join servers, should DMs to bot be forwarded to you and a list of IDs of blacklisted users, channels and servers. If you do not have config.json, you can should config_example.json to config.json.
|
||||||
```
|
```
|
||||||
@ -1,8 +1,8 @@
|
|||||||
###Building from Source
|
###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 [Comprehensive Guide](https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.md)
|
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 [Comprehensive Guide](https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.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.
|
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
|
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.
|
Make sure you've read ComprehensiveGuide to get a grasp of basic config/credentials setup and then look at "Credentials and config" chapter.
|
||||||
@ -1,113 +1,113 @@
|
|||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
*Thanks to @Flatbread and Mirai for making this guide*
|
*Thanks to @Flatbread and Mirai for making this guide*
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
### Setting Up NadekoBot on Windows
|
### Setting Up NadekoBot on Windows
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
- 1) [NET Framework][NET Framework] 4.5.2 (or 4.6)
|
- 1) [NET Framework][NET Framework] 4.5.2 (or 4.6)
|
||||||
- 2) [FFMPEG][FFMPEG]
|
- 2) [FFMPEG][FFMPEG]
|
||||||
- 3) Google Account
|
- 3) Google Account
|
||||||
- 4) Soundcloud Account (if you want soundcloud support)
|
- 4) Soundcloud Account (if you want soundcloud support)
|
||||||
- 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 [Releases][Releases]* 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*.
|
||||||
- 1) Stable release - current stable release, but might not contain all the newest Nadeko updates.
|
- 1) Stable release - current stable release, but might not contain all the newest Nadeko updates.
|
||||||
- 2) Newest release - release with all features/upgrades.
|
- 2) Newest release - release with all features/upgrades.
|
||||||
- 3) Exit
|
- 3) Exit
|
||||||
- Press `2` on your keyboard and hit `Enter`. Type `y` and hit `Enter` again. Downloading might take a while, so just be patient and wait. When download is done, press `3` on your keyboard and close the updater.
|
- Press `2` on your keyboard and hit `Enter`. Type `y` and hit `Enter` again. Downloading might take a while, so just be patient and wait. When download is done, press `3` on your keyboard and close the updater.
|
||||||
- You should have a new folder named `NadekoBot` inside the `Nadeko` folder we previously created.
|
- You should have a new folder named `NadekoBot` inside the `Nadeko` folder we previously created.
|
||||||
|
|
||||||
####Creating DiscordBot application
|
####Creating DiscordBot application
|
||||||
- Go to [DiscordApp][DiscordApp].
|
- Go to [DiscordApp][DiscordApp].
|
||||||
- Log in with your Discord account.
|
- Log in with your Discord account.
|
||||||
- On the left side, press `New Application`.
|
- 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).
|
- 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.
|
- Create the application.
|
||||||
- Once the application is created, click on `Create a Bot User` and confirm it.
|
- Once the application is created, click on `Create a Bot User` and confirm it.
|
||||||
- Keep this window open for now.
|
- Keep this window open for now.
|
||||||
|
|
||||||
####Setting up Credentials.json file
|
####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.)
|
- 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`.
|
- Rename `credentials_example.json` to `credentials.json`.
|
||||||
- Open the file with your [Notepad++][Notepad++].
|
- Open the file with your [Notepad++][Notepad++].
|
||||||
- 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`.
|
||||||
- Copy `Bot ID` and replace it with the example one in your `credentials.json`.
|
- 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`.
|
||||||
- Link should look like this: `https://discordapp.com/oauth2/authorize?client_id=**YOUR_CLENT_ID**&scope=bot&permissions=66186303`.
|
- 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`.
|
- Go to newly created link and pick the server we created, and click `Authorize`.
|
||||||
- Bot should be added to your server.
|
- Bot should be added to your server.
|
||||||
|
|
||||||
####Starting the bot
|
####Starting the bot
|
||||||
- Enter your `NadekoBot` folder that should be (hopefully) in your `Nadeko` folder.
|
- Enter your `NadekoBot` folder that should be (hopefully) in your `Nadeko` folder.
|
||||||
- Run `NadekoBot.exe` (Note: There is `NadekoBot.exe` and `NadekoBot.exe.config`, dont run the second one)
|
- Run `NadekoBot.exe` (Note: There is `NadekoBot.exe` and `NadekoBot.exe.config`, dont run the second one)
|
||||||
- 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`
|
||||||
- Replace your `User ID` in the `credentials.json` between `[ ]` and save the changes.
|
- Replace your `User ID` in the `credentials.json` between `[ ]` and save the changes.
|
||||||
- Run `NadekoBot.exe` again.
|
- Run `NadekoBot.exe` again.
|
||||||
- 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.`
|
||||||
|
|
||||||
________________________________________________________________________________
|
________________________________________________________________________________
|
||||||
|
|
||||||
#### Setting Up NadekoBot For Music
|
#### Setting Up NadekoBot For Music
|
||||||
##### Prerequisites
|
##### Prerequisites
|
||||||
- 1) [FFMPEG][FFMPEG] installed.
|
- 1) [FFMPEG][FFMPEG] installed.
|
||||||
- 2) Setting up API keys.
|
- 2) Setting up API keys.
|
||||||
|
|
||||||
- Follow these steps on how to setup Google API keys:
|
- Follow these steps on how to setup Google API keys:
|
||||||
- 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`, 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`.
|
||||||
- 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.
|
||||||
- Follow these steps on how to setup Soundcloud API key:
|
- Follow these steps on how to setup Soundcloud API key:
|
||||||
- Go to [Soundcloud][Soundcloud].
|
- Go to [Soundcloud][Soundcloud].
|
||||||
- Enter a name for the app and create it.
|
- Enter a name for the app and create it.
|
||||||
- You will see a page with the title of your app, and a field labeled `Client ID`. Copy the ID.
|
- You will see a page with the title of your app, and a field labeled `Client ID`. Copy the ID.
|
||||||
- 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:
|
##### Prerequisites for 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**
|
||||||
- Before proceeding, check out this gif to set up `ffmpeg` PATH correctly http://i.imgur.com/aR5l1Hn.gif *(thanks to PooPeePants#7135)*
|
- Before proceeding, check out this gif to set up `ffmpeg` PATH correctly http://i.imgur.com/aR5l1Hn.gif *(thanks to PooPeePants#7135)*
|
||||||
- Go to My Computer, right click and select Properties. On the left tab, select Advanced System Settings. Under the Advanced tab, select Environmental Variables near the bottom. One of the variables should be called "Path". Add a semi-colon (;) to the end followed by your FFMPEG's **bin** install location (**for example C:\ffmpeg\ffmpeg-xxxxx-git-xxxxx-xxxx-static\bin**). Save and close.
|
- Go to My Computer, right click and select Properties. On the left tab, select Advanced System Settings. Under the Advanced tab, select Environmental Variables near the bottom. One of the variables should be called "Path". Add a semi-colon (;) to the end followed by your FFMPEG's **bin** install location (**for example C:\ffmpeg\ffmpeg-xxxxx-git-xxxxx-xxxx-static\bin**). Save and close.
|
||||||
- Setup your API keys as explained above.
|
- Setup your API keys as explained above.
|
||||||
- Restart your computer.
|
- Restart your computer.
|
||||||
|
|
||||||
[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
|
[Releases]: //github.com/Kwoth/NadekoUpdater/releases/tag/v1.0
|
||||||
[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
|
||||||
[Google Console]: https://console.developers.google.com
|
[Google Console]: https://console.developers.google.com
|
||||||
[Soundcloud]: https://soundcloud.com/you/apps/new
|
[Soundcloud]: https://soundcloud.com/you/apps/new
|
||||||
@ -1,54 +1,54 @@
|
|||||||
# 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]
|
||||||
- $5
|
- $5
|
||||||
- Common sense
|
- Common sense
|
||||||
|
|
||||||
#####Guide
|
#####Guide
|
||||||
- Click on the create droplet button
|
- Click on the create droplet button
|
||||||
|
|
||||||
|
|
||||||
- Pick one click apps and select docker on 14.04
|
- Pick one click apps and select docker on 14.04
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Pick any droplet size you want (5$ will work ok-ish on a few servers)
|
- Pick any droplet size you want (5$ will work ok-ish on a few servers)
|
||||||
- Pick location closest to your discord server's location
|
- Pick location closest to your discord server's location
|
||||||
- Pick a hostname
|
- Pick a hostname
|
||||||
|
|
||||||
|
|
||||||
- Click create
|
- Click create
|
||||||
|
|
||||||
You will get an email from DigitalOcean with your credentials now.
|
You will get an email from DigitalOcean with your credentials now.
|
||||||
|
|
||||||
Open putty and type ip adress **you got in your email** with port 22
|
Open putty and type ip adress **you got in your email** with port 22
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Console will open and you will be prompted for a username, type `root`.
|
- Console will open and you will be prompted for a username, type `root`.
|
||||||
- Type in the password you got in the email.
|
- Type in the password you got in the email.
|
||||||
- Confirm the password you just typed in.
|
- Confirm the password you just typed in.
|
||||||
- Type in the new password.
|
- Type in the new password.
|
||||||
- Confirm new password.
|
- Confirm new password.
|
||||||
|
|
||||||
- When you are successfully logged in, type
|
- When you are successfully logged in, type
|
||||||
`docker run --name nadeko -v /nadeko:/config uirel/nadeko`
|
`docker run --name nadeko -v /nadeko:/config uirel/nadeko`
|
||||||
|
|
||||||
- Wait for it to download and at one point it is going to start throwing errors due to `credentials.json` being empty
|
- Wait for it to download and at one point it is going to start throwing errors due to `credentials.json` being empty
|
||||||
- CTRL+C to exit that
|
- CTRL+C to exit that
|
||||||
- Type `docker stop nadeko`
|
- Type `docker stop nadeko`
|
||||||
- Type `nano /nadeko/credentials.json` and type in your `credentials`
|
- Type `nano /nadeko/credentials.json` and type in your `credentials`
|
||||||
- CTRL+X then CTRL+Y to save
|
- CTRL+X then CTRL+Y to save
|
||||||
- Type `docker start nadeko`
|
- Type `docker start nadeko`
|
||||||
- Type `docker logs -f nadeko` to see the console output
|
- Type `docker logs -f nadeko` to see the console output
|
||||||
|
|
||||||
**Your bot is running, enjoy! o/**
|
**Your bot is running, enjoy! o/**
|
||||||
|
|
||||||
*When you want to update the bot, just type `docker restart nadeko` as it always downloads latest prerelease*
|
*When you want to update the bot, just type `docker restart nadeko` as it always downloads latest prerelease*
|
||||||
|
|
||||||
[reflink]: http://m.do.co/c/46b4d3d44795/
|
[reflink]: http://m.do.co/c/46b4d3d44795/
|
||||||
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
||||||
[guide]: http://discord.kongslien.net/guide.html
|
[guide]: http://discord.kongslien.net/guide.html
|
||||||
@ -1,8 +1,8 @@
|
|||||||
###Building from Source
|
###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 [Comprehensive Guide](https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.md)
|
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 [Comprehensive Guide](https://github.com/Kwoth/NadekoBot/blob/master/ComprehensiveGuide.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.
|
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
|
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.
|
Make sure you've read ComprehensiveGuide to get a grasp of basic config/credentials setup and then look at "Credentials and config" chapter.
|
||||||
@ -1,258 +1,258 @@
|
|||||||
#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.
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
- Download [PuTTY][PuTTY]
|
- Download [PuTTY][PuTTY]
|
||||||
- Download [CyberDuck][CyberDuck]
|
- Download [CyberDuck][CyberDuck]
|
||||||
|
|
||||||
#### Follow these steps
|
#### Follow these steps
|
||||||
|
|
||||||
- **Open PuTTY.exe** that you downloaded before, and paste or enter your `IP address` and then click **Open**.
|
- **Open PuTTY.exe** that you downloaded before, and paste or enter your `IP address` and then click **Open**.
|
||||||
If you entered your Droplets IP address correctly, it should show **login as:** in a newly opened window.
|
If you entered your Droplets IP address correctly, it should show **login as:** in a newly opened window.
|
||||||
- Now for **login as:**, type `root` and hit enter.
|
- Now for **login as:**, type `root` and hit enter.
|
||||||
- It should then, ask for password, type the `root password` you have received in your **email address registered with Digital Ocean**, then hit Enter.
|
- It should then, ask for password, type the `root password` you have received in your **email address registered with Digital Ocean**, then hit Enter.
|
||||||
|
|
||||||
*(as you are running it for the first time, it will most likely to ask you to change your root password, for that, type the "password you received through email", hit Enter, enter a "new password", hit Enter and confirm that "new password" again.*
|
*(as you are running it for the first time, it will most likely to ask you to change your root password, for that, type the "password you received through email", hit Enter, enter a "new password", hit Enter and confirm that "new password" again.*
|
||||||
**SAVE that new password somewhere safe not just in mind**. After you done that, you are ready to write commands.
|
**SAVE that new password somewhere safe not just in mind**. After you done that, you are ready to write commands.
|
||||||
|
|
||||||
**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])
|
######MONO (Source: [Mono Source][Mono Source])
|
||||||
|
|
||||||
**1) Installing Mono**
|
**1) Installing Mono**
|
||||||
|
|
||||||
`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`
|
||||||
|
|
||||||
**2.5)**
|
**2.5)**
|
||||||
*ONLY DEBIAN 8 and later*
|
*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`
|
||||||
|
|
||||||
**2.6)**
|
**2.6)**
|
||||||
*ONLY CentOS 7, Fedora 19 (and later)*
|
*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/`
|
||||||
|
|
||||||
**3)**
|
**3)**
|
||||||
*Mono Devel*
|
*Mono Devel*
|
||||||
|
|
||||||
`apt-get install mono-devel`
|
`apt-get install mono-devel`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
|
|
||||||
**4)**
|
**4)**
|
||||||
Opus Voice Codec
|
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**
|
||||||
|
|
||||||
**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:**
|
**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`
|
`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`
|
||||||
`apt-get install ca-certificates-mono`
|
`apt-get install ca-certificates-mono`
|
||||||
`mozroots --import --sync`
|
`mozroots --import --sync`
|
||||||
|
|
||||||
|
|
||||||
####FFMPEG
|
####FFMPEG
|
||||||
|
|
||||||
**6)**
|
**6)**
|
||||||
`apt-get install ffmpeg`
|
`apt-get install ffmpeg`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
NOTE: if its "not installing" then, follow the guide here: [FFMPEG Help Guide][FFMPEG Help Guide]
|
NOTE: if its "not installing" then, follow the guide here: [FFMPEG Help Guide][FFMPEG Help Guide]
|
||||||
|
|
||||||
**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`
|
||||||
|
|
||||||
**If you are running Debian 8 Jessie, please, follow these steps:**
|
**If you are running Debian 8 Jessie, please, follow these steps:**
|
||||||
|
|
||||||
`wget http://luxcaeli.de/installer.sh && sudo bash installer.sh` (Thanks to Eleria<3)
|
`wget http://luxcaeli.de/installer.sh && sudo bash installer.sh` (Thanks to Eleria<3)
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
**7)**
|
**7)**
|
||||||
`apt-get install ufw`
|
`apt-get install ufw`
|
||||||
|
|
||||||
**it is most likely to have it already installed so if you see it is already installed, check with following command, and/or enable it**
|
**it is most likely to have it already installed so if you see it is already installed, check with following command, and/or enable it**
|
||||||
|
|
||||||
**8)**
|
**8)**
|
||||||
`ufw status`
|
`ufw status`
|
||||||
|
|
||||||
**9)**
|
**9)**
|
||||||
`ufw enable`
|
`ufw enable`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
**10)**
|
**10)**
|
||||||
`sudo ufw allow ssh`
|
`sudo ufw allow ssh`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**11)**
|
**11)**
|
||||||
Unzip
|
Unzip
|
||||||
|
|
||||||
`apt-get install unzip`
|
`apt-get install unzip`
|
||||||
|
|
||||||
**12)**
|
**12)**
|
||||||
TMUX
|
TMUX
|
||||||
|
|
||||||
`apt-get install tmux`
|
`apt-get install tmux`
|
||||||
|
|
||||||
**Type** `y` **hit Enter**
|
**Type** `y` **hit Enter**
|
||||||
|
|
||||||
####Importing certs
|
####Importing 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)**
|
||||||
|
|
||||||
|
|
||||||
**15)**
|
**15)**
|
||||||
Create a new folder “nadeko” or anything you prefer
|
Create a new folder “nadeko” or anything you prefer
|
||||||
|
|
||||||
`mkdir nadeko`
|
`mkdir nadeko`
|
||||||
|
|
||||||
**16)**
|
**16)**
|
||||||
Move to “nadeko” folder (note `cd --` to go back the directory)
|
Move to “nadeko” folder (note `cd --` to go back the directory)
|
||||||
|
|
||||||
`cd nadeko`
|
`cd nadeko`
|
||||||
|
|
||||||
####Getting NadekoBot 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`
|
||||||
|
|
||||||
**17)**
|
**17)**
|
||||||
Get the correct link, type `wget`, then *paste the link*, then hit **Enter**.
|
Get the correct link, type `wget`, then *paste the link*, then hit **Enter**.
|
||||||
|
|
||||||
`wget https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
`wget https://github.com/Kwoth/NadekoBot/releases/download/vx.xx/NadekoBot.vx.x.zip`
|
||||||
|
|
||||||
**^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**
|
||||||
|
|
||||||
####Setting up NadekoBot
|
####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.
|
||||||
- You should see **FTP (File Transfer Protocol)** in drop-down.
|
- You should see **FTP (File Transfer Protocol)** in drop-down.
|
||||||
- Change it to **SFTP (SSH File Transfer Protocol)**
|
- Change it to **SFTP (SSH File Transfer Protocol)**
|
||||||
- Now, in **Server:** paste or type in your `Digital Ocean Droplets IP address`, leave `Port: 22` (no need to change it)
|
- Now, in **Server:** paste or type in your `Digital Ocean Droplets IP address`, leave `Port: 22` (no need to change it)
|
||||||
- In **Username:** type `root`
|
- In **Username:** type `root`
|
||||||
- In **Password:** type `the new root password (you changed at the start)`
|
- In **Password:** type `the new root password (you changed at the start)`
|
||||||
- Click on **Connect**
|
- Click on **Connect**
|
||||||
- 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
|
#####MAKE SURE YOU READ THE README BEFORE PROCEEDING
|
||||||
|
|
||||||
- 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: [Readme][Readme]
|
||||||
- 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.
|
||||||
|
|
||||||
####Running NadekoBot
|
####Running NadekoBot
|
||||||
|
|
||||||
Go back to **PuTTY**, `(hope its still running xD)`
|
Go back to **PuTTY**, `(hope its still running xD)`
|
||||||
|
|
||||||
**19)**
|
**19)**
|
||||||
Type/ Copy and hit **Enter**.
|
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`
|
||||||
|
|
||||||
**20)**
|
**20)**
|
||||||
`mono NadekoBot.exe`
|
`mono NadekoBot.exe`
|
||||||
|
|
||||||
**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.
|
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.
|
||||||
|
|
||||||
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 in case):
|
####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)**
|
**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`
|
||||||
|
|
||||||
####How to restart Nadeko with the server (for science)
|
####How to restart Nadeko with the server (for science)
|
||||||
**22)**
|
**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.
|
||||||
|
|
||||||
####Updating Nadeko
|
####Updating Nadeko
|
||||||
|
|
||||||
**FOLLOW THESE STEPS SERIALLY**
|
**FOLLOW THESE STEPS SERIALLY**
|
||||||
|
|
||||||
- **-21 OR 22**
|
- **-21 OR 22**
|
||||||
- **-19**
|
- **-19**
|
||||||
- **-16**
|
- **-16**
|
||||||
- **-17**
|
- **-17**
|
||||||
- **-18**
|
- **-18**
|
||||||
- **-20**
|
- **-20**
|
||||||
|
|
||||||
HIT **CTRL+B+D** and close **PuTTY**
|
HIT **CTRL+B+D** and close **PuTTY**
|
||||||
|
|
||||||
`IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER`
|
`IF YOU FACE ANY TROUBLE ANYWHERE IN THE GUIDE JUST FIND US IN NADEKO'S DISCORD SERVER`
|
||||||
|
|
||||||
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
[PuTTY]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
|
||||||
[CyberDuck]: https://cyberduck.io
|
[CyberDuck]: https://cyberduck.io
|
||||||
[Linux Setup Video]: https://www.youtube.com/watch?v=icV4_WPqPQk&feature=youtu.be
|
[Linux Setup Video]: https://www.youtube.com/watch?v=icV4_WPqPQk&feature=youtu.be
|
||||||
[Releases]: https://github.com/Kwoth/NadekoBot/releases
|
[Releases]: https://github.com/Kwoth/NadekoBot/releases
|
||||||
[Readme]: https://github.com/Kwoth/NadekoBot/blob/master/README.md
|
[Readme]: https://github.com/Kwoth/NadekoBot/blob/master/README.md
|
||||||
[FFMPEG Help Guide]: http://www.faqforge.com/linux/how-to-install-ffmpeg-on-ubuntu-14-04/
|
[FFMPEG Help Guide]: http://www.faqforge.com/linux/how-to-install-ffmpeg-on-ubuntu-14-04/
|
||||||
[Mono Source]: http://www.mono-project.com/docs/getting-started/install/linux/
|
[Mono Source]: http://www.mono-project.com/docs/getting-started/install/linux/
|
||||||
[DigitalOcean]: http://m.do.co/c/46b4d3d44795/
|
[DigitalOcean]: http://m.do.co/c/46b4d3d44795/
|
||||||
@ -1,16 +1,16 @@
|
|||||||
#NadekoBot Documentation
|
#NadekoBot Documentation
|
||||||
|
|
||||||
##Content
|
##Content
|
||||||
- [About](about.md)
|
- [About](about.md)
|
||||||
- Guides
|
- Guides
|
||||||
- [Windows Guide](guides/comprehensiveguide.md)
|
- [Windows Guide](guides/comprehensiveguide.md)
|
||||||
- [Linux Guide](guides/linuxguide.md)
|
- [Linux Guide](guides/linuxguide.md)
|
||||||
- [OSX Guide](guides/macguide.md)
|
- [OSX Guide](guides/macguide.md)
|
||||||
- [Building from Source](guides/fromsource.md)
|
- [Building from Source](guides/fromsource.md)
|
||||||
- [Docker Guide](guides/dockerguide.md)
|
- [Docker Guide](guides/dockerguide.md)
|
||||||
- [Commands List](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md)
|
- [Commands List](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md)
|
||||||
- [Permissions System](permissions.md)
|
- [Permissions System](permissions.md)
|
||||||
- [JSON Explanations](explanations.md)
|
- [JSON Explanations](explanations.md)
|
||||||
- [Custiom Reactions](customreactions.md)
|
- [Custiom Reactions](customreactions.md)
|
||||||
- [Frequently Asked Questions](FAQ.md)
|
- [Frequently Asked Questions](FAQ.md)
|
||||||
- [Contribution Guide](contributionguide.md)
|
- [Contribution Guide](contributionguide.md)
|
||||||
@ -1,18 +1,18 @@
|
|||||||
site_name: NadekoBot
|
site_name: NadekoBot
|
||||||
pages:
|
pages:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- About: about.md
|
- About: about.md
|
||||||
- Guides:
|
- Guides:
|
||||||
- Windows Guide: guides/comprehensiveguide.md
|
- Windows Guide: guides/comprehensiveguide.md
|
||||||
- Linux Guide: guides/linuxguide.md
|
- Linux Guide: guides/linuxguide.md
|
||||||
- OSX Guide: guides/macguide.md
|
- OSX Guide: guides/macguide.md
|
||||||
- Building from Source: guides/fromsource.md
|
- Building from Source: guides/fromsource.md
|
||||||
- Docker Guide: guides/dockerguide.md
|
- Docker Guide: guides/dockerguide.md
|
||||||
- Commands List: https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md
|
- Commands List: https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md
|
||||||
- Permissions System: permissions.md
|
- Permissions System: permissions.md
|
||||||
- JSON Explanations: explanations.md
|
- JSON Explanations: explanations.md
|
||||||
- Custom Commands: customreactions.md
|
- Custom Commands: customreactions.md
|
||||||
- Frequently Asked Questions: FAQ.md
|
- Frequently Asked Questions: FAQ.md
|
||||||
- Contribution Guide: contributionguide.md
|
- Contribution Guide: contributionguide.md
|
||||||
|
|
||||||
theme: readthedocs
|
theme: readthedocs
|
||||||
@ -1,87 +1,87 @@
|
|||||||
# Overview
|
# Overview
|
||||||
Ever stuck handling your Nadeko permissions? Look no further than this guide!
|
Ever stuck handling your Nadeko permissions? Look no further than this guide!
|
||||||
We'll handle a few example cases that we've seen frequently on the help channel, as well as explaining the order of permissions in general. Any command used here can be found in the [Commands list](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md#permissions)
|
We'll handle a few example cases that we've seen frequently on the help channel, as well as explaining the order of permissions in general. Any command used here can be found in the [Commands list](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md#permissions)
|
||||||
|
|
||||||
# How does it work?
|
# How does it work?
|
||||||
Permissions are handy to set up to limit who in your server can use what. by default, every command is enabled for everyone, except for the administration commands, like `.kick` and `.prune`, which are set to correspond to discord's permissions, (kicking and managing messages respectively here), the permissions module, which we will show in the next paragraph, and some other commands throughout the other modules that are owner-only, meaning that only someone who has his or her id in the list of owners of the bot can use them.
|
Permissions are handy to set up to limit who in your server can use what. by default, every command is enabled for everyone, except for the administration commands, like `.kick` and `.prune`, which are set to correspond to discord's permissions, (kicking and managing messages respectively here), the permissions module, which we will show in the next paragraph, and some other commands throughout the other modules that are owner-only, meaning that only someone who has his or her id in the list of owners of the bot can use them.
|
||||||
Since you may not want to allow everyone to use the NSFW module, skip the current song, pick up flowers, or attack in the pokegame, you're in need of setting up permissions.
|
Since you may not want to allow everyone to use the NSFW module, skip the current song, pick up flowers, or attack in the pokegame, you're in need of setting up permissions.
|
||||||
|
|
||||||
#First time setting up
|
#First time setting up
|
||||||
When you want to change your first permissions, you need to fulfill one of two conditions:
|
When you want to change your first permissions, you need to fulfill one of two conditions:
|
||||||
* Be the owner of the server
|
* Be the owner of the server
|
||||||
* Have the role set by `;permrole` (Nadeko by default)
|
* Have the role set by `;permrole` (Nadeko by default)
|
||||||
|
|
||||||
If you have neither of these, you **can't** set up permissions.
|
If you have neither of these, you **can't** set up permissions.
|
||||||
You may want to change the `;permrole` to the role of the admins, using `;permrole Admins`.
|
You may want to change the `;permrole` to the role of the admins, using `;permrole Admins`.
|
||||||
|
|
||||||
# Basics
|
# Basics
|
||||||
Most of the commands found in the list are pretty much self-explanatory. `;rolemdl NSFW disable lurkers` would disable the NSFW module for the lurkers (let them come out of the shadows!). similarly `;chnlperms #general` would show which permissions are banned *specifically* for this channel.
|
Most of the commands found in the list are pretty much self-explanatory. `;rolemdl NSFW disable lurkers` would disable the NSFW module for the lurkers (let them come out of the shadows!). similarly `;chnlperms #general` would show which permissions are banned *specifically* for this channel.
|
||||||
Since permissions are enabled by default, the hierarchy of rulings is simple, if you disable something that affects a user, like `;sm nsfw disable`, you **can't** enable it in a particular other way, like `;cm nsfw enable #nsfw`. Now roles are an exemption to this, e.g. if all roles have music disabled except for the DJ role, you can still use music commands if you have the DJ role.
|
Since permissions are enabled by default, the hierarchy of rulings is simple, if you disable something that affects a user, like `;sm nsfw disable`, you **can't** enable it in a particular other way, like `;cm nsfw enable #nsfw`. Now roles are an exemption to this, e.g. if all roles have music disabled except for the DJ role, you can still use music commands if you have the DJ role.
|
||||||
|
|
||||||
By default, the bot notifies when a command can't be used. To disable this, you can use `;verbose false`.
|
By default, the bot notifies when a command can't be used. To disable this, you can use `;verbose false`.
|
||||||
|
|
||||||
# Common Cases
|
# Common Cases
|
||||||
These are some common cases of particular settings of permissions.
|
These are some common cases of particular settings of permissions.
|
||||||
|
|
||||||
## Create a music DJ
|
## Create a music DJ
|
||||||
e.g. you only want your users to be able to see what's playing, and have a DJ role for the rest.
|
e.g. you only want your users to be able to see what's playing, and have a DJ role for the rest.
|
||||||
- `;arc music disable all`, disable all commands of the music module for everyone.
|
- `;arc music disable all`, disable all commands of the music module for everyone.
|
||||||
- `;arc music enable DJ`, give permissions to the DJ to do everything
|
- `;arc music enable DJ`, give permissions to the DJ to do everything
|
||||||
- `;rc "!!nowplaying" enable all`, enable the command for everyone
|
- `;rc "!!nowplaying" enable all`, enable the command for everyone
|
||||||
- `;rc "!!getlink" enable all`, as above.
|
- `;rc "!!getlink" enable all`, as above.
|
||||||
- `;rc "!!listqueue" enable all`, as above.
|
- `;rc "!!listqueue" enable all`, as above.
|
||||||
|
|
||||||
## Create a NSFW channel
|
## Create a NSFW channel
|
||||||
You want to only allow NSFW commands in the #nsfw channel.
|
You want to only allow NSFW commands in the #nsfw channel.
|
||||||
- `;cm nsfw disable all` disable the nsfw module in every channel.
|
- `;cm nsfw disable all` disable the nsfw module in every channel.
|
||||||
- `;cm nsfw enable #nsfw` re-enable the nsfw module in the #nsfw channel.
|
- `;cm nsfw enable #nsfw` re-enable the nsfw module in the #nsfw channel.
|
||||||
|
|
||||||
|
|
||||||
-- *Thanks to @applemac for writing this guide*
|
-- *Thanks to @applemac for writing this guide*
|
||||||
|
|
||||||
#Old Guide
|
#Old Guide
|
||||||
|
|
||||||
**NadekoBot's permissions can be set up to be very specific through commands in the Permissions module.**
|
**NadekoBot's permissions can be set up to be very specific through commands in the Permissions module.**
|
||||||
|
|
||||||
Each command or module can be turned on or off at:
|
Each command or module can be turned on or off at:
|
||||||
- a user level (so specific users can or cannot use a command/module)
|
- a user level (so specific users can or cannot use a command/module)
|
||||||
- a role level (so only certain roles have access to certain commands/module)
|
- a role level (so only certain roles have access to certain commands/module)
|
||||||
- a channel level (so certain commands can be limited to certain channels, which can prevent music / trivia / NSFW spam in serious channels)
|
- a channel level (so certain commands can be limited to certain channels, which can prevent music / trivia / NSFW spam in serious channels)
|
||||||
- a server level.
|
- a server level.
|
||||||
|
|
||||||
Use .modules to see a list of modules (sets of commands).
|
Use .modules to see a list of modules (sets of commands).
|
||||||
Use .commands [module_name] to see a list of commands in a certain module.
|
Use .commands [module_name] to see a list of commands in a certain module.
|
||||||
|
|
||||||
Permissions use a semicolon as the prefix, so always start the command with a ;.
|
Permissions use a semicolon as the prefix, so always start the command with a ;.
|
||||||
|
|
||||||
Follow the semicolon with the letter of the level which you want to edit.
|
Follow the semicolon with the letter of the level which you want to edit.
|
||||||
- "u" for Users.
|
- "u" for Users.
|
||||||
- "r" for Roles.
|
- "r" for Roles.
|
||||||
- "c" for Channels.
|
- "c" for Channels.
|
||||||
- "s" for Servers.
|
- "s" for Servers.
|
||||||
|
|
||||||
Follow the level with whether you want to edit the permissions of a command or a module.
|
Follow the level with whether you want to edit the permissions of a command or a module.
|
||||||
- "c" for Command.
|
- "c" for Command.
|
||||||
- "m" for Module.
|
- "m" for Module.
|
||||||
|
|
||||||
Follow with a space and then the command or module name (surround the command with quotation marks if there is a space within the command, for example "!!q" or "!!n").
|
Follow with a space and then the command or module name (surround the command with quotation marks if there is a space within the command, for example "!!q" or "!!n").
|
||||||
|
|
||||||
Follow that with another space and, to enable it, type one of the following: [1, true, t, enable], or to disable it, one of the following: [0, false, f, disable].
|
Follow that with another space and, to enable it, type one of the following: [1, true, t, enable], or to disable it, one of the following: [0, false, f, disable].
|
||||||
|
|
||||||
Follow that with another space and the name of the user, role, channel. (depending on the first letter you picked)
|
Follow that with another space and the name of the user, role, channel. (depending on the first letter you picked)
|
||||||
|
|
||||||
###### Examples
|
###### Examples
|
||||||
- **;rm NSFW 0 [Role_Name]** Disables the NSFW module for the role, <Role_Name>.
|
- **;rm NSFW 0 [Role_Name]** Disables the NSFW module for the role, <Role_Name>.
|
||||||
- **;cc "!!n" 0 [Channel_Name]** Disables skipping to the next song in the channel, <Channel_Name>.
|
- **;cc "!!n" 0 [Channel_Name]** Disables skipping to the next song in the channel, <Channel_Name>.
|
||||||
- **;uc "!!q" 1 [User_Name]** Enables queuing of songs for the user, <User_Name>.
|
- **;uc "!!q" 1 [User_Name]** Enables queuing of songs for the user, <User_Name>.
|
||||||
- **;sm Gambling 0** Disables gambling in the server.
|
- **;sm Gambling 0** Disables gambling in the server.
|
||||||
|
|
||||||
Check permissions by using the letter of the level you want to check followed by a p, and then the name of the level in which you want to check. If there is no name, it will default to yourself for users, the @everyone role for roles, and the channel in which the command is sent for channels.
|
Check permissions by using the letter of the level you want to check followed by a p, and then the name of the level in which you want to check. If there is no name, it will default to yourself for users, the @everyone role for roles, and the channel in which the command is sent for channels.
|
||||||
|
|
||||||
###### Examples
|
###### Examples
|
||||||
- ;cp [Channel_Name]
|
- ;cp [Channel_Name]
|
||||||
- ;rp [Role_Name]
|
- ;rp [Role_Name]
|
||||||
|
|
||||||
Insert an **a** before the level to edit the permission for all commands / modules for all users / roles / channels / server.
|
Insert an **a** before the level to edit the permission for all commands / modules for all users / roles / channels / server.
|
||||||
|
|
||||||
Reference the Help command (-h) for more Permissions related commands.
|
Reference the Help command (-h) for more Permissions related commands.
|
||||||
@ -1 +0,0 @@
|
|||||||
Hai, this will be docs of nakeda
|
|
||||||
Loading…
Reference in New Issue
Block a user