diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 00000000..05e7f87f --- /dev/null +++ b/docs/Readme.md @@ -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.** \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 8341a11f..596d7d37 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,7 +19,9 @@ 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 List](Commands List.md) +- Commands + - [Readme](Readme.md) + - [Commands List](Commands List.md) - [Permissions System](Permissions System.md) - [JSON Explanations](JSON Explanations.md) - [Custiom Reactions](Custom Reactions.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 6e4cc1ef..00000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index a58ddc93..b5ef799c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,7 +10,9 @@ pages: - 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 +- Commands: + - Readme: Readme.md + - Commands List: Commands List.md - Permissions System: Permissions System.md - JSON Explanations: JSON Explanations.md - Custom Commands: Custom Reactions.md