Jordan Fearnley 94ebd47d0e Fixed what I broke

Readthedocs will now build again since the `mkdocs.yml` isn't
referencing a non-existent file anymore. Not merging this means the 1.0
section of the guide will be "frozen" in place, as it currently is,
which'd allow for putting off the release of 1.0 a little longer.

Also updated the JSON Explanations to match what's now generated/used in
1.0
The `Db` section is commented out for the sake of having to change less
in the future.

2016-10-21 17:03:23 +01:00

3.3 KiB

Raw Blame History

###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:

{
  "ClientId": 123123123,
  "BotId": null,
  "Token": "",
  "OwnerIds": [
    0
  ],
  "LoLApiKey": "",
  "GoogleApiKey": "",
  "MashapeKey": "",
  "OsuApiKey": "",
  "SoundCloudClientId": "",
  "Db": null,
  "TotalShards": 1
}

####Required Parts

Token - Required to log in. Refer to this guide
OwnerIds - Required for the Owner-Only commands. Seperate multiple Id's with a comma.
BotId - Required for custom reactions to work.
- Important : Bot ID and Client ID will be the same in newer bot accounts due to recent changes by Discord.

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.

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
SoundCloudClientID - Required to queue soundloud songs from sc links.
- You will need to create a new app here. Please note you must be logged into SoundCloud
  - Simply click Register a new application and enter a name.
  - 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, 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
OsuAPIKey - Required for Osu commands
- You can get this key here You will need to log in and like the soundcloud it may take a few tries

Additional options

TotalShards - Required if the bot will be connected to more than 2500 servers
- Most likely unnecessary to change until your bot is added to more than 2000 servers
  [//]: # (+ Db - Allows for advanced database configuration ) [//]: # ( + Leave this with the null value for standard operation - change this to examples to [This is only a comment so doesn't need proper detail])

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.

If you do not see config.json you need to rename config_example.json to config.json

3.3 KiB Raw Blame History

Setting up your API keys

Additional options

Config.json

3.3 KiB

Raw Blame History