mattburchett/NadekoBot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs changes

Browse Source
This commit is contained in:
samvaio 2017-06-20 16:46:55 +05:30
parent b788a5e95f
commit e7515c7adc
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/JSON Explanations.md
View File

@ -16,6 +16,7 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl
"GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM", "GoogleApiKey": "AIzaSyDSci1sdlWQOWNVj1vlXxxxxxbk0oWMEzM",
"MashapeKey": "4UrKpcWXc2mshS8RKi00000y8Kf5p1Q8kI6jsn32bmd8oVWiY7", "MashapeKey": "4UrKpcWXc2mshS8RKi00000y8Kf5p1Q8kI6jsn32bmd8oVWiY7",
"OsuApiKey": "4c8c8fdff8e1234581725db27fd140a7d93320d6", "OsuApiKey": "4c8c8fdff8e1234581725db27fd140a7d93320d6",
"PatreonAccessToken": "",
"Db": null, "Db": null,
"TotalShards": 1 "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 #### Setting up credentials.json file
![img3](http://i.imgur.com/QwKMnTG.gif) ![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. *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. - 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 ```json
"Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo", "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. - 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. - **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"`** - If that's the case, **copy the same client ID** to **`"BotId"`**
@ -69,6 +72,9 @@ It should look like:
"ClientId": 179372110000358912, "ClientId": 179372110000358912,
"BotId": 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: - 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)* *(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. - So the message `\@fearnlj01#3535` will appear as `<@145521851676884992>` after you send the message.
@ -139,7 +145,8 @@ It should look like:
- **OsuAPIKey** - **OsuAPIKey**
- Required for Osu commands - Required for Osu commands
- You can get this key [here.](https://osu.ppy.sh/p/api) - 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** - **TotalShards**
- Required if the bot will be connected to more than 1500 servers. - 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. - 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 ## DB files
Nadeko saves all the settings and infomations in `NadekoBot.db` file here: 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/). 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) - Copy the `NadekoBot.db` to someplace safe. (Back up)
- Open `NadekoBot.db` - Open `NadekoBot.db`
@ -166,6 +176,7 @@ To make changes
and that will save all the changes. and that will save all the changes.
![nadekodb](https://cdn.discordapp.com/attachments/251504306010849280/254067055240806400/nadekodb.gif) ![nadekodb](https://cdn.discordapp.com/attachments/251504306010849280/254067055240806400/nadekodb.gif)
[Google Console]: https://console.developers.google.com [Google Console]: https://console.developers.google.com

2
docs/guides/Windows Guide.md
View File

@ -3,6 +3,7 @@
#### Prerequisites #### Prerequisites
- [Notepad++][Notepad++] (or some other decent text editor) - [Notepad++][Notepad++] (or some other decent text editor)
- Windows 8 or later - 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). - [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 #### Guide
@ -31,3 +32,4 @@
[Notepad++]: https://notepad-plus-plus.org/ [Notepad++]: https://notepad-plus-plus.org/
[Invite Guide]: http://discord.kongslien.net/guide.html [Invite Guide]: http://discord.kongslien.net/guide.html
[Google Console]: https://console.developers.google.com [Google Console]: https://console.developers.google.com
[.NET Core SDK]: https://www.microsoft.com/net/core#windowscmd