From e7515c7adc23c30292653aaed5ccb5035426d167 Mon Sep 17 00:00:00 2001 From: samvaio Date: Tue, 20 Jun 2017 16:46:55 +0530 Subject: [PATCH 1/4] Docs changes --- docs/JSON Explanations.md | 19 +++++++++++++++---- docs/guides/Windows Guide.md | 2 ++ 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/JSON Explanations.md b/docs/JSON Explanations.md index 363c5e8d..8186b76f 100644 --- a/docs/JSON Explanations.md +++ b/docs/JSON Explanations.md @@ -16,6 +16,7 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl "GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", "MashapeKey": "4UrKpcWXc2mshS8RKi00000y8Kf5p1Q8kI6jsn32bmd8oVWiY7", "OsuApiKey": "4c8c8fdff8e1234581725db27fd140a7d93320d6", + "PatreonAccessToken": "", "Db": null, "TotalShards": 1 } @@ -50,7 +51,8 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl #### Setting up credentials.json file ![img3](http://i.imgur.com/QwKMnTG.gif) -- In your [Discord applications page][DiscordApp], under the `Bot User` section, you will see `Token:click to reveal`, click to reveal the token. +##### Getting Bot's Token: +- In your [Discord applications page][DiscordApp], under the **`APP BOT USER`** section, you will see `Token:click to reveal`, click to reveal the token. *Note: Make sure that you actually use a Token and not a Client Secret!* It is in the **App Bot User** section. - Copy your bot's token, and on the **`"Token"`** line of your `credentials.json`, paste your bot token **between** the quotation marks. ``` @@ -59,6 +61,7 @@ It should look like: ```json "Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo", ``` +##### Getting Client and Bot ID: - Copy the `Client ID` on the page and replace the `12312123` part of the **`"ClientId"`** line with it. - **Important: Bot ID and Client ID** will be the same in **newer bot accounts** due to recent changes by Discord. - If that's the case, **copy the same client ID** to **`"BotId"`** @@ -69,6 +72,9 @@ It should look like: "ClientId": 179372110000358912, "BotId": 179372110000358912, ``` +----- +##### Getting Owner ID*(s)*: + - Go to your Discord server and attempt to mention yourself, but put a backslash at the start like shown below: *(to make it slightly easier, add the backslash after you type the mention out)* - So the message `\@fearnlj01#3535` will appear as `<@145521851676884992>` after you send the message. @@ -139,7 +145,8 @@ It should look like: - **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.* +- **PatreonAccessToken** + - For Patreon creators only. - **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. @@ -149,10 +156,13 @@ It should look like: ## DB files Nadeko saves all the settings and infomations in `NadekoBot.db` file here: -`NadekoBot\src\NadekoBot\bin\Release\netcoreapp1.1\data\NadekoBot.db` (NadekoBot v1.4x) +`NadekoBot\src\NadekoBot\bin\Release\netcoreapp1.1\data\NadekoBot.db` (macOS and Linux) +`NadekoBot\system\data` (Windows) in order to open the database file you will need [DB Browser for SQLite](http://sqlitebrowser.org/). -To make changes +*NOTE: You don't have to worry if you don't have `NadekoBot.db` file, it gets auto created once you run the bot successfully.* + +**To make changes:** - Copy the `NadekoBot.db` to someplace safe. (Back up) - Open `NadekoBot.db` @@ -166,6 +176,7 @@ To make changes and that will save all the changes. + ![nadekodb](https://cdn.discordapp.com/attachments/251504306010849280/254067055240806400/nadekodb.gif) [Google Console]: https://console.developers.google.com diff --git a/docs/guides/Windows Guide.md b/docs/guides/Windows Guide.md index 3e0b640b..91b4d45b 100644 --- a/docs/guides/Windows Guide.md +++ b/docs/guides/Windows Guide.md @@ -3,6 +3,7 @@ #### Prerequisites - [Notepad++][Notepad++] (or some other decent text editor) - Windows 8 or later +- [.NET Core SDK (Command line / other)][.NET Core SDK] - [Create Discord Bot application](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/#creating-discord-bot-application) and [Invite the bot to your server](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/#inviting-your-bot-to-your-server). #### Guide @@ -31,3 +32,4 @@ [Notepad++]: https://notepad-plus-plus.org/ [Invite Guide]: http://discord.kongslien.net/guide.html [Google Console]: https://console.developers.google.com +[.NET Core SDK]: https://www.microsoft.com/net/core#windowscmd From f7168ab3db9cbe55c8c3e8ce5beb5386ee7c6d4c Mon Sep 17 00:00:00 2001 From: samvaio Date: Tue, 20 Jun 2017 16:52:14 +0530 Subject: [PATCH 2/4] json file changes --- src/NadekoBot/credentials.json | 2 +- src/NadekoBot/credentials_example.json | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/NadekoBot/credentials.json b/src/NadekoBot/credentials.json index f5d38551..efa8b57d 100644 --- a/src/NadekoBot/credentials.json +++ b/src/NadekoBot/credentials.json @@ -9,7 +9,7 @@ "GoogleApiKey": "", "MashapeKey": "", "OsuApiKey": "", - "SoundCloudClientId": "", + "PatreonAccessToken": "", "Db": null, "TotalShards": 1 } \ No newline at end of file diff --git a/src/NadekoBot/credentials_example.json b/src/NadekoBot/credentials_example.json index 912b452a..e9ec0b12 100644 --- a/src/NadekoBot/credentials_example.json +++ b/src/NadekoBot/credentials_example.json @@ -1,19 +1,19 @@ { "ClientId": 123123123, + "BotId": null, "Token": "", "OwnerIds": [ - 0 + 105635576866156544 ], "LoLApiKey": "", "GoogleApiKey": "", "MashapeKey": "", "OsuApiKey": "", - "SoundCloudClientId": "", + "PatreonAccessToken": "", "CarbonKey": "", "Db": { "Type": "sqlite", "ConnectionString": "Filename=./data/NadekoBot.db" }, - "TotalShards": 1, - "PatreonAccessToken": "" + "TotalShards": 1 } \ No newline at end of file From e64104fa7afec34755e2d023f26ae605e241bf4c Mon Sep 17 00:00:00 2001 From: samvaio Date: Tue, 20 Jun 2017 19:08:07 +0530 Subject: [PATCH 3/4] credentials location info added --- docs/JSON Explanations.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/JSON Explanations.md b/docs/JSON Explanations.md index 8186b76f..2ac629e8 100644 --- a/docs/JSON Explanations.md +++ b/docs/JSON Explanations.md @@ -49,6 +49,11 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl #### Setting up credentials.json file +**For Windows** you can find `credentials.json` file in `NadekoBot\system` folder. +e.g. `C:\Program Files\NadekoBot\system` +**For Linux** you can find `credentials.json` in `NadekoBot/src/NadekoBot` folder. +e.g. `/root/NadekoBot/src/NadekoBot` + ![img3](http://i.imgur.com/QwKMnTG.gif) ##### Getting Bot's Token: @@ -156,7 +161,7 @@ It should look like: ## DB files Nadeko saves all the settings and infomations in `NadekoBot.db` file here: -`NadekoBot\src\NadekoBot\bin\Release\netcoreapp1.1\data\NadekoBot.db` (macOS and Linux) +`NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.1/data/NadekoBot.db` (macOS and Linux) `NadekoBot\system\data` (Windows) in order to open the database file you will need [DB Browser for SQLite](http://sqlitebrowser.org/). From 4b954df56d5587315526d58398acdc318aed48ea Mon Sep 17 00:00:00 2001 From: Master Kwoth Date: Tue, 20 Jun 2017 22:01:27 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae4aa579..825366c3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![img](https://ci.appveyor.com/api/projects/status/gmu6b3ltc80hr3k9?svg=true) [![Discord](https://discordapp.com/api/guilds/117523346618318850/widget.png)](https://discord.gg/nadekobot) [![Documentation Status](https://readthedocs.org/projects/nadekobot/badge/?version=latest)](http://nadekobot.readthedocs.io/en/latest/?badge=latest) -[![nadeko0](https://cdn.discordapp.com/attachments/266240393639755778/281920716809699328/part1.png)](http://nadekobot.xyz) +[![nadeko0](https://cdn.discordapp.com/attachments/266240393639755778/281920716809699328/part1.png)](https://nadekobot.me) [![nadeko1](https://cdn.discordapp.com/attachments/266240393639755778/281920134967328768/part2.png)](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303) [![nadeko2](https://cdn.discordapp.com/attachments/266240393639755778/281920161311883264/part3.png)](http://nadekobot.readthedocs.io/en/latest/Commands%20List/)