From 7e4b55ccac053cf34652493370e1647c0fba2f30 Mon Sep 17 00:00:00 2001 From: shivaco Date: Fri, 22 Sep 2017 16:43:07 +0600 Subject: [PATCH 1/5] Make PRs to 1.9 branch? --- docs/Contribution Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Contribution Guide.md b/docs/Contribution Guide.md index 3dff9b35..ca0cd94f 100644 --- a/docs/Contribution Guide.md +++ b/docs/Contribution Guide.md @@ -1,6 +1,6 @@ ### How to contribute -1. Make Pull Requests to the [**dev BRANCH**](https://github.com/Kwoth/NadekoBot/tree/dev). +1. Make Pull Requests to the [**1.9 BRANCH**](https://github.com/Kwoth/NadekoBot/tree/1.9). 2. Keep 1 Pull Request to a single feature. 3. Explain what you did in the PR message. From b603bc3ea3cd61fbc4a5816b68f7bffe6f8f1690 Mon Sep 17 00:00:00 2001 From: shivaco Date: Fri, 22 Sep 2017 17:28:37 +0600 Subject: [PATCH 2/5] Some re-phrasing --- docs/guides/Docker Guide.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/guides/Docker Guide.md b/docs/guides/Docker Guide.md index e249cbff..5c50e73d 100644 --- a/docs/guides/Docker Guide.md +++ b/docs/guides/Docker Guide.md @@ -1,5 +1,5 @@ # NadekoBot a Discord bot -Nadeko is written in C# and Discord.net for more information visit +Nadeko is written in C# and Discord.Net for more information visit ## Install Docker Follow the respective guide for your operating system found here [Docker Engine Install Guide](https://docs.docker.com/engine/installation/) @@ -14,14 +14,12 @@ docker create --name=nadeko -v /nadeko/conf/:/root/nadeko -v /nadeko/data:/opt/N -If you are making a fresh install, create your credentials.json from the following guide and place it in the /nadeko folder [Nadeko JSON Guide](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/) -Next start the docker up with - -`docker start nadeko; docker logs -f nadeko` +Next start the docker up with `docker start nadeko; docker logs -f nadeko` The docker will start and the log file will start scrolling past. Depending on hardware the bot start can take up to 5 minutes on a small DigitalOcean droplet. Once the log ends with "NadekoBot | Starting NadekoBot v1.0-rc2" the bot is ready and can be invited to your server. Ctrl+C at this point to stop viewing the logs. -After a few moments you should be able to invite Nadeko to your server. If you cannot check the log file for errors. +After a few moments you should be able to invite Nadeko to your server. If you cannot, check the log file for errors. ## Monitoring @@ -45,16 +43,16 @@ docker create --name=nadeko -v /nadeko/conf/:/root/nadeko -v /nadeko/data:/opt/N # Automatic Updates -Automatic update are now handled by watchertower [WatchTower GitHub](https://github.com/CenturyLinkLabs/watchtower) -To setup watchtower to keep Nadeko up-to-date for you with the default settings use the following command +Automatic update are now handled by WatchTower [WatchTower GitHub](https://github.com/CenturyLinkLabs/watchtower) +To setup WatchTower to keep Nadeko up-to-date for you with the default settings, use the following command ```bash docker run -d --name watchtower -v /var/run/docker.sock:/var/run/docker.sock centurylink/watchtower --cleanup nadeko ``` -This will check for updates to the docker every 5 minutes and update immediately. Alternatively using the `--interval X` command to change the interval, where X is the amount of time in seconds to wait. eg 21600 for 6 hours. +This will check for updates to the docker every 5 minutes and update immediately. Alternatively using the `--interval X` command to change the interval, where X is the amount of time in seconds to wait. e.g 21600 for 6 hours. -If you have any issues with the docker setup, please ask in #help but indicate you are using the docker. +If you have any issues with the docker setup, please ask in #help channel on our [Discord server](https://discordapp.com/invite/nadekobot) but indicate you are using the docker. -For information about configuring your bot or its functionality, please check the guides. +For information about configuring your bot or its functionality, please check the [documentation](http://nadekobot.readthedocs.io/en/latest). From 469f2bdc233563017327307a8d430fa519150502 Mon Sep 17 00:00:00 2001 From: shivaco Date: Fri, 22 Sep 2017 17:38:42 +0600 Subject: [PATCH 3/5] Some messing around with command usages --- docs/Commands List.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Commands List.md b/docs/Commands List.md index 6d6a6d9a..9a3624df 100644 --- a/docs/Commands List.md +++ b/docs/Commands List.md @@ -448,9 +448,9 @@ Commands and aliases | Description | Usage ----------------|--------------|------- `.experience` `.xp` | Shows your xp stats. Specify the user to show that user's stats instead. | `.xp` `.xprolerewards` `.xprrs` | Shows currently set role rewards. | `.xprrs` -`.xprolereward` `.xprr` | Sets a role reward on a specified level. Provide no role name in order to remove the role reward. **Requires ManageRoles server permission.** | `.xprr 3 Social` -`.xpnotify` `.xpn` | Sets how the bot should notify you when you get a `server` or `global` level. You can set `dm` (for the bot to send a direct message), `channel` (to get notified in the channel you sent the last message in) or `none` to disable. | `.xpn global dm` `.xpn server channel` -`.xpexclude` `.xpex` | Exclude a user or a role from the xp system, or whole current server. **Requires Administrator server permission.** | `.xpex Role Excluded-Role` `.xpex Server` +`.xprolereward` `.xprr` | Sets a role reward on a specified level. Provide no role name in order to remove the role reward. **Requires ManageRoles server permission.** | `.xprr 4 Social` or `.xprr 9 Active` +`.xpnotify` `.xpn` | Sets how the bot should notify you when you get a `server` or `global` level. You can set `dm` (for the bot to send a direct message), `channel` (to get notified in the channel you sent the last message in) or `none` to disable. | `.xpn global dm` or `.xpn server channel` +`.xpexclude` `.xpex` | Exclude a user or a role from the xp system, or whole current server. **Requires Administrator server permission.** | `.xpex Role Excluded-Role` or `.xpex Server` or `.xpex channel spam` `.xpexclusionlist` `.xpexl` | Shows the roles and channels excluded from the XP system on this server, as well as whether the whole server is excluded. | `.xpexl` `.xpleaderboard` `.xplb` | Shows current server's xp leaderboard. | `.xplb` `.xpgleaderboard` `.xpglb` | Shows the global xp leaderboard. | `.xpglb` From 21f2bba73d80db79dc963eca0106c2a85e28bd3d Mon Sep 17 00:00:00 2001 From: shivaco Date: Sat, 23 Sep 2017 21:56:38 +0600 Subject: [PATCH 4/5] Revert commandlist --- docs/Commands List.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/Commands List.md b/docs/Commands List.md index 9a3624df..b5b615f6 100644 --- a/docs/Commands List.md +++ b/docs/Commands List.md @@ -447,10 +447,9 @@ Commands and aliases | Description | Usage Commands and aliases | Description | Usage ----------------|--------------|------- `.experience` `.xp` | Shows your xp stats. Specify the user to show that user's stats instead. | `.xp` -`.xprolerewards` `.xprrs` | Shows currently set role rewards. | `.xprrs` -`.xprolereward` `.xprr` | Sets a role reward on a specified level. Provide no role name in order to remove the role reward. **Requires ManageRoles server permission.** | `.xprr 4 Social` or `.xprr 9 Active` -`.xpnotify` `.xpn` | Sets how the bot should notify you when you get a `server` or `global` level. You can set `dm` (for the bot to send a direct message), `channel` (to get notified in the channel you sent the last message in) or `none` to disable. | `.xpn global dm` or `.xpn server channel` -`.xpexclude` `.xpex` | Exclude a user or a role from the xp system, or whole current server. **Requires Administrator server permission.** | `.xpex Role Excluded-Role` or `.xpex Server` or `.xpex channel spam` +`.xprolereward` `.xprr` | Sets a role reward on a specified level. Provide no role name in order to remove the role reward. **Requires ManageRoles server permission.** | `.xprr 3 Social` +`.xpnotify` `.xpn` | Sets how the bot should notify you when you get a `server` or `global` level. You can set `dm` (for the bot to send a direct message), `channel` (to get notified in the channel you sent the last message in) or `none` to disable. | `.xpn global dm` `.xpn server channel` +`.xpexclude` `.xpex` | Exclude a user or a role from the xp system, or whole current server. **Requires Administrator server permission.** | `.xpex Role Excluded-Role` `.xpex Server` `.xpexclusionlist` `.xpexl` | Shows the roles and channels excluded from the XP system on this server, as well as whether the whole server is excluded. | `.xpexl` `.xpleaderboard` `.xplb` | Shows current server's xp leaderboard. | `.xplb` `.xpgleaderboard` `.xpglb` | Shows the global xp leaderboard. | `.xpglb` From f0eed2ab4e8a6176e485905c889377345570ef64 Mon Sep 17 00:00:00 2001 From: shivaco Date: Sat, 23 Sep 2017 22:00:53 +0600 Subject: [PATCH 5/5] I've lost `.xprrs` --- docs/Commands List.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Commands List.md b/docs/Commands List.md index b5b615f6..6d6a6d9a 100644 --- a/docs/Commands List.md +++ b/docs/Commands List.md @@ -447,6 +447,7 @@ Commands and aliases | Description | Usage Commands and aliases | Description | Usage ----------------|--------------|------- `.experience` `.xp` | Shows your xp stats. Specify the user to show that user's stats instead. | `.xp` +`.xprolerewards` `.xprrs` | Shows currently set role rewards. | `.xprrs` `.xprolereward` `.xprr` | Sets a role reward on a specified level. Provide no role name in order to remove the role reward. **Requires ManageRoles server permission.** | `.xprr 3 Social` `.xpnotify` `.xpn` | Sets how the bot should notify you when you get a `server` or `global` level. You can set `dm` (for the bot to send a direct message), `channel` (to get notified in the channel you sent the last message in) or `none` to disable. | `.xpn global dm` `.xpn server channel` `.xpexclude` `.xpex` | Exclude a user or a role from the xp system, or whole current server. **Requires Administrator server permission.** | `.xpex Role Excluded-Role` `.xpex Server`