Merge branch '1.0' of https://github.com/Kwoth/NadekoBot into 1.0
This commit is contained in:
commit
633a6fb5ba
@ -1,6 +1,6 @@
|
|||||||
### How to contribute
|
### How to contribute
|
||||||
|
|
||||||
1. Make Pull Requests to **DEV BRANCH**
|
1. Make Pull Requests to the **1.0 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
|
||||||
|
|
||||||
|
@ -3,68 +3,71 @@
|
|||||||
|
|
||||||
###Question 1: How do I get Nadeko to join my server?
|
###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**
|
**Answer:** Simply send Nadeko a Direct Message with -h and follow the link. **Only People with the Manage Server permission can add the bot to the server**
|
||||||
|
|
||||||
###Question 2: I want to change permissions, but it isn't working!
|
###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"))
|
**Answer:** You must have the ;permrole (by default this is the "Nadeko" role, for more details on permissions check [here](http://nadekobot.readthedocs.io/en/1.0/Permissions%20System/ "Permissions"). If you have a role called `Nadeko` but can't assign it, just create a new Role and assign that instead.)
|
||||||
|
|
||||||
**Please note:** *Only the Server Owner can change permissions without the "Nadeko" role*.
|
###Question 3: I want to disable NSFW on my server.
|
||||||
###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.
|
**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 4: How do I get NadekoFlowers/Currency?
|
||||||
###Question 7: How do I use this command?
|
----
|
||||||
|
**Answer:** You can get NadekoFlowers by 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), or gamble with for potentinal profit with `$betflip`, `$betroll` and `$jr`
|
||||||
|
|
||||||
|
###Question 5: 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` channel in the Nadeko [help server](https://discord.gg/0ehQwTK2RBjAxzEY).
|
||||||
|
|
||||||
|
If your problem or suggestion is not there, feel free to request/notify us about it either in the Issues section of GitHub for issues or in the `#suggestions` channel on the Nadeko help server for suggestions.
|
||||||
|
|
||||||
|
###Question 6: 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`.
|
**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")
|
The whole list of commands can be found [here](http://nadekobot.readthedocs.io/en/1.0/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 7: Music isn't working?
|
||||||
###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.
|
**Answer:** Music is disabled on public Nadeko due to large hosting costs, it will be re-enabled later in the future for donators.
|
||||||
|
|
||||||
|
**If you would like music in the meantime, you must host Nadeko yourself**. Be sure you have FFMPEG installed correctly, and have followed the [guide](http://nadekobot.readthedocs.io/en/1.0/guides/Windows%20Guide/) carefully.
|
||||||
|
|
||||||
|
###Question 8: 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 and rebooted since installing FFMPEG.
|
||||||
[1]: https://support.discordapp.com/hc/en-us/articles/216661717-How-do-I-change-my-Voice-Server-Region-
|
[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?
|
|
||||||
|
###Question 9: 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
|
**Answer:** Open `/data/NadekoBot.db` 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)
|
|
||||||
|
###Question 10: 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`
|
**Answer:** Set a greeting message by using `.greetmsg YourMessageHere` and a bye-message by using `.byemsg YourMessageHere`. Don't forget that `.greet` and `.bye` only apply to users joining a server, not coming online/offline.
|
||||||
###Question 12: How do I import certs on linux?
|
|
||||||
|
###Question 11: How do I import certs on linux?
|
||||||
-------
|
-------
|
||||||
**Answer:**
|
**Answer:**
|
||||||
|
|
||||||
`certmgr -ssl https://discordapp.com`
|
`certmgr -ssl https://discordapp.com`
|
||||||
|
|
||||||
`certmgr -ssl https://gateway.discord.gg`
|
`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?
|
###Question 12: 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
|
**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.
|
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!?
|
|
||||||
|
###Question 13: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
|
**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?
|
|
||||||
|
###Question 14: 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.
|
**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. [Here's](https://support.discordapp.com/hc/en-us/articles/214836687-Role-Management-101) a link to Discords role management 101.
|
||||||
|
|
||||||
**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.*
|
**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.*
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
Permissions Overview
|
Permissions Overview
|
||||||
===================
|
===================
|
||||||
Have you ever felt confused or even overwhelmed when trying to set Nadeko's permissions? In this guide we will be explaining how to use the
|
Have you ever felt confused or even overwhelmed when trying to set Nadeko's permissions? In this guide we will be explaining how to use the
|
||||||
permission commands correctly and even cover a few common questions! Every command we discuss here can be found in the [Commands List](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#permissions).
|
permission commands correctly and even cover a few common questions! Every command we discuss here can be found in the [Commands List](http://nadekobot.readthedocs.io/en/1.0/Commands%20List/#permissions).
|
||||||
|
|
||||||
**To see the old guide for versions 0.9 and below, see [here](http://nadekobot.readthedocs.io/en/stable/Permissions%20System/)**
|
**To see the old guide for versions 0.9 and below, see [here](http://nadekobot.readthedocs.io/en/latest/Permissions%20System/)**
|
||||||
|
|
||||||
Why do we use the Permissions Commands?
|
Why do we use the Permissions Commands?
|
||||||
------------------------------
|
------------------------------
|
||||||
Permissions are very handy at setting who can use what commands in a server. By default, the NSFW module is blocked, but nothing else is. If something is a bot owner only command, it can only be ran by the bot owner, the person who is running the bot, or has their id in [`credentials.json`](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/ "Setting up your credentials").
|
Permissions are very handy at setting who can use what commands in a server. By default, the NSFW module is blocked, but nothing else is. If something is a bot owner only command, it can only be ran by the bot owner, the person who is running the bot, or has their id in [`credentials.json`](http://nadekobot.readthedocs.io/en/1.0/JSON%20Explanations/ "Setting up your credentials").
|
||||||
|
|
||||||
The administration module still requires that you have the correct permissions on discord to be able to use these commands, so for users to be able to use commands like `.kick` and `.prune`, they need kick and mange messages permissions respectively.
|
The administration module still requires that you have the correct permissions on discord to be able to use these commands, so for users to be able to use commands like `.kick` and `.prune`, they need kick and mange messages permissions respectively.
|
||||||
|
|
||||||
@ -25,7 +25,7 @@ If you would like to set a different role, such as "Admins", to be the role requ
|
|||||||
|
|
||||||
Basics & Hierarchy
|
Basics & Hierarchy
|
||||||
-----
|
-----
|
||||||
The [Commands List](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#permissions) is a great resource which lists **all** the available commands, however we'll go over a few commands here.
|
The [Commands List](http://nadekobot.readthedocs.io/en/1.0/Commands%20List/#permissions) is a great resource which lists **all** the available commands, however we'll go over a few commands here.
|
||||||
|
|
||||||
Firstly, let's explain how the permissions system works - It's simple once you figure out how each command works!
|
Firstly, let's explain how the permissions system works - It's simple once you figure out how each command works!
|
||||||
The permissions system works as a chain, everytime a command is used, the permissions chain is checked. Starting from the top of the chain, the command is compared to a rule, if it isn't either allowed or disallowed by that rule it proceeds to check the next rule all the way till it reaches the bottom rule, which allows all commands.
|
The permissions system works as a chain, everytime a command is used, the permissions chain is checked. Starting from the top of the chain, the command is compared to a rule, if it isn't either allowed or disallowed by that rule it proceeds to check the next rule all the way till it reaches the bottom rule, which allows all commands.
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
- *Bot Owner Only* commands refer to the commands only the **owner** of the bot can use.
|
- *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**.
|
- *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.
|
- *Owner of the bot* is a person who is **hosting** their own bot, and their **ID** is inside of **credentials.json** file.
|
||||||
- You are **not** the bot **owner** if you invited the bot using **Carbonitex** or other invitation links.
|
- You are **not** the bot **owner** if you invited the bot using **Carbonitex** or other invitation links.
|
||||||
|
|
||||||
###Music on the public Nadeko
|
###Music on the public Nadeko
|
||||||
@ -17,11 +17,11 @@
|
|||||||
###NadekoFlowers
|
###NadekoFlowers
|
||||||
|
|
||||||
- NadekoFlowers is the **currency** of the public Nadeko.
|
- NadekoFlowers is the **currency** of the public Nadeko.
|
||||||
- NadekoFlowers can be earned by playing **trivia**, or other games, like betting games.
|
- NadekoFlowers can be `>pick`ed after Nadeko plants a flower randomly after `>gc` has been used on a channel
|
||||||
- You can give NadekoFlowers to other users, using the command `$give X @person`.
|
- You can give NadekoFlowers to other users, using the command `$give X @person`.
|
||||||
- You can only give flowers you **own**.
|
- You can only give flowers you **own**.
|
||||||
- If you want to have **unlimited** number of flowers, you will have to **host** the bot.
|
- 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*.
|
- Commands `$award X @person` and `$take 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.
|
- If you `>plant` the flower, flower will be avaliable for everyone to `>pick` it. In that case you will **lose** the flower.
|
||||||
|
|
||||||
###Manage Permissions
|
###Manage Permissions
|
||||||
|
Loading…
Reference in New Issue
Block a user