deda1b1abf
`ZipContainingAllTheInstallerFiles` is of course, a placeholder untill I can get an actual filename for this
7.6 KiB
7.6 KiB
Thanks to @Flatbread and Mirai for making this guide
Setting Up NadekoBot on Windows
Prerequisites
-
- NET Framework 4.5.2 (or 4.6)
-
- Google Account
-
- Soundcloud Account (if you want soundcloud support)
-
- 7zip (or whatever you are using, WinRar)
####Guide
- Make sure you have installed both Git and the .NET core sdk
- Create a folder somewhere and name it
Nadeko
. - Head to the NadekoBot Releases Page and download
ZipContainingAllTheInstallerFiles
. - Copy
ZipContainingAllTheInstallerFiles
to theNadeko
folder that we created earlier, and extract everything. - You will see a few files, most importantly,
NadekoInstaller.bat
after extraction (You may not see the.bat
part of the filename). - Run/Launch/Open
NadekoInstaller.bat
and you will see it running in the command prompt. - Wait a while for the file to finish installing, it'll say when it's done in the command prompt.
- You should now have a new folder named
NadekoBot
inside theNadeko
folder we previously created. - Run the
NadekoRun.bat
file and wait for windows to tell you dotnet has crashed, then choose to close - If it still exists, you can safely delete the
NadekoInstall_Temp
folder.
####Creating DiscordBot application
- Go to the Discord developer application page.
- Log in with your Discord account.
- On the left side, press
New Application
. - Fill out the
App Name
(your bot's name, in this case), put the image you want, and add an app description(optional). - Create the application.
- Click on
Create a Bot User
and confirm that you do want to add a bot to this app. - Keep this window open for now.
####Setting up Credentials.json file
- In our
NadekoBot
folder you should have anotherNadekoBot
folder, then asrc
folder, then anotherNadekoBot
folder, in this final folder, you should see a.json
file namedcredentials_example.json
. (Note: If you do not see a .json aftercredentials_example.json
, do not add the**.json**
. You most likely have"Hide file extensions"
enabled.) - Rename
credentials_example.json
tocredentials.json
. - Open the file with Notepad++.
- In there you will see fields such as
Token
,ClientId
,BotId
andOwnerIDs
. - In your applications page (the window you were asked to keep open earlier), under the
Bot User
section, you will seeToken:click to reveal
, click to reveal the token. - Copy your bot's token, and on the
"Token"
line of yourcredentials.json
, replacenull
with your bot token and put quotation marks before and after the token, like so"Example.Token"
- Copy the
Client ID
on the page and replace the null part of theClientId
line with it, and put quotation marks before and after, like earlier. - Again, copy the same
Client ID
and replace the null part of theBotId
line with it, and do not put quotation marks before and after the ID. - Save your
credentials.json
but keep it open. We need to add yourUser ID
as one of theOwnerIds
shortly.
####Inviting your bot to your server
- Invite Guide
- Create a new server in Discord.
- Copy your
Client ID
from your applications page. - Replace the
12345678
in this linkhttps://discordapp.com/oauth2/authorize?client_id=12345678&scope=bot&permissions=66186303
with yourClient ID
. - The link should now look like this:
https://discordapp.com/oauth2/authorize?client_id=**YOUR_CLENT_ID**&scope=bot&permissions=66186303
. - Go to the newly created link and pick the server we created, and click
Authorize
. - The bot should have been added to your new server.
####Starting the bot
- Go to the folder which you extracted the zip to earlier, and run the
NadekoRun.bat
file - Your bot should now be online in the server we added him to.
- Note: Your bot will be offline in case you close the
NadekoBot
command prompt window.
####Setting up OwnerIds
- In the server where your bot is, in a text channel, type
.uid
- Your
User ID
should show, copy it. - Close
NadekoBot.exe
- Replace the
null
section on theOwnerIds
line with your user ID shown earlier and put a square bracket around each end of the ID like so,[105635576866156544]
- Run
NadekoRun.bat
again. - If done correctly, you are now the bot owner.
- You can add multiple owner IDs by seperating them with a comma within the square brackets.
Setting Up NadekoBot For Music
Prerequisites
-
- FFMPEG installed.
-
- Setting up API keys.
-
Follow these steps on how to setup Google API keys:
- Go to Google Console and log in.
- Create a new project (name does not matter). Once the project is created, go into "Enable and manage APIs."
- Under the "Other Popular APIs" section, enable
URL Shortener API
andCustom Search Api
. Under theYouTube APIs
section, enableYouTube Data API
. - On the left tab, access
Credentials
. ClickCreate Credentials
button. Click onAPI Key
. A new window will appear with yourGoogle API key
. - Copy the key.
- Open up
credentials.json
. - For
"GoogleAPIKey"
, replacenull
with the new key we copied and put quotation marks before and after the API key, like how theToken
andClientId
should be set up.
-
Follow these steps on how to setup Soundcloud API key:
- Go to Soundcloud.
- Enter a name for the app and create it.
- You will need to fill out an application form to request access to the Soundcloud API.
- All requests for an API key must go through the review process, where applications will be reviewed on a case by case basis, in line with Soundcloud API Terms of Use. If your application is successful, you will receive an API key.
-
Restart your computer.
####Manual ffmpeg
setup
Do this step in case you were not able to install ffmpeg
with the installer.
- Create a folder named
ffmpeg
in your main Windows directory. We will use C:\ffmpeg (for our guide) - Download FFMPEG through the link https://ffmpeg.zeranoe.com/builds/ (download static build)
- Extract it using
7zip
and place the folderffmpeg-xxxxx-git-xxxxx-xxxx-static
inside C:\ffmpeg - Before proceeding, check out this gif to set up
ffmpeg
PATH correctly http://i.imgur.com/aR5l1Hn.gif (thanks to PooPeePants#7135) - Go to My Computer, right click and select Properties. On the left tab, select Advanced System Settings. Under the Advanced tab, select Environmental Variables near the bottom. One of the variables should be called "Path". Add a semi-colon (;) to the end followed by your FFMPEG's bin install location (for example C:\ffmpeg\ffmpeg-xxxxx-git-xxxxx-xxxx-static\bin). Save and close.
- Setup your API keys as explained above.
- Restart your computer.