From 3c90dc239e6d6f9f40622b3c7ac96d5e5676617f Mon Sep 17 00:00:00 2001 From: Hokuto Chen Date: Sat, 15 Jan 2022 06:20:06 +0000 Subject: [PATCH 1/5] added bold lettering to intents --- docs/creds-guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/creds-guide.md b/docs/creds-guide.md index 2fb856dfa..e7c4e0080 100644 --- a/docs/creds-guide.md +++ b/docs/creds-guide.md @@ -13,11 +13,11 @@ This document aims to guide you through the process of creating a Discord accoun - Click on the `Add a Bot` button and confirm that you do want to add a bot to this app. - **Optional:** Add bot's avatar and description. - Copy your Token to `creds.yml` as shown above. -- Scroll down to the `Privileged Gateway Intents` section - - Enabled the following: - - PRESENCE INTENT - - SERVER MEMBERS INTENT - - MESSAGE CONTENT INTENT +- Scroll down to the **`Privileged Gateway Intents`** section + - **Enable the following:** + - **PRESENCE INTENT** + - **SERVER MEMBERS INTENT** + - **MESSAGE CONTENT INTENT** These are required for a number of features to function properly, and all should be on. From 9d2d2fcca5b59f06ad944285a3b04872dae24f1f Mon Sep 17 00:00:00 2001 From: Hokuto Chen Date: Sat, 15 Jan 2022 06:23:29 +0000 Subject: [PATCH 2/5] added "no owner message" advisory --- docs/guides/windows-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/guides/windows-guide.md b/docs/guides/windows-guide.md index c4ff78e9f..f1943f22a 100644 --- a/docs/guides/windows-guide.md +++ b/docs/guides/windows-guide.md @@ -48,6 +48,8 @@ - Either click on **`RUN`** button in the updater or run the bot via its desktop shortcut. +### If you get a "No owner channels created..." message. Please follow the creds guide again [**HERE**](../../creds-guide). + #### Updating Nadeko - Make sure Nadeko is closed and not running From b41571a7fde19e09dad79afc627d3a649f481a5f Mon Sep 17 00:00:00 2001 From: Hokuto Chen Date: Sun, 16 Jan 2022 11:26:33 +0000 Subject: [PATCH 3/5] same as !229 --- src/NadekoBot/creds_example.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/NadekoBot/creds_example.yml b/src/NadekoBot/creds_example.yml index b392b011e..bbf2b1892 100644 --- a/src/NadekoBot/creds_example.yml +++ b/src/NadekoBot/creds_example.yml @@ -74,8 +74,8 @@ osuApiKey: # cmd: dotnet # args: "NadekoBot.dll -- {0}" # Windows default -# cmd: NadekoBot.exe -# args: {0} +# cmd: "NadekoBot.exe" +# args: "{0}" restartCommand: cmd: args: From 4ac7d329fd7d136c26802600e141a6c02f6791aa Mon Sep 17 00:00:00 2001 From: Hokuto Chen Date: Tue, 18 Jan 2022 22:47:47 +0000 Subject: [PATCH 4/5] added args: "{0}" to windows updater restart example --- docs/jsons-explained.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/jsons-explained.md b/docs/jsons-explained.md index 0ed036302..e7acde5b4 100644 --- a/docs/jsons-explained.md +++ b/docs/jsons-explained.md @@ -75,6 +75,7 @@ For Windows (Updater), add this to your `creds.yml` ```yml RestartCommand: Cmd: "NadekoBot.exe" + args: "{0}" ``` For Windows (Source), Linux or OSX, add this to your `creds.yml` @@ -161,8 +162,8 @@ osuApiKey: 4c8c8fdffdsfdsfsdfsfa33f3f3140a7d93320d6 # cmd: dotnet # args: "NadekoBot.dll -- {0}" # Windows default -# cmd: NadekoBot.exe -# args: {0} +# cmd: "NadekoBot.exe" +# args: "{0}" restartCommand: cmd: args: From 7a8fbb418bf74d5589c4fb414b11b26474c9dc52 Mon Sep 17 00:00:00 2001 From: Hokuto Chen Date: Tue, 18 Jan 2022 22:48:09 +0000 Subject: [PATCH 5/5] Readded table of contents. --- docs/guides/linux-guide.md | 42 ++++++++++++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 8 deletions(-) diff --git a/docs/guides/linux-guide.md b/docs/guides/linux-guide.md index 51d627e14..9b1e3300f 100644 --- a/docs/guides/linux-guide.md +++ b/docs/guides/linux-guide.md @@ -1,8 +1,24 @@ -## Migration from 2.x +# Setting up NadekoBot on Linux -##### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before switching over to v3. +## Please **READ** the [Migration] section if you are still on on Nadeko **2.x** -#### [Linux migration instructions](../migration-guide/#linux) +| Table of Contents | +| :-------------------------------------------------- | +| [Migration] | +| [Linux From Source] | +| [Source Update Instructions] | +| [Linux Release] | +| [Release Update Instructions] | +| [Tmux (Preferred Method)] | +| [Systemd] | +| [Systemd + Script] | +| [Setting up Nadeko on a VPS (Digital Ocean)] | + +## Migration + +### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before upgrading to v3. ⚠ + +#### [**LINUX MIGRATION INSTRUCTIONS**](../migration-guide/#linux) #### Operating System Compatibility @@ -37,9 +53,9 @@ Open Terminal (if you're on an installation with a window manager) and navigate - `Enter` 8. Run the bot (type `3` and press enter) -##### Update Instructions +##### Source Update Instructions -1. ⚠ Stop the bot +1. ⚠ Stop the bot ⚠ 2. Update and run the **new** installer script `cd ~ && wget -N https://gitlab.com/Kwoth/nadeko-bash-installer/-/raw/master/linuxAIO.sh && bash linuxAIO.sh` 3. Update the bot (type `2` and press enter) 4. Run the bot (type `3` and press enter) @@ -47,7 +63,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate ## Linux Release -⚠ IF YOU ARE FOLLOWING THE GUIDE ABOVE, IGNORE THIS SECTION ⚠ +**⚠ IF YOU ARE FOLLOWING THE GUIDE ABOVE, IGNORE THIS SECTION ⚠** ##### Installation Instructions @@ -72,7 +88,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate 9. Run the bot - `./NadekoBot` -##### Update Instructions +##### Release Update Instructions 1. Stop the bot 2. Download the latest release from @@ -119,7 +135,7 @@ cd nadekobot && chmod +x NadekoBot While there are two run modes built into the installer, these options only run Nadeko within the current session. Below are 3 methods of running Nadeko as a background process. -### Tmux (Preferred Method) +### Tmux Method (Preferred) Using `tmux` is the simplest method, and is therefore recommended for most users. @@ -290,3 +306,13 @@ If you are running your droplet for the first time, it will most likely ask you **Save the new password somewhere safe.** After that, your droplet should be ready for use. [Follow the guide from the beginning](#linux-from-source) to set Nadeko up on your newly created VPS. + +[Migration]: #migration +[Linux From Source]: #linux-from-source +[Source Update Instructions]: #source-update-instructions +[Linux Release]: #linux-release +[Release Update Instructions]: #release-update-instructions +[Tmux (Preferred Method)]: #tmux-preferred-method +[Systemd]: #systemd +[Systemd + Script]: #systemd-script +[Setting up Nadeko on a VPS (Digital Ocean)]: #setting-up-nadeko-on-a-linux-vps-digital-ocean-droplet