minster586/nadekobot
1
0
Fork 0
mirror of https://gitlab.com/Kwoth/nadekobot.git synced 2025-09-10 01:08:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: slight docs improvement, added windows from source guide in the menu, separated it from the windows installer guide

Browse Source
This commit is contained in:
Kwoth
2024-12-09 14:54:52 +00:00
parent f61c1a159d
commit 8b228b840a
2 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/creds-guide.md
View File

@@ -1,27 +1,30 @@
## Creds Guide ## Creds Guide
This document aims to guide you through the process of creating a Discord account for your bot This guide will show you how to create your own discord bot, invite it to your server, and copy it's credentials to your `creds.yml` in order to run your bot.
(the Discord Bot application), and inviting that account into your Discord server.
- Start by opening your creds.yml
- If you're on a windows installer version, click on the creds button next to your bot's RUN button.
- If you're on linux from source or windows from source version, open `nadekobot/output/creds.yml`. Please use visual studio code, notepad++ or another code editor. Usage of notepad is discouraged.
![Create a bot application and copy token to creds.yml file](https://cdn.nadeko.bot/tutorial/bot-creds-guide.gif) ![Create a bot application and copy token to creds.yml file](https://cdn.nadeko.bot/tutorial/bot-creds-guide.gif)
- Go to [the Discord developer application page][DiscordApp]. 1. Go to [the Discord developer application page][DiscordApp].
- Log in with your Discord account. 2. Log in with your Discord account.
- Click **New Application**. 3. Click **New Application**.
- Fill out the `Name` field however you like. 3. Fill out the `Name` field however you like, accept the terms, and confirm.
- Go to the **Bot** tab on the left sidebar. 1. 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. 1. 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. 1. **Optional:** Add bot's avatar and description.
- Copy your Token to `creds.yml` as shown above. 1. Copy your Token to `creds.yml` as shown above.
- Scroll down to the **`Privileged Gateway Intents`** section 1. Scroll down to the **`Privileged Gateway Intents`** section
- **Enable the following:** - Enable the following:
- **PRESENCE INTENT** - **PRESENCE INTENT**
- **SERVER MEMBERS INTENT** - **SERVER MEMBERS INTENT**
- **MESSAGE CONTENT INTENT** - **MESSAGE CONTENT INTENT**
These are required for a number of features to function properly, and all should be on. These are required for a number of features to function properly, and all should be on.
##### Getting Owner ID*(s)*: ##### Getting Owner ID
- Go to your Discord server and attempt to mention yourself, but put a backslash at the start - Go to your Discord server and attempt to mention yourself, but put a backslash at the start
*(to make it slightly easier, add the backslash after the mention has been typed)*. *(to make it slightly easier, add the backslash after the mention has been typed)*.

1
mkdocs.yml
View File

@@ -75,6 +75,7 @@ nav:
- Windows Guide: guides/windows-guide.md - Windows Guide: guides/windows-guide.md
- Linux Guide: guides/linux-guide.md - Linux Guide: guides/linux-guide.md
- OSX Guide: guides/osx-guide.md - OSX Guide: guides/osx-guide.md
- Windows Guide (from source): guides/windows-source-guide.md
- Docker Guide (unsupported): guides/docker-guide.md - Docker Guide (unsupported): guides/docker-guide.md
- Commands: - Commands:
- Readme: commands-readme.md - Readme: commands-readme.md