From fce2696d4acb2ac3decb65338b217ded40fcabc8 Mon Sep 17 00:00:00 2001 From: Toastie Date: Tue, 10 Dec 2024 22:06:38 +1300 Subject: [PATCH] Updated some stuff and the docs version. --- content/Ellie/Features/creds-guide.md | 27 +++++++++++++++------------ go.mod | 2 +- go.sum | 2 ++ hugo.toml | 2 +- layouts/partials/menu-footer.html | 4 ++-- 5 files changed, 21 insertions(+), 16 deletions(-) diff --git a/content/Ellie/Features/creds-guide.md b/content/Ellie/Features/creds-guide.md index 9d4e3f9..69b9d9d 100644 --- a/content/Ellie/Features/creds-guide.md +++ b/content/Ellie/Features/creds-guide.md @@ -6,20 +6,23 @@ weight = 1 ## 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. +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. + +- 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 `elliebot/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.elliebot.net/bot-creds-guide.gif) -- Go to [the Discord developer application page][DiscordApp]. -- Log in with your Discord account. -- Click **New Application**. -- Fill out the `Name` field however you like. -- 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 your Token to `creds.yml` as shown above. -- Scroll down to the **`Privileged Gateway Intents`** section +1. Go to [the Discord developer application page][DiscordApp]. +2. Log in with your Discord account. +3. Click **New Application**. +4. Fill out the `Name` field however you like. +5. Go to the **Bot** tab on the left sidebar. +6. Click on the `Add a Bot` button and confirm that you do want to add a bot to this app. +7. **Optional:** Add bot's avatar and description. +8. Copy your Token to `creds.yml` as shown above. +9. Scroll down to the **`Privileged Gateway Intents`** section - **Enable the following:** - **PRESENCE INTENT** - **SERVER MEMBERS INTENT** @@ -27,7 +30,7 @@ This document aims to guide you through the process of creating a Discord accoun 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 *(to make it slightly easier, add the backslash after the mention has been typed)*. diff --git a/go.mod b/go.mod index 24c68ca..1a04b61 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module toastielab.dev/EllieBotDevs/EllieBot-docs go 1.22.2 -require github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442 // indirect +require github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263 // indirect diff --git a/go.sum b/go.sum index 4442d81..26a5f18 100644 --- a/go.sum +++ b/go.sum @@ -1,2 +1,4 @@ github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442 h1:1RtA0zdTRxvcsvcYMp4h4bGlJ3hCKN1AD8YCeb7FGik= github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM= +github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263 h1:sa/39uZBgVjQABKBJY2KySKgCxn6uek3mV2e3vmPxkw= +github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM= diff --git a/hugo.toml b/hugo.toml index 441be38..2cfe121 100644 --- a/hugo.toml +++ b/hugo.toml @@ -17,7 +17,7 @@ title = 'The documentation site for EllieBot' path = 'github.com/McShelby/hugo-theme-relearn' [outputs] - home = [ "html", "search", "searchpage" ] + home = [ "html" ] [params] themeVariant = [ diff --git a/layouts/partials/menu-footer.html b/layouts/partials/menu-footer.html index a90dee8..c6eb162 100644 --- a/layouts/partials/menu-footer.html +++ b/layouts/partials/menu-footer.html @@ -6,14 +6,14 @@ - +