Merge pull request #544 from miraai/dev

Added Readme for Commands List
This commit is contained in:
Master Kwoth 2016-08-06 20:54:57 +02:00 committed by GitHub
commit fbe27ab4b3
4 changed files with 34 additions and 22 deletions

28
docs/Readme.md Normal file
View File

@ -0,0 +1,28 @@
##Readme for Commands List
###Bot Owner Only
- *Bot Owner Only* commands refer to the commands only the **owner** of the bot can use.
- *Bot Owner Only* commands do **not** refer to the owner of the **server**, just the owner of the **bot**.
- *Owner of the bot* is a person who is **hosting** his own bot, and his **ID** is inside of **credentials.json** file.
###Music on the public Nadeko
- In case you got Nadeko in your server by the invitation from **Carbonitex**, our **GitHub** invite or **help (-h)**, music is disabled.
- Music is **disabled** due to large maintenance expenses, unless Kwoth is **testing** music module.
- If you want to have music module on your server, you will have to **host** the bot on your PC, or any of the external servers.
- How to **host** the bot, check the **guides** on the left side.
###NadekoFlowers
- NadekoFlowers is the **currency** of the public Nadeko.
- NadekoFlowers can be earned by playing **trivia**, or other games, like betting games.
- You can give NadekoFlowers to other users, using the command `$give X @person`.
- You can only give flowers you **own**.
- If you want to have **unlimited** number of flowers, you will have to **host** the bot.
- Command `$award X @person` can only be used by the *bot owner*.
- If you `>plant` the flower, flower will be avaliable for everyone to `>pick` it. In that case you will **lose** the flower.
###Manage Permissions
**These permissions refer to the permissions you can set in Discord settings for individual users or roles.**

View File

@ -19,6 +19,8 @@ If you want to contribute, be sure to PR on the **[dev][dev]** branch.
- [Building from Source](guides/Building from Source.md)
- [Docker Guide](guides/Docker Guide.md)
- [DigitalOcean Guide](guides/DigitalOcean Guide.md)
- Commands
- [Readme](Readme.md)
- [Commands List](Commands List.md)
- [Permissions System](Permissions System.md)
- [JSON Explanations](JSON Explanations.md)

View File

@ -1,20 +0,0 @@
site_name: NadekoBot
pages:
- Home: index.md
- About: about.md
- Guides:
- Windows Guide: guides/Windows Guide.md
- Linux Guide: guides/Linux Guide.md
- OSX Guide: guides/OSX Guide.md
- Building from Source: guides/Building from Source.md
- Docker Guide: guides/Docker Guide.md
- DigitalOcean Guide: guides/DigitalOcean Guide.md
- Commands List: Commands List.md
- Permissions System: Permissions System.md
- JSON Explanations: JSON Explanations.md
- Custom Commands: Custom Reactions.md
- Frequently Asked Questions: Frequently Asked Questions.md
- Contribution Guide: Contribution Guide.md
- ❤ Donate ❤: Donate.md
theme: readthedocs

View File

@ -10,6 +10,8 @@ pages:
- Building from Source: guides/Building from Source.md
- Docker Guide: guides/Docker Guide.md
- DigitalOcean Guide: guides/DigitalOcean Guide.md
- Commands:
- Readme: Readme.md
- Commands List: Commands List.md
- Permissions System: Permissions System.md
- JSON Explanations: JSON Explanations.md