mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

JSON Explanations fixes

Browse Source
This commit is contained in:
miraai 2016-08-04 01:57:28 +02:00 committed by GitHub
parent 863723dbde
commit ad89cf35b9
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/JSON Explanations.md
View File

@ -27,12 +27,16 @@
#### Optional #### Optional
- **GoogleAPIKey** - Youtube song search. Playlist queuing. URL Shortener. ~i and ~img. - **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. - **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 [SoundcloudApp][SoundcloudApp] and after that go here [Your SC Apps][Your SC 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! - **MashapeKey** - Urban dictionary, hashtag search, hearthstone cards.You need to create an account on their api marketplace here [Mashape][Mashape]. 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 - **LOLAPIKey** - [Champion.gg][Champion.gg] api key needed for LoL commands
- **TrelloAppKey** - Needed for trello commands - **TrelloAppKey** - Needed for trello commands
- **OsuAPIKey** - needed for osu top5 and beatmap 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) - **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. Next to your exe you must also have a `data folder` in which there is `config.jso`n (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`.
```
[SoundcloudApp]: http://soundcloud.com/you/apps/new
[Your SC Apps]: http://soundcloud.com/you/apps
[Mashape]: https://market.mashape.com/
[Champion.gg]: www.champion.gg