.gitlab | ||
docs | ||
src | ||
.dockerignore | ||
.gitignore | ||
.gitlab-ci.yml | ||
CHANGELOG.md | ||
Dockerfile | ||
exe_builder.iss | ||
LICENSE.md | ||
mkdocs-requirements.txt | ||
mkdocs.yml | ||
NadekoBot.iss | ||
NadekoBot.sln | ||
NuGet.Config | ||
README.md | ||
release.ps1 |
Migration from 2.x
⚠ 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
Linux migration instruction
- In order to migrate, first update your current version to the latest 2.x version, run the bot and make sure it works
- If you're running linux installer version, just run the 'download' option again
- Run the bot
- Type
.stats
and make sure the version is2.46.5
or later - Stop the bot
- If your current bot folder is called
nadekobot
it would be best if you rename it tonadekobot_2x
- Move to the directory your bot is installed at, by default it's
~
- For examplecd ~
- Run
mv nadekobot nadekobot_2x
- Now, you need to clone the new version and copy over the data folder and the database file
- Clone the v3 branch to a separate folder
git clone https://gitlab.com/kwoth/nadekobot -b v3 --depth 1
- Copy old data
cp -rf nadekobot_2x/src/NadekoBot/data nadekobot/src/NadekoBot/data
- Build the bot
dotnet publish -c Release -o output/ src/NadekoBot/
- Copy the database
cp nadekobot_2x/src/NadekoBot/bin/Release/netcoreapp2.1/data/NadekoBot.db nadekobot/output/data
- Copy credentials file
cp nadekobot_2x/src/NadekoBot/credentials.json nadekobot/output/
- Clone the v3 branch to a separate folder
Installation
Windows From Source
Prerequisites
Install these before proceeding
- .net 5 - needed to compile and run the bot
- git - needed to clone the repository (you can also download the zip manually and extract it but this guide assumes you're using git)
- redis - to cache things needed by some features and persist through restarts
Instructions
Open PowerShell (press windows button on your keyboard and type powershell, it should show up), and navigate to the location where you want to install the bot (for example cd ~/Desktop/
)
git clone https://gitlab.com/kwoth/nadekobot -b v3 --depth 1
dotnet publish -c Release -o output/ src/NadekoBot/
cd output && cp creds_example.yml creds.yml
- Open
creds.yml
with your favorite text editor (Please don't use notepad or wordpad. You can use notepad++, vscode, atom, sublime or something similar) - Enter your bot's token
- Run the bot
dotnet NadekoBot.dll
- 🎉
Music prerequisites
In order to use music commands, you need ffmpeg and youtube-dl installed.
- ffmpeg-32bit | ffmpeg-64bit - Download the appropriate version for your system (32 bit if you're running a 32 bit OS, or 64 if you're running a 64bit OS). Unzip it, and move
ffmpeg.exe
to a path that's in your PATH environment variable. If you don't know what that is, then just move theffmpeg.exe
file to nadekobot/output - youtube-dl - Click to download the file. Then put
youtube-dl.exe
in a path that's in your PATH environment variable. If you don't know what that is, then just move theyoutube-dl.exe
file to NadekoBot/system
Linux From Source
Open Terminal (if you're on a linux with window manager) and navigate to the location where you want to install the bot (for example cd ~
)
Prerequisites
Instructions
git clone https://gitlab.com/kwoth/nadekobot -b v3 --depth 1
cd nadekobot && dotnet publish -c Release -o output/ src/NadekoBot/
cd output && cp creds_example.yml creds.yml
- Open
creds.yml
with your favorite text editor - Enter your bot's token
- Run the bot
dotnet NadekoBot.dll
- 🎉
Creds Guide
This document aims to guide you through the process of creating a Discord account for your bot (the Discord Bot application), and inviting that account into your Discord server.
- Go to the Discord developer application page.
- Log in with your Discord account.
- Click New Application
- Fill out the
Name
field (it's your app's name) - Go to the Bot tab on the left sidebar.
- 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 Token to
creds.yml
- Scroll down to the
Privileged Gateway Intents
section and enable both intents. These are required for a number of features to function properly, and should both be on.
Inviting your bot to your server
- On the General Information tab, copy your
Application ID
from your applications page. - Replace the
YOUR_CLIENT_ID_HERE
in this link:https://discordapp.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303
with yourClient ID
- The link should now look something like this:
https://discordapp.com/oauth2/authorize?client_id=123123123123&scope=bot&permissions=66186303
- Access that newly created link, pick your Discord server, click
Authorize
and confirm with the captcha at the end - The bot should now be in your server
That's it! You may now go back to the installation guide you were following previously 🎉