diff --git a/docs/guides/Linux Guide.md b/docs/guides/Linux Guide.md index 597058c2..e1f35ca6 100644 --- a/docs/guides/Linux Guide.md +++ b/docs/guides/Linux Guide.md @@ -42,40 +42,37 @@ If you entered your Droplets IP address correctly, it should show **login as:** Use the following command to get and run `linuxAIO.sh` (Remember **Do Not** rename the file **linuxAIO.sh**) -`cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/master/linuxAIO.sh && bash linuxAIO.sh` +`cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` You should see these following options after using the above command: ``` -1. Download Dev Build (Latest) -2. Download Stable Build -3. Run Nadeko (Normally) -4. Run Nadeko with Auto Restart (Run Nadeko normally before using this.) -5. Auto-Install Prerequisites (for Ubuntu, Debian and CentOS) -6. Set up credentials.json (if you have downloaded the bot already) -7. To exit +1. Download NadekoBot +2. Run Nadeko (Normally) +3. Run Nadeko with Auto Restart (Run Nadeko normally before using this.) +4. Auto-Install Prerequisites (for Ubuntu, Debian and CentOS) +5. Set up credentials.json (if you have downloaded the bot already) +6. To exit ``` ##### Part II - Downloading Nadekobot prerequisites -**If** you are running NadekoBot for the first time on your system and never had any *prerequisites* installed and have Ubuntu, Debian or CentOS, Press `5` and `enter` key, then `y` when you see the following: +**If** you are running NadekoBot for the first time on your system and never had any *prerequisites* installed and have Ubuntu, Debian or CentOS, Press `4` and `enter` key, then `y` when you see the following: ``` Welcome to NadekoBot Auto Prerequisites Installer. Would you like to continue? ``` That will install all the prerequisites your system need to run NadekoBot. -(Optional) **If** you want to install it manually, you can try finding it [here](https://github.com/Kwoth/NadekoBot-BashScript/blob/master/nadekoautoinstaller.sh) +(Optional) **If** you want to install it manually, you can try finding it [here](https://github.com/Kwoth/NadekoBot-BashScript/blob/1.4/nadekoautoinstaller.sh) Once *prerequisites* finish installing, ##### Part III - Installing Nadeko -Choose either -`1` to get the **most updated build of NadekoBot** -or -`2` to get the **previously stable build of NadekoBot** +Choose `1` to get the **most updated build of NadekoBot** + and then press `enter` key. -Once Installation is completed you should see the options again. +When installation is complete, you will see the options again. Next, check out: ##### Part IV - Setting up credentials @@ -96,7 +93,7 @@ You will need the following for the next step: - **Osu Api Key** [(optional)](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/) - **Sound Cloud Client Id** [(optional)](http://nadekobot.readthedocs.io/en/latest/JSON%20Explanations/) -Once you have acquired them, press `6` to **Set up credentials.json** +Once you have acquired them, press `5` to **Set up credentials.json** You will be asked to enter the required informations, just follow the on-screen instructions and enter the required information. *i.e* If you are asked **Bot's Token**, then just copy and paste or type the **Bot's Token** and press `enter` key. @@ -105,10 +102,10 @@ You will be asked to enter the required informations, just follow the on-screen Once done, ##### Part V - Checking if Nadeko is working You should see the options again. -Next, press `3` to **Run Nadeko (Normally)**. +Next, press `2` to **Run Nadeko (Normally)**. Check in your discord server if your new bot is working properly. ##### Part VI - Running Nadeko on tmux -If your bot is working properly in your server, type `.die` to **shut down the bot**, then press `7` to **exit**. +If your bot is working properly in your server, type `.die` to **shut down the bot**, then press `6` on the console to **exit**. Next, [Run your bot again with **tmux**.](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#running-nadekobot) [Check this when you need to **restart** your **NadekoBot** anytime later along with tmux session.](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#restarting-nadeko) @@ -123,38 +120,37 @@ The above command will create a new session named **nadeko** *(you can replace **Next, we need to run `linuxAIO.sh` in order to get the latest running scripts with patches:** -- `cd ~ && bash linuxAIO.sh` +- `cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` **From the options,** -Choose `3` to **Run NadekoBot normally.** -**NOTE:** With option `3` (Running Normally), if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) in discord. The bot will shut down and will stay offline until you manually run it again. (best if you want to check the bot.) +Choose `2` to **Run NadekoBot normally.** +**NOTE:** With option `2` (Running normally), if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) in discord. The bot will shut down and will stay offline until you manually run it again. (best if you want to check the bot.) -Choose `4` to **Run NadekoBot with Auto Restart.** -It will show you more options: +Choose `3` to **Run NadekoBot with Auto Restart.** +**NOTE:** With option `3` (Running with Auto Restart), bot will auto run if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) making the command `.die` to function as restart. + +It will show you the following options: ``` 1. Run Auto Restart normally without Updating. -2. Auto Restart and Update with Dev Build (latest) -3. Auto Restart and Update with Stable Build -4. Exit +2. Run Auto Restart and update NadekoBot. +3. Exit ``` -**NOTE:** With option `4` (Running with Auto Restart), bot will auto run if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) making the command `.die` to function as restart. -See how that happens: - -![img9](https://cdn.discordapp.com/attachments/251504306010849280/251506312893038592/die_explaination.gif) +- With option `1. Run Auto Restart normally without Updating.` Bot will restart on `die` command and will not be downloading the latest build available. +- With option `2. Run Auto Restart and update NadekoBot.` Bot will restart and download the latest build of bot available everytime `die` command is used. **Remember** that, while running with Auto Restart, you will need to [close the tmux session](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#restarting-nadeko) to stop the bot completely. **Now check your Discord, the bot should be online** -Next to **move the bot to background** and to do that, press **CTRL+B, release, D** (that will detach the nadeko session using TMUX) and you can finally close **PuTTY** if you want. +Next to **move the bot to background** and to do that, press **CTRL+B, release, D** (that will detach the nadeko session using TMUX) and you can finally close **PuTTY**. #### Restarting Nadeko **Restarting NadekoBot:** -**If** you have chosen option `4` to **Run Nadeko with Auto Restart** from Nadeko's `linuxAIO.sh` *[(you got it from this step)](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#getting-nadekobot)* +**If** you have chosen option `2` to **Run Nadeko with Auto Restart** from Nadeko's `linuxAIO.sh` *[(you got it from this step)](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#getting-nadekobot)* You can simply type `.die` in the server you have your NadekoBot to make her restart. **Restarting Nadeko with the Server:** @@ -173,10 +169,10 @@ Open **PuTTY** and login as you have before, type `reboot` and hit Enter. - `tmux kill-session -t nadeko` (don't forget to replace **nadeko** in the command with the name of your bot's session) - Make sure the bot is **not** running. - `tmux new -s nadeko` (**nadeko** is the name of the session) -- `cd ~ && bash linuxAIO.sh` -- Choose either `1` or `2` to update the bot with **latest build** or **stable build** respectively. -- Choose either `3` or `4` to run the bot again with **normally** or **auto restart** respectively. -- Done. You can close **PuTTY** now. +- `cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` +- Choose `1` to update the bot with **latest build** available. +- Next, choose either `2` or `3` to run the bot again with **normally** or **auto restart** respectively. +- Done. #### Setting up Music @@ -227,7 +223,7 @@ Once done, go back to **PuTTY** - Copy the `credentials.json` to desktop - EDIT it as it is guided here: [Setting up credentials.json](http://nadekobot.readthedocs.io/en/latest/guides/Windows%20Guide/#setting-up-credentialsjson-file) - Paste/put it back in the folder once done. `(Using WinSCP)` -- **If** you already have Nadeko 1.0 setup and have `credentials.json` and `NadekoBot.db`, you can just copy and paste the `credentials.json` to `NadekoBot/src/NadekoBot` and `NadekoBot.db` to `NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.0/data` using WinSCP. +- **If** you already have Nadeko 1.3.x setup and have `credentials.json` and `NadekoBot.db`, you can just copy and paste the `credentials.json` to `NadekoBot/src/NadekoBot` and `NadekoBot.db` to `NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.1/data` using WinSCP. - **If** you have Nadeko 0.9x follow the [Upgrading Guide](http://nadekobot.readthedocs.io/en/latest/guides/Upgrading%20Guide/) diff --git a/docs/guides/OSX Guide.md b/docs/guides/OSX Guide.md index db24f0a3..19e010e0 100644 --- a/docs/guides/OSX Guide.md +++ b/docs/guides/OSX Guide.md @@ -1,4 +1,4 @@ -## Setting Up NadekoBot on OSX +## Setting Up NadekoBot on OSX (macOS) #### Prerequisites - [Homebrew][Homebrew] @@ -59,16 +59,14 @@ A dialog box will open asking if you want to install `xcode-select`. Select inst Use the following command to get and run `linuxAIO.sh`: (Remember **DO NOT** rename the file `linuxAIO.sh`) -`cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/master/linuxAIO.sh && bash linuxAIO.sh` +`cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` Follow the on screen instructions: -1. To Get the latest build. (most recent updates) -2. To Get the stable build. +Choose `1. Download NadekoBot` To Get the latest build. (most recent updates) -Choose either `1` or `2` then press `enter` key. Once Installation is completed you should see the options again. -Next, choose `5` to exit. +Next, choose `6` to exit. #### Creating and Inviting bot @@ -112,16 +110,16 @@ For Music Setup and API keys check [Setting up NadekoBot for Music](http://nadek From the options, -Choose `3` To Run the bot normally. -**NOTE:** With option `3` (Running Normally), if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) in discord. The bot will shut down and will stay offline untill you manually run it again. (best if you want to check the bot.) +Choose `2` To Run the bot normally. +**NOTE:** With option `2` (Running Normally), if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) in discord. The bot will shut down and will stay offline untill you manually run it again. (best if you want to check the bot.) -Choose `4` To Run the bot with Auto Restart. -**NOTE:** With option `4` (Running with Auto Restart), bot will auto run if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) making the command `.die` to be used as restart. +Choose `3` To Run the bot with Auto Restart. +**NOTE:** With option `3` (Running with Auto Restart), bot will auto run if you use `.die` [command](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#administration) making the command `.die` to be used as restart. **NOTE:** [To stop the bot you will have to kill the session.](http://nadekobot.readthedocs.io/en/latest/guides/OSX%20Guide/#some-more-info) **Now check your Discord, the bot should be online** -Now time to move bot to background and to do that, press CTRL+B+D (this will detach the nadeko session using TMUX) +Now time to move bot to background and to do that, press CTRL+B,D (this will detach the nadeko session using TMUX) If you used Screen press CTRL+A+D (this will detach the nadeko screen) #### Updating Nadeko @@ -130,10 +128,10 @@ If you used Screen press CTRL+A+D (this will detach the nadeko screen) - `tmux kill-session -t nadeko` [(don't forget to replace **nadeko** in the command to what ever you named your bot's session)](http://nadekobot.readthedocs.io/en/latest/guides/OSX%20Guide/#some-more-info) - Make sure the bot is **not** running. - `tmux new -s nadeko` (**nadeko** is the name of the session) -- `cd ~ && bash linuxAIO.sh` -- Choose either `1` or `2` to update the bot with **latest build** or **stable build** respectively. -- Choose either `3` or `4` to run the bot again with **normally** or **auto restart** respectively. -- Done. You can close terminal now. +- `cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` +- Choose `1` to update the bot with **latest build** available. +- Next, choose either `2` or `3` to run the bot again with **normally** or **auto restart** respectively. +- Done. #### Some more Info @@ -149,25 +147,8 @@ If you used Screen press CTRL+A+D (this will detach the nadeko screen) - If you want to switch to/ see that screen, type `screen -r nadeko` (nadeko is the name of the screen we created before so, replace `nadeko` with the screen name you created.) - If you want to kill the NadekoBot screen, type `screen -X -S nadeko quit` -#### Alternative Method to Install Nadeko - -**METHOD I** - -- `cd ~ && curl -L https://github.com/Kwoth/NadekoBot-BashScript/raw/master/nadeko_installer.sh | sh` - -**METHOD II** - -- `cd ~` -- `git clone -b 1.0 --recursive https://github.com/Kwoth/NadekoBot.git` -- `cd ~/NadekoBot/discord.net` -- `dotnet restore -s https://dotnet.myget.org/F/dotnet-core/api/v3/index.json` -- `dotnet restore` -- `cd ~/NadekoBot/src/NadekoBot/` -- `dotnet restore` -- `dotnet build --configuration Release` - [Homebrew]: http://brew.sh/ -[.NET Core SDK]: https://github.com/dotnet/core/blob/master/release-notes/download-archives/1.1-preview2.1-download.md +[.NET Core SDK]: https://www.microsoft.com/net/core#macos [DiscordApp]: https://discordapp.com/developers/applications/me [Atom]: https://atom.io/ [Invite Guide]: http://discord.kongslien.net/guide.html diff --git a/docs/guides/Upgrading Guide.md b/docs/guides/Upgrading Guide.md index 14af54e3..70fc6e80 100644 --- a/docs/guides/Upgrading Guide.md +++ b/docs/guides/Upgrading Guide.md @@ -1,8 +1,6 @@ -##Upgrading Nadeko from an older release +#### If you have NadekoBot 1.x on Windows -**If you have NadekoBot 1.x** - -- Follow the [Windows Guide](http://nadekobot.readthedocs.io/en/latest/guides/Windows%20Guide/)/[Linux Guide](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/)/[OS X Guide](http://nadekobot.readthedocs.io/en/latest/guides/OSX%20Guide/) and install the latest version of **NadekoBot**. +- Follow the [Windows Guide](http://nadekobot.readthedocs.io/en/latest/guides/Windows%20Guide/) and install the latest version of **NadekoBot**. - Navigate to your **old** `Nadeko` folder and copy your `credentials.json` file and the `data` folder. - Paste credentials into the **NadekoBot 1.4x+** `C:\Program Files\NadekoBot\system` folder. - Paste your **old** `Nadeko` data folder into **NadekoBot 1.4x+** `C:\Program Files\NadekoBot\system` folder. @@ -10,7 +8,7 @@ - Next launch your **new** Nadeko as the guide describes, if it is not already running. -**If you are running Dockerised Nadeko** +#### If you are running Dockerised Nadeko - Shutdown your existing container **docker stop nadeko**. - Move you credentials and other files to another folder. @@ -19,3 +17,14 @@ - Start the container **docker start nadeko** wait for it to complain about lacking credentials. - Stop the container **docker stop nadeko** open the nadeko folder and replace the credentials, database and other files with your copies. - Restart the container **docker start nadeko**. + +#### If you have NadekoBot 1.x on Linux or macOS + +- Backup the `NadekoBot.db` from `NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.0/data` +- Backup the `credentials.json` from `NadekoBot/src/NadekoBot/` +- **For MacOS Users Only:** download and install the latest version of [.NET Core SDK](https://www.microsoft.com/net/core#macos) +- Next, use the command `cd ~ && wget -N https://github.com/Kwoth/NadekoBot-BashScript/raw/1.4/linuxAIO.sh && bash linuxAIO.sh` +- **For Ubuntu, Debian and CentOS Users Only:** use the option `4. Auto-Install Prerequisites` to install the latest version of .NET Core SDK. +- Use option `1. Download NadekoBot` to update your NadekoBot to 1.4.x. +- Next, just [run your NadekoBot.](http://nadekobot.readthedocs.io/en/latest/guides/Linux%20Guide/#running-nadekobot) +- *NOTE: 1.4.x uses `NadekoBot.db` file from `NadekoBot/src/NadekoBot/bin/Release/netcoreapp1.1/data` folder.* \ No newline at end of file