diff --git a/docs/JSON Explanations.md b/docs/JSON Explanations.md index 9eedcfb2..23f6c800 100644 --- a/docs/JSON Explanations.md +++ b/docs/JSON Explanations.md @@ -16,14 +16,14 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl "MashapeKey": "4UrKpcWXc2mshS8RKi00000y8Kf5p1Q8kI6jsn32bmd8oVWiY7", "OsuApiKey": "4c8c8fdff8e1234581725db27fd140a7d93320d6", "CleverbotApiKey": "", - "PatreonAccessToken": "", - "PatreonCampaignId": "334038", "Db": null, "TotalShards": 1, + "PatreonAccessToken": "", + "PatreonCampaignId": "334038", + "RestartCommand": null, "ShardRunCommand": "", "ShardRunArguments": "", - "ShardRunPort": null, - "RestartCommand": null + "ShardRunPort": null } ``` ----- @@ -159,6 +159,9 @@ It should look like: - For Patreon creators only. - **PatreonCampaignId** - For Patreon creators only. Id of your campaign. + +##### Additional Settings + - **TotalShards** - Required if the bot will be connected to more than 1500 servers. - Most likely unnecessary to change until your bot is added to more than 1500 servers. @@ -172,7 +175,7 @@ For linux, or from the source, this is usually "RestartCommand": { "Cmd": "dotnet", "Args": "run -c Release" -} +}, ``` For windows (regular installation, or from the updater), this is usually @@ -180,8 +183,9 @@ For windows (regular installation, or from the updater), this is usually ```json "RestartCommand": { "Cmd": "NadekoBot.exe" -} +}, ``` +----- ## DB files @@ -209,6 +213,8 @@ in order to open the database file you will need [DB Browser for SQLite](http:// and that will save all the changes. +----- + ## Sharding your bot - **ShardRunCommand** diff --git a/docs/guides/From Source.md b/docs/guides/From Source.md index 5e16619d..84182f1b 100644 --- a/docs/guides/From Source.md +++ b/docs/guides/From Source.md @@ -17,13 +17,13 @@ Edit `credentials.json.` Read the JSON Exaplanations guide on the left if you do `dotnet run -c Release` ### !!! NOTE FOR WINDOWS USERS !!! -If you're running from source on windows, you will have to setup your credentials to have these 2 extra lines: +If you're running from source on windows, you will have to add these 2 extra lines to your credentials, after the first open bracket: ```js "ShardRunCommand": "dotnet", - "ShardRunArguments": "run -c Release -- {0} {1}" + "ShardRunArguments": "run -c Release -- {0} {1}", ``` [.netcore]: https://www.microsoft.com/net/download/core#/sdk [ffmpeg]: http://ffmpeg.zeranoe.com/builds/ [git]: https://git-scm.com/downloads -[redis]: https://github.com/MicrosoftArchive/redis/releases/latest \ No newline at end of file +[redis]: https://github.com/MicrosoftArchive/redis/releases/latest