Merge pull request #697 from miraai/1.0

Mirai did stuff
This commit is contained in:
Master Kwoth 2016-10-17 00:16:10 +02:00 committed by GitHub
commit 0df380bba6
5 changed files with 15 additions and 13 deletions

View File

@ -2,7 +2,7 @@
###Important ###Important
* For modifying **global** custom reactions, the ones which will work across all the servers your bot is connected to, you **must** be a Bot Owner. * For modifying **global** custom reactions, the ones which will work across all the servers your bot is connected to, you **must** be a Bot Owner.
You must also use the commands for adding, deleting and listing these reactions in a direct message with the bot. You must also use the commands for adding, deleting and listing these reactions in a direct message with the bot.
* For modifying **local** custom reactions, the ones which will only work on the server that they are added on, require you to have the **Administrator** permission. * For modifying **local** custom reactions, the ones which will only work on the server that they are added on, it is required to have the **Administrator** permission.
You must also use the commands for adding, deleting and listing these reactions in the server you want the custom reactions to work on. You must also use the commands for adding, deleting and listing these reactions in the server you want the custom reactions to work on.
###Commands and Their Use ###Commands and Their Use

View File

@ -37,9 +37,8 @@ Setting up your API keys
+ You can get this api Key [here](https://console.developers.google.com/apis) + You can get this api Key [here](https://console.developers.google.com/apis)
+ **SoundCloudClientID** - Required to queue soundloud songs from sc links. + **SoundCloudClientID** - Required to queue soundloud songs from sc links.
+ You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud** + You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud**
+ You should come to a page that looks like this ![Imgur](http://i.imgur.com/RAZ2HDM.png)
+ Simply click Register a new application and enter a name. + Simply click Register a new application and enter a name.
+ After naming your app you will be brought to this page: ![Imgur](http://i.imgur.com/GH1gjKK.png) Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json` + Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json`
+ **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards. + **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards.
+ You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner. + You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner.
+ Copy the key and paste it into `credentials.json` + Copy the key and paste it into `credentials.json`

View File

@ -7,9 +7,9 @@ permission commands correctly and even cover a few common questions! Every comma
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/1.0/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.
With the permissions system it possible to restrict who can skip the current song, pick NadekoFlowers or use the NSFW module. With the permissions system it possible to restrict who can skip the current song, pick NadekoFlowers or use the NSFW module.
@ -19,9 +19,9 @@ To change permissions you **must** meet the following requirement:
**Have the role specified by `;permrole` (By default, this is Nadeko)** **Have the role specified by `;permrole` (By default, this is Nadeko)**
If you have an existing role called "Nadeko" but can't assign it to yourself, create a new role called "Nadeko" and assign that to yourself. If you have an existing role called `Nadeko` but can't assign it to yourself, create a new role called `Nadeko` and assign that to yourself.
If you would like to set a different role, such as "Admins", to be the role required to edit permissions, do `;permrole Admins` (you must have the current permission role to be able to do this). If you would like to set a different role, such as `Admins`, to be the role required to edit permissions, do `;permrole Admins` (you must have the current permission role to be able to do this).
Basics & Hierarchy Basics & Hierarchy
----- -----

View File

@ -8,6 +8,8 @@ In case you need any help, hop on the [NadekoBot Server][NadekoBot Server], wher
NadekoBot is an open source project, and it can be found on our [GitHub][GitHub] page. NadekoBot is an open source project, and it can be found on our [GitHub][GitHub] page.
Check the latest [Release][Release]
Here you can read current [Issues][Issues]. Here you can read current [Issues][Issues].
If you want to contribute, be sure to PR on the **[1.0][1.0]** branch. If you want to contribute, be sure to PR on the **[1.0][1.0]** branch.
@ -34,6 +36,7 @@ If you want to contribute, be sure to PR on the **[1.0][1.0]** branch.
[GitHub]: https://github.com/Kwoth/NadekoBot [GitHub]: https://github.com/Kwoth/NadekoBot
[Issues]: https://github.com/Kwoth/NadekoBot/issues [Issues]: https://github.com/Kwoth/NadekoBot/issues
[1.0]: https://github.com/Kwoth/NadekoBot/tree/1.0 [1.0]: https://github.com/Kwoth/NadekoBot/tree/1.0
[Release]: https://github.com/Kwoth/NadekoBot/releases
[Italian]: http://i.imgur.com/SsaTwOF.png?1 [Italian]: http://i.imgur.com/SsaTwOF.png?1
[Russian]: http://i.imgur.com/wf9bc5G.png?1 [Russian]: http://i.imgur.com/wf9bc5G.png?1

View File

@ -589,7 +589,7 @@
<value>ban b</value> <value>ban b</value>
</data> </data>
<data name="ban_desc" xml:space="preserve"> <data name="ban_desc" xml:space="preserve">
<value>Bans a user by id or name with an optional message.</value> <value>Bans a user by ID or name with an optional message.</value>
</data> </data>
<data name="ban_usage" xml:space="preserve"> <data name="ban_usage" xml:space="preserve">
<value>`.b "@some Guy" Your behaviour is toxic.`</value> <value>`.b "@some Guy" Your behaviour is toxic.`</value>
@ -598,7 +598,7 @@
<value>softban sb</value> <value>softban sb</value>
</data> </data>
<data name="softban_desc" xml:space="preserve"> <data name="softban_desc" xml:space="preserve">
<value>Bans and then unbans a user by id or name with an optional message. </value> <value>Bans and then unbans a user by ID or name with an optional message. </value>
</data> </data>
<data name="softban_usage" xml:space="preserve"> <data name="softban_usage" xml:space="preserve">
<value>`.sb "@some Guy" Your behaviour is toxic.`</value> <value>`.sb "@some Guy" Your behaviour is toxic.`</value>
@ -697,7 +697,7 @@
<value>setchanlname schn</value> <value>setchanlname schn</value>
</data> </data>
<data name="setchanlname_desc" xml:space="preserve"> <data name="setchanlname_desc" xml:space="preserve">
<value>Changed the name of the current channel. </value> <value>Changes the name of the current channel. </value>
</data> </data>
<data name="setchanlname_usage" xml:space="preserve"> <data name="setchanlname_usage" xml:space="preserve">
<value>`.schn NewName`</value> <value>`.schn NewName`</value>
@ -724,7 +724,7 @@
<value>die</value> <value>die</value>
</data> </data>
<data name="die_desc" xml:space="preserve"> <data name="die_desc" xml:space="preserve">
<value>Works only for the owner. Shuts the bot down.</value> <value>Works only for the bot owner. Shuts the bot down.</value>
</data> </data>
<data name="die_usage" xml:space="preserve"> <data name="die_usage" xml:space="preserve">
<value>`@NadekoBot die`</value> <value>`@NadekoBot die`</value>
@ -733,7 +733,7 @@
<value>setname newnm</value> <value>setname newnm</value>
</data> </data>
<data name="setname_desc" xml:space="preserve"> <data name="setname_desc" xml:space="preserve">
<value>Give the bot a new name. </value> <value>Gives the bot a new name. </value>
</data> </data>
<data name="setname_usage" xml:space="preserve"> <data name="setname_usage" xml:space="preserve">
<value>`.newnm BotName`</value> <value>`.newnm BotName`</value>