From Source
Setting up NadekoBot From Source¶
Table of Contents |
---|
Installing with the CLI Installer |
Setup (CLI) |
Launching Nadeko (CLI) |
Installing Nadeko Manually |
Setup |
Launching Nadeko |
Updating Nadeko |
Installing with the CLI Installer¶
This is the recommended way of installing Nadeko from source. If you don't want to use the installer, skip to Installing Nadeko Manually.
Prerequisites (CLI)¶
- Windows 7 or later
- If you are on Windows 7, you must update PowerShell.
- dotNET core 3.1 SDK (restart Windows after installation)
- Git (select this option during the installation process)
- Redis
- Windows 64 bit: Download and install the latest msi. Don't forget to add it to the path environment variable during the installation process.
- Windows 32 bit: Skip this step
- Create a Discord Bot application and invite the bot to your server.
Optional
If you want Nadeko to play music, do the following:
- Install Visual C++ 2010 (x86) and Visual C++ 2017 (both are required - restart Windows after installation)
- youtube-dl - Click on
Windows.exe
(on the top left corner) and download the file. Then move it toC:\youtube-dl
. If the folderyoutube-dl
doesn't exist, create one.
Setup (CLI)¶
- Download the CLI installer. Move it to where you want Nadeko's files to be.
- Right click the file and extract it.
- Right click the
NadekoInstaller.bat
file and open it as Administrator. - After the admin check, you should see main menu with the options below:
1. Download Latest Build
2. Run NadekoBot (normally)
3. Run NadekoBot with Auto Restart (check "if" nadeko is working properly, before using this)
4. Setup credentials.json
5. Install ffmpeg (for music)
6. Redis Installation (Opens Website) (64bit)
7. Run Redis (if its not running) (64bit)
8. Install Youtube-dl. (Opens Website)
9. Add Youtube-dl to PATH.
10. Add Redis to PATH. (Advanced Users Only) ("Run Redis" is enough for Normal Users.) (64bit)
11. Install .NET Core SDK (Opens Website)
12. Install Git. (Opens Website)
13. Copy libsodium and opus dll files for 32bit users. (Required for 32bit, Music)
14. Download and run redis-server for 32bit users. (32bit)
15. [NEW] NadekoBot Extensions
16. To exit
- Run Option
1
to download Nadeko (type 1 and press Enter). Once it's done, it should take you back to the main menu. - Run Option
4
to set up your credentials. Paste the info as requested.- If your Windows is 32-bit, run Option
14
now. Otherwise, ignore this step.
- If your Windows is 32-bit, run Option
- Nadeko should be ready to launch. Run Option
2
to test it out. If everything goes well, Nadeko should appear as online on your Discord server and respond to commands. Once you're done with testing, type.die
to shut it down and return to the installer's main menu.
If you don't want the music features, you can launch Nadeko with Option 3
and have fun with your newly created bot. Otherwise, follow the steps below.
- If you haven't downloaded
youtube-dl.exe
and moved it toC:\youtube-dl
yet, then do it now.- If your Windows is 32-bit, run Option
13
. Otherwise, ignore this step.
- If your Windows is 32-bit, run Option
- Run Option
5
to downloadffmpeg
. - Run Option
9
to addyoutube-dl.exe
to your system's path environment variable. - That's it. You're done. Launch Nadeko with Option
3
and have fun sharing music with your friends.
Launching Nadeko (CLI)¶
- Just open the CLI installer and run Option
2
or3
. Easy as that.
Installing Nadeko Manually¶
This is the "hard" way of installing Nadeko. If you're here, we are assuming you know what the hell you're doing.
Prerequisites¶
- Windows 7 or later
- dotNET core 3.1 SDK (restart Windows after installation)
- Git (select this option during the installation process)
- Redis
- Windows 64 bit: Download and install the latest msi. Don't forget to add it to the path environment variable during the installation process.
- Windows 32 bit: Download redis-server.exe and store it somewhere accessible.
- Create a Discord Bot application and invite the bot to your server.
Optional If you want Nadeko to play music, do the following:
- Notepad++ (makes it easier to edit your credentials)
- Install Visual C++ 2010 (x86) and Visual C++ 2017 (both are required - restart Windows after installation)
- youtube-dl - Click on
Windows.exe
(on the top left corner) and download the file. Store it somewhere accessible. - ffmpeg - Download the Static, Release build for your system and architecture. Extract it, then find and copy the
ffmpeg.exe
file to somewhere accessible. - For 32-bit Windows, download libsodium and (lib)opus and store them somewhere accessible.
Setup¶
- Open command prompt (
cmd.exe
) and run the following command to download the source: git clone -b 1.9 https://gitlab.com/Kwoth/NadekoBot
- On Windows Explorer, go to
NadekoBot/src/NadekoBot
and edit thecredentials.json
file according to this guide. - Add these 2 arguments to your credentials file:
"ShardRunCommand": "dotnet",
"ShardRunArguments": "run -c Release --no-build -- {0} {1}",
- Move
youtube-dl.exe
andffmpeg.exe
intoNadekoBot/src/NadekoBot
(or add them to your PATH environment variable, if you know how) - For 32-bit Windows, replace
libsodium.dll
andopus.dll
inNadekoBot/src/NadekoBot
with the ones you've downloaded.
Launching Nadeko¶
- For 32-bit Windows, run the
redis-server.exe
you have downloaded. You must have this window open while using NadekoBot. - On command prompt, move to the correct directory:
cd NadekoBot/src/NadekoBot
- Build and run Nadeko:
dotnet run -c Release
- If everything goes well, Nadeko should start up and show as online in your Discord server.
Updating Nadeko¶
If you have not made custom edits to the source code.
- If you're using the CLI installer, shut your bot down and run Option
1
. That's it. - If you've installed manually, open command prompt (
cmd.exe
) - Move to Nadeko's root folder:
cd NadekoBot
- Update Nadeko:
git pull
If you have made custom edits to the source code.
- Open command prompt (
cmd.exe
) - Move to Nadeko's root folder:
cd NadekoBot
- Stash your changes:
git stash save "give me a nice name dd-mm-yyyy"
or justgit stash
- Update Nadeko:
git pull
- Apply your stash:
git stash apply
orgit stash apply stash@{n}
(wheren
is the ID of the stash)
Other useful commands:
git status
to check the changes you've madegit stash list
to see the list of saved stashes and their corresponding IDgit stash drop stash@{n}
to delete a specific stashgit stash pop stash@{n}
to apply and delete a specific stash
Last update: October 2, 2020