New JSON Explanations, thanks to Nekai <3
This commit is contained in:
parent
e6de6a226e
commit
8982772a80
@ -1,42 +1,60 @@
|
||||
###Credentials.json and config.json
|
||||
**This is how unedited credentials.json looks like:**
|
||||
###Setting up your Credentials
|
||||
If you do not see `credentials.json` you will need to rename `credentials_example.json` to `credentials.json`.
|
||||
|
||||
**This is how the unedited credentials look:**
|
||||
```json
|
||||
{
|
||||
"Token": "",
|
||||
"ClientId": "116275390695079945",
|
||||
"BotId": 1231231231231,
|
||||
"OwnerIds": [
|
||||
123123123123,
|
||||
5675675679845
|
||||
123123123123,
|
||||
5675675679845
|
||||
],
|
||||
"GoogleAPIKey": "",
|
||||
"SoundCloudClientID": "",
|
||||
"MashapeKey": "",
|
||||
"LOLAPIKey": "",
|
||||
"TrelloAppKey": "",
|
||||
"LOLAPIKEY": "",
|
||||
"TrelloAPPKey": "",
|
||||
"OsuAPIKey": "",
|
||||
"CarbonKey": ""
|
||||
"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.
|
||||
####Required Parts
|
||||
+ **Token** - Required to log in. Refer to this [guide](http://discord.kongslien.net/guide.html)
|
||||
+ **OwnerIds** - Required for the **Owner-Only** commands. Seperate multiple Id's with a comma.
|
||||
+ **BotId** - Required for custom reactions and conversation commands to work.
|
||||
+ **Important : Bot ID and Client ID are the same in newer bot accounts due to recent Discord API changes.**
|
||||
|
||||
*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.*
|
||||
_BotId and the OwnerIds are **NOT** the names of the owner and the bot. If you do not know the id of your bot, keep the two random numbers in those fields and
|
||||
run the bot then do `.uid @MyBotName` - this will give you your bot_id.
|
||||
Do the same for yourself with `.uid @MyName` Put these numbers in their respective field of the credentials._
|
||||
|
||||
#### 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 [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 [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** - [Champion.gg][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)
|
||||
Setting up your API keys
|
||||
====================
|
||||
####This part is completely optional, **However it is necessary for music to work properly**
|
||||
+ **GoogleAPIKey** - Required for Youtube Song Search, Playlist queuing, and URL Shortener. `~i` and `~img`.
|
||||
+ You can get this api Key [here](https://console.developers.google.com/apis)
|
||||
+ **SoundCloudClientID** - Required to queue soundloud songs from sc links.
|
||||
+ You will need to create a new app [here](http://soundcloud.com/you/apps). **Please note you must be logged into SoundCloud**
|
||||
+ You should come to a page that looks like this ![Imgur](http://i.imgur.com/RAZ2HDM.png)
|
||||
+ Simply click Register a new application and enter a name.
|
||||
+ After naming your app you will be brought to this page: ![Imgur](http://i.imgur.com/GH1gjKK.png) Copy the Client ID and click "save app" then paste the Client Id it into your `credentials.json`
|
||||
+ **MashapeKey** - Required for Urban Disctionary, Hashtag search, and Hearthstone cards.
|
||||
+ You need to create an account on their [api marketplace](https://market.mashape.com/), after that go to `market.mashape.com/YOURNAMEHERE/applications/default-application` and press **Get the keys** in the top right corner.
|
||||
+ Copy the key and paste it into `credentials.json`
|
||||
+ **LOLAPIKey** - Required for all League of Legends commands.
|
||||
+ You can get this key [here](http://api.champion.gg/)
|
||||
+ **TrelloAppKey** - Required for the trello commands.
|
||||
+ You can get this key [here](https://trello.com/app-key) **Be sure you are logged into Trello first**
|
||||
+ **OsuAPIKey** - Required for Osu commands
|
||||
+ You can get this key [here](https://osu.ppy.sh/p/api) **You will need to log in and like the soundcloud it may take a few tries**
|
||||
+ **CarbonKey** -This key is for Carobnitex.net stats.
|
||||
+ Most likely unnecessary **Needed only if your bot is listed on Carbonitex.net**
|
||||
|
||||
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 should rename `config_example.json` to `config.json`.
|
||||
Config.json
|
||||
===========
|
||||
In the folder where `NadekoBot.exe` is located you should also see a `Data` folder. In this folder you will find `config.json` among other files.
|
||||
`config.json` contains user specific commands, such as: if DM's sent to the bot are forwarded to you, Blacklisted Ids, Servers, and channels...etc.
|
||||
|
||||
[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
|
||||
**If you do not see** `config.json` **you need to rename** `config_example.json` **to** `config.json`
|
||||
|
Loading…
Reference in New Issue
Block a user