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

Docs updates

Browse Source
This commit is contained in:
Master Kwoth 2017-09-26 09:32:12 +02:00
parent f3e240280e
commit 3f76106ec1
3 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/JSON Explanations.md
View File

@ -5,7 +5,6 @@ If you do not see `credentials.json` you will need to rename `credentials_exampl
```json ```json
{ {
"ClientId": 179372110000358912, "ClientId": 179372110000358912,
"BotId": 179372110000358912,
"Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo", "Token": "MTc5MzcyXXX2MDI1ODY3MjY0.ChKs4g.I8J_R9XX0t-QY-0PzXXXiN0-7vo",
"OwnerIds": [ "OwnerIds": [
105635123466156544, 105635123466156544,
@ -71,16 +70,13 @@ 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: ##### Getting Client 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.
- If that's the case, **copy the same client ID** to **`"BotId"`**
``` ```
It should look like: It should look like:
``` ```
```json ```json
"ClientId": 179372110000358912, "ClientId": 179372110000358912,
"BotId": 179372110000358912,
``` ```
----- -----
##### Getting Owner ID*(s)*: ##### Getting Owner ID*(s)*:
@ -210,8 +206,6 @@ and that will save all the changes.
- **ShardRunPort** - **ShardRunPort**
- Bot uses a random UDP port in [5000, 6000) range for communication between shards - Bot uses a random UDP port in [5000, 6000) range for communication between shards
[Google Console]: https://console.developers.google.com [Google Console]: https://console.developers.google.com
[DiscordApp]: https://discordapp.com/developers/applications/me [DiscordApp]: https://discordapp.com/developers/applications/me
[Invite Guide]: http://discord.kongslien.net/guide.html [Invite Guide]: http://discord.kongslien.net/guide.html

14
docs/guides/From Source.md
View File

@ -1,21 +1,19 @@
Prerequisites Prerequisites
- [.net core 1.1.X][.netcore] - [.net core sdk 2.0][.netcore]
- [ffmpeg][ffmpeg] (and added to path) either download or install using your distro's package manager - [ffmpeg][ffmpeg] (and added to path) either download or install using your distro's package manager
- [git][git] - [git][git]
*Clone the repo* *Clone the repo*
`git clone -b 1.4 https://github.com/Kwoth/NadekoBot` `git clone -b 1.9 https://github.com/Kwoth/NadekoBot`
`cd NadekoBot/src/NadekoBot` `cd NadekoBot/src/NadekoBot`
Edit `credentials.json.` Read the JSON Exaplanations guide on the left if you don't know how to set it up Edit `credentials.json.` Read the JSON Exaplanations guide on the left if you don't know how to set it up
*run* *run*
`dotnet restore`
`dotnet run -c Release` `dotnet run -c Release`
*when you decide to updatein the future (might not work if you've made custom edits to the source, make sure you know how git works)* *when you decide to update in the future (might not work if you've made custom edits to the source, make sure you know how git works)*
`git pull` `git pull`
`dotnet restore` `dotnet run -c Release`
`dotnet run -c Release`
[.netcore]: https://www.microsoft.com/net/download/core#/sdk [.netcore]: https://www.microsoft.com/net/download/core#/sdk
[ffmpeg]: http://ffmpeg.zeranoe.com/builds/ [ffmpeg]: http://ffmpeg.zeranoe.com/builds/

4
docs/index.md
View File

@ -10,7 +10,7 @@ NadekoBot is an open source project, and it can be found on our [GitHub][GitHub]
Here you can read current [Issues][Issues]. Here you can read current [Issues][Issues].
If you want to contribute, be sure to PR on the **[1.4][1.4]** branch. If you want to contribute, be sure to PR on the current **[default][repo]** branch.
##Content ##Content
- [About](about.md) - [About](about.md)
@ -37,4 +37,4 @@ If you want to contribute, be sure to PR on the **[1.4][1.4]** branch.
[NadekoBot Server]: https://discord.gg/nadekobot [NadekoBot Server]: https://discord.gg/nadekobot
[GitHub]: https://github.com/Kwoth/NadekoBot [GitHub]: https://github.com/Kwoth/NadekoBot
[Issues]: https://github.com/Kwoth/NadekoBot/issues [Issues]: https://github.com/Kwoth/NadekoBot/issues
[1.4]: https://github.com/Kwoth/NadekoBot/tree/1.4 [repo]: https://github.com/Kwoth/NadekoBot