added config.json to readme

This commit is contained in:
Master Kwoth 2016-03-04 12:46:03 +01:00
parent babae13deb
commit 6417f41953

View File

@ -8,6 +8,8 @@ You might want to join my discord server where i can provide help etc. https://d
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. 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.
**This is how the credentials.json should look like:** **This is how the credentials.json should look like:**
```json ```json
{ {
@ -34,6 +36,17 @@ In your bin/debug folder (or next to your exe if you are using release version),
"OwnerIds":[123123123123, 1231231232], "OwnerIds":[123123123123, 1231231232],
} }
``` ```
#### data/config.json example
```json
{
"DontJoinServers": false,
"ForwardMessages": true,
"ServerBlacklist": [],
"ChannelBlacklist": [],
"UserBlacklist": []
}
```
- 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 copy the numbers in their respective fields. - 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 copy the numbers in their respective fields.
- For google api key, you need to enable URL shortner, Youtube video search **and custom search** in the [dev console](https://console.developers.google.com/). - For google api key, you need to enable URL shortner, Youtube video search **and custom search** in the [dev console](https://console.developers.google.com/).
- 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. - 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.