minster586/nadekobot
1
0
Fork 0
mirror of https://gitlab.com/Kwoth/nadekobot.git synced 2025-11-03 16:24:27 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fixed up jsons-explained.md (thx ala)

Browse Source
This commit is contained in:
Kwoth
2021-09-11 22:48:48 +02:00
parent ab0d013035
commit 712cb9300f
1 changed files with 81 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
docs/jsons-explained.md
View File

@@ -18,7 +18,7 @@ This part is completely optional, **however it's necessary for music and a few o
- Open up `creds.yml` and look for `GoogleAPIKey`, paste your API key after the `:`. - Open up `creds.yml` and look for `GoogleAPIKey`, paste your API key after the `:`.
- It should look like this: - It should look like this:
```yml ```yml
GoogleApiKey: "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", GoogleApiKey: "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM"
``` ```
- **MashapeKey** - **MashapeKey**
- Required for Hearthstone cards. - Required for Hearthstone cards.
@@ -42,9 +42,8 @@ This part is completely optional, **however it's necessary for music and a few o
- Select `Chat Bot` from the Category dropdown - Select `Chat Bot` from the Category dropdown
- Once created, clicking on your application will show a new Client ID field - Once created, clicking on your application will show a new Client ID field
- Copy it to your creds.yml as shown below - Copy it to your creds.yml as shown below
- *(if you're adding it as the last key inside your creds.yml, remove the trailling comma from the example below)*
```yml ```yml
TwitchClientId: "516tr61tr1qweqwe86trg3g", TwitchClientId: "516tr61tr1qweqwe86trg3g"
``` ```
- **LocationIqApiKey** - **LocationIqApiKey**
- Optional. Used only for the `.time` command. https://locationiq.com api key (register and you will receive the token in the email). - Optional. Used only for the `.time` command. https://locationiq.com api key (register and you will receive the token in the email).
@@ -75,43 +74,93 @@ RestartCommand:
For Windows (Source), Linux or OSX, add this to your `creds.yml` For Windows (Source), Linux or OSX, add this to your `creds.yml`
```yml ```yml
"RestartCommand": { RestartCommand:
"Cmd": "dotnet", Cmd: dotnet
"Args": "run -c Release" Args: "NadekoBot.dll -- {0}"
},
``` ```
--- ---
#### End Result #### End Result
**This is an example of how the `creds.yml` looks like with multiple owners, the restart command (optional) and all the API keys (also optional):** **This is an example of how the `creds.yml` looks like with multiple owners, the restart command (optional) and some of the API keys (also optional):**
```yml ```yml
{ # DO NOT CHANGE
"Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo", version: 1
"OwnerIds": [ # Bot token. Do not share with anyone ever -> https://discordapp.com/developers/applications/
105635123466156544, token: 'MTE5Nzc3MDIxMzE5NTc3NjEw.VlhNCw.BuqJFyzdIUAK1PRf1eK1Cu89Jew'
145521851676884992, # List of Ids of the users who have bot owner permissions
341420590009417729 # **DO NOT ADD PEOPLE YOU DON'T TRUST**
], ownerIds: [
"GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", 105635123466156544,
"MashapeKey": "4UrKpcWXc2mshS8RKi00000y8Kf5p1Q8kI6jsn32bmd8oVWiY7", 145521851676884992,
"OsuApiKey": "4c8c8fdff8e1234581725db27fd140a7d93320d6", 341420590009417729
"CleverbotApiKey": "", ]
"Db": null, # The number of shards that the bot will running on.
"TotalShards": 1, # Leave at 1 if you don't know what you're doing.
"PatreonAccessToken": "", totalShards: 1
"PatreonCampaignId": "334038", # Login to https://console.cloud.google.com, create a new project, go to APIs & Services -> Library -> YouTube Data API and enable it.
"RestartCommand": { # Then, go to APIs and Services -> Credentials and click Create credentials -> API key.
"Cmd": "NadekoBot.exe" # Used only for Youtube Data Api (at the moment).
}, googleApiKey: 'AIzaSyDScfdfdfi1sdlWQOWxxxxxbk0oWMEzM'
"ShardRunCommand": "", # Settings for voting system for discordbots. Meant for use on global Nadeko.
"ShardRunArguments": "", votes:
"ShardRunPort": null, url: ''
"TwitchClientId": null, key: ''
"RedisOptions": null # Patreon auto reward system settings.
} # go to https://www.patreon.com/portal -> my clients -> create client
patreon:
# Access token. You have to manually update this 1st of each month by refreshing the token on https://patreon.com/portal
accessToken: ''
# Unused atm
refreshToken: ''
# Unused atm
clientSecret: ''
# Campaign ID of your patreon page. Go to your patreon page (make sure you're logged in) and type "prompt('Campaign ID', window.patreon.bootstrap.creator.data.id);" in the console. (ctrl + shift + i)
campaignId: ''
# Api key for sending stats to DiscordBotList.
botListToken: ''
# Official cleverbot api key.
cleverbotApiKey: ''
# Redis connection string. Don't change if you don't know what you're doing.
redisOptions: localhost:6379,syncTimeout=30000,responseTimeout=30000,allowAdmin=true,password=
# Database options. Don't change if you don't know what you're doing. Leave null for default values
db:
# Database type. Only sqlite supported atm
type: sqlite
# Connection string. Will default to "Data Source=data/NadekoBot.db"
connectionString: Data Source=data/NadekoBot.db
# Address and port of the coordinator endpoint. Leave empty for default.
# Change only if you've changed the coordinator address or port.
coordinatorUrl: http://localhost:3442
# Api key obtained on https://rapidapi.com (go to MyApps -> Add New App -> Enter Name -> Application key)
rapidApiKey: 4UrKpcWXcxxxxxxxxxxxxxxp1Q8kI6jsn32xxxoVWiY7
# https://locationiq.com api key (register and you will receive the token in the email).
# Used only for .time command.
locationIqApiKey:
# https://timezonedb.com api key (register and you will receive the token in the email).
# Used only for .time command
timezoneDbApiKey:
# https://pro.coinmarketcap.com/account/ api key. There is a free plan for personal use.
# Used for cryptocurrency related commands.
coinmarketcapApiKey:
# Api key used for Osu related commands. Obtain this key at https://osu.ppy.sh/p/api
osuApiKey: 4c8c8fdffdsfdsfsdfsfa33f3f3140a7d93320d6
# Command and args which will be used to restart the bot.
# Only used if bot is executed directly (NOT through the coordinator)
# placeholders:
# {0} -> shard id
# {1} -> total shards
# Linux default
# cmd: dotnet
# args: "NadekoBot.dll -- {0}"
# Windows default
# cmd: NadekoBot.exe
# args: {0}
restartCommand:
cmd:
args:
``` ```
--- ---