moved .md files

docs/FAQ.md

@@ -0,0 +1,40 @@
+Frequently Asked Questions
+####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
+####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.*
+####Q3: Music doesn't work on a 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?
+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?
+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?
+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?
+A: most commands have a description, with a usage guide if required; use -h command, like -h ;pr
+####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
+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?
+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?
+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) 
+A: Set a greeting message by using .greetmsg YourMessageHere 
+and a bye-message by using .byemsg YourMessageHere
+####Q15: How to import certs on linux?
+A:
+`certmgr -ssl https://discordapp.com`  
+`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? 
+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
+####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: 
+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
+####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  
+####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.

docs/about.md

@@ -0,0 +1,13 @@
+## Terms of Use
+
+The MIT License (MIT)
+
+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:
+
+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.
+
+

docs/contributionguide.md

@@ -0,0 +1,7 @@
+### How to contribute
+
+1. Make Pull Requests to **DEV BRANCH**
+2. Keep 1 Pull Request to a single feature
+3. Explain what you did in the PR message
+
+Thanks for all the help ^_^

docs/customreactions.md

@@ -0,0 +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)**
+
+`.acr` and `.dcr` require you to be a bot owner.
+
+`.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 `"`.
+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  
+`%user%` - replaces it with the user runner's mention  
+`%target%` - replaces it with a mention of another person from within the original message  
+`%rng%` replaces it with a random number  
+for example: `.acr "%mention% hello" Hello %user%`  
+(we will add much more of these over time)
+
+
+`.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).
+For example: `.dcr "hi there"` or `.dcr "hi there" 1`. You can get an index by using `.lcr [page number]`
+
+`.lcr [number]` 
+Prints a list of custom reactions. Paginated. (for example: `.lcr 1` or `.lcr 4`)

docs/explanations.md

@@ -0,0 +1,38 @@
+###Credentials.json and config.json
+**This is how unedited credentials.json looks like:**
+```json
+{
+  "Token": "",
+  "ClientId": "116275390695079945",
+  "BotId": 1231231231231,
+  "OwnerIds": [
+    123123123123,
+    5675675679845
+  ],
+  "GoogleAPIKey": "",
+  "SoundCloudClientID": "",
+  "MashapeKey": "",
+  "LOLAPIKey": "",
+  "TrelloAppKey": "",
+  "OsuAPIKey": "",
+  "CarbonKey": ""
+}
+```
+#### Required
+- **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
+- **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.*
+
+#### Optional
+- **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. 
+- **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
+- **TrelloAppKey** - Needed for trello 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)
+
+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.
+```

docs/fromsource.md

@@ -0,0 +1,8 @@
+###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)
+
+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
+
+Make sure you've read ComprehensiveGuide to get a grasp of basic config/credentials setup and then look at "Credentials and config" chapter.

docs/index.md

@@ -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](commandlist.md)
+- [Commands List](commandslist.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)

docs/permissions.md

@@ -0,0 +1,87 @@
+# Overview
+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)
+
+# 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. 
+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
+When you want to change your first permissions, you need to fulfill one of two conditions:
+* Be the owner of the server
+* Have the role set by `;permrole` (Nadeko by default)
+
+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`.
+
+# 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.
+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`.
+
+# Common Cases
+These are some common cases of particular settings of permissions.
+
+## 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.
+- `;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
+- `;rc "!!nowplaying" enable all`, enable the command for everyone
+- `;rc "!!getlink" enable all`, as above.
+- `;rc "!!listqueue" enable all`, as above.
+
+## Create a 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 enable #nsfw` re-enable the nsfw module in the #nsfw channel.
+
+
+-- *Thanks to @applemac for writing this guide*
+
+#Old Guide
+
+**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: 
+- 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 channel level (so certain commands can be limited to certain channels, which can prevent music / trivia / NSFW spam in serious channels)
+- a server level. 
+
+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.
+
+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.
+- "u" for Users.
+- "r" for Roles.
+- "c" for Channels.
+- "s" for Servers.
+
+Follow the level with whether you want to edit the permissions of a command or a module.
+- "c" for Command.
+- "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 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)
+
+###### Examples
+- **;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>.
+- **;uc "!!q" 1 [User_Name]**  Enables queuing of songs for the user, <User_Name>.
+- **;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.
+
+###### Examples 
+- ;cp [Channel_Name]
+- ;rp [Role_Name]
+
+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.