From 6bf290d447ae0b125e7cc8a833abcfe33f0ba216 Mon Sep 17 00:00:00 2001 From: Ahmad Date: Mon, 14 Apr 2025 18:57:40 +0000 Subject: [PATCH] docs: update file names - GITBOOK-2 --- ...d Settings Tab => AdvancedSettingsTab.png} | Bin ...ze Discord Bot => AuthorizeDiscordBot.png} | Bin ...nfig Options => BasicBotConfigOptions.png} | Bin ...ess Message => BotAddedSuccessMessage.png} | Bin .../assets/{Bot Home Page => BotHomePage.png} | Bin .../assets/{Bot Options => BotOptions.png} | Bin ...ptions Complete => BotOptionsComplete.png} | Bin .../.gitbook/assets/{Bot Tab => BotPage.png} | Bin .../assets/{Bot Tab (1) => BotTab.png} | Bin .../assets/{Bot Token => BotToken.png} | Bin .../{Client ID Copy => ClientIDCopy.png} | Bin .../{Copy Channel ID => CopyChannelID.png} | Bin ... OAuth2 URL => CopyGeneratedOAuth2URL.png} | Bin .../assets/{Copy Role ID => CopyRoleID.png} | Bin .../{Copy Server ID => CopyServerID.png} | Bin ...Dialogue => CreateApplicationDialogue.png} | Bin ...er Mode Toggle => DeveloperModeToggle.png} | Bin ...tions Page => DiscordApplicationsPage.png} | Bin ...Up => DiscordApplicationsPageMarkedUp.png} | Bin ...ptions => InstallationCompleteOptions.png} | Bin ...Installation Page => InstallationPage.png} | Bin .../{Installation Tab => InstallationTab.png} | Bin .../{image.png => InviteBotServerSelect.png} | Bin ... Dialogue => InviteDiscordBotDialogue.png} | Bin .../assets/{OAuth2 Page => OAuth2Page.png} | Bin .../assets/{OAuth2 Tab => OAuth2Tab.png} | Bin ...2 URL Generator => OAuth2URLGenerator.png} | Bin ...on => OAuth2URLGeneratorConfiguration.png} | Bin ...t Token Button => ResetBotTokenButton.png} | Bin ...ken Dialogue => ResetBotTokenDialogue.png} | Bin .../{Server Settings => ServerSettings.png} | Bin .../{Settings Icon => SettingsIcon.png} | Bin docs/bot/getting-started/quickstart/README.md | 62 +++++++++--------- 33 files changed, 31 insertions(+), 31 deletions(-) rename docs/bot/.gitbook/assets/{Advanced Settings Tab => AdvancedSettingsTab.png} (100%) rename docs/bot/.gitbook/assets/{Authorize Discord Bot => AuthorizeDiscordBot.png} (100%) rename docs/bot/.gitbook/assets/{Basic Bot Config Options => BasicBotConfigOptions.png} (100%) rename docs/bot/.gitbook/assets/{Bot Added Success Message => BotAddedSuccessMessage.png} (100%) rename docs/bot/.gitbook/assets/{Bot Home Page => BotHomePage.png} (100%) rename docs/bot/.gitbook/assets/{Bot Options => BotOptions.png} (100%) rename docs/bot/.gitbook/assets/{Bot Options Complete => BotOptionsComplete.png} (100%) rename docs/bot/.gitbook/assets/{Bot Tab => BotPage.png} (100%) rename docs/bot/.gitbook/assets/{Bot Tab (1) => BotTab.png} (100%) rename docs/bot/.gitbook/assets/{Bot Token => BotToken.png} (100%) rename docs/bot/.gitbook/assets/{Client ID Copy => ClientIDCopy.png} (100%) rename docs/bot/.gitbook/assets/{Copy Channel ID => CopyChannelID.png} (100%) rename docs/bot/.gitbook/assets/{Copy Generated OAuth2 URL => CopyGeneratedOAuth2URL.png} (100%) rename docs/bot/.gitbook/assets/{Copy Role ID => CopyRoleID.png} (100%) rename docs/bot/.gitbook/assets/{Copy Server ID => CopyServerID.png} (100%) rename docs/bot/.gitbook/assets/{Create Application Dialogue => CreateApplicationDialogue.png} (100%) rename docs/bot/.gitbook/assets/{Developer Mode Toggle => DeveloperModeToggle.png} (100%) rename docs/bot/.gitbook/assets/{Discord Applications Page => DiscordApplicationsPage.png} (100%) rename docs/bot/.gitbook/assets/{Discord Applications Page Marked Up => DiscordApplicationsPageMarkedUp.png} (100%) rename docs/bot/.gitbook/assets/{Installation Complete Options => InstallationCompleteOptions.png} (100%) rename docs/bot/.gitbook/assets/{Installation Page => InstallationPage.png} (100%) rename docs/bot/.gitbook/assets/{Installation Tab => InstallationTab.png} (100%) rename docs/bot/.gitbook/assets/{image.png => InviteBotServerSelect.png} (100%) rename docs/bot/.gitbook/assets/{Invite Discord Bot Dialogue => InviteDiscordBotDialogue.png} (100%) rename docs/bot/.gitbook/assets/{OAuth2 Page => OAuth2Page.png} (100%) rename docs/bot/.gitbook/assets/{OAuth2 Tab => OAuth2Tab.png} (100%) rename docs/bot/.gitbook/assets/{OAuth2 URL Generator => OAuth2URLGenerator.png} (100%) rename docs/bot/.gitbook/assets/{OAuth2 URL Generator Configuration => OAuth2URLGeneratorConfiguration.png} (100%) rename docs/bot/.gitbook/assets/{Reset Bot Token Button => ResetBotTokenButton.png} (100%) rename docs/bot/.gitbook/assets/{Reset Bot Token Dialogue => ResetBotTokenDialogue.png} (100%) rename docs/bot/.gitbook/assets/{Server Settings => ServerSettings.png} (100%) rename docs/bot/.gitbook/assets/{Settings Icon => SettingsIcon.png} (100%) diff --git a/docs/bot/.gitbook/assets/Advanced Settings Tab b/docs/bot/.gitbook/assets/AdvancedSettingsTab.png similarity index 100% rename from docs/bot/.gitbook/assets/Advanced Settings Tab rename to docs/bot/.gitbook/assets/AdvancedSettingsTab.png diff --git a/docs/bot/.gitbook/assets/Authorize Discord Bot b/docs/bot/.gitbook/assets/AuthorizeDiscordBot.png similarity index 100% rename from docs/bot/.gitbook/assets/Authorize Discord Bot rename to docs/bot/.gitbook/assets/AuthorizeDiscordBot.png diff --git a/docs/bot/.gitbook/assets/Basic Bot Config Options b/docs/bot/.gitbook/assets/BasicBotConfigOptions.png similarity index 100% rename from docs/bot/.gitbook/assets/Basic Bot Config Options rename to docs/bot/.gitbook/assets/BasicBotConfigOptions.png diff --git a/docs/bot/.gitbook/assets/Bot Added Success Message b/docs/bot/.gitbook/assets/BotAddedSuccessMessage.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Added Success Message rename to docs/bot/.gitbook/assets/BotAddedSuccessMessage.png diff --git a/docs/bot/.gitbook/assets/Bot Home Page b/docs/bot/.gitbook/assets/BotHomePage.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Home Page rename to docs/bot/.gitbook/assets/BotHomePage.png diff --git a/docs/bot/.gitbook/assets/Bot Options b/docs/bot/.gitbook/assets/BotOptions.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Options rename to docs/bot/.gitbook/assets/BotOptions.png diff --git a/docs/bot/.gitbook/assets/Bot Options Complete b/docs/bot/.gitbook/assets/BotOptionsComplete.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Options Complete rename to docs/bot/.gitbook/assets/BotOptionsComplete.png diff --git a/docs/bot/.gitbook/assets/Bot Tab b/docs/bot/.gitbook/assets/BotPage.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Tab rename to docs/bot/.gitbook/assets/BotPage.png diff --git a/docs/bot/.gitbook/assets/Bot Tab (1) b/docs/bot/.gitbook/assets/BotTab.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Tab (1) rename to docs/bot/.gitbook/assets/BotTab.png diff --git a/docs/bot/.gitbook/assets/Bot Token b/docs/bot/.gitbook/assets/BotToken.png similarity index 100% rename from docs/bot/.gitbook/assets/Bot Token rename to docs/bot/.gitbook/assets/BotToken.png diff --git a/docs/bot/.gitbook/assets/Client ID Copy b/docs/bot/.gitbook/assets/ClientIDCopy.png similarity index 100% rename from docs/bot/.gitbook/assets/Client ID Copy rename to docs/bot/.gitbook/assets/ClientIDCopy.png diff --git a/docs/bot/.gitbook/assets/Copy Channel ID b/docs/bot/.gitbook/assets/CopyChannelID.png similarity index 100% rename from docs/bot/.gitbook/assets/Copy Channel ID rename to docs/bot/.gitbook/assets/CopyChannelID.png diff --git a/docs/bot/.gitbook/assets/Copy Generated OAuth2 URL b/docs/bot/.gitbook/assets/CopyGeneratedOAuth2URL.png similarity index 100% rename from docs/bot/.gitbook/assets/Copy Generated OAuth2 URL rename to docs/bot/.gitbook/assets/CopyGeneratedOAuth2URL.png diff --git a/docs/bot/.gitbook/assets/Copy Role ID b/docs/bot/.gitbook/assets/CopyRoleID.png similarity index 100% rename from docs/bot/.gitbook/assets/Copy Role ID rename to docs/bot/.gitbook/assets/CopyRoleID.png diff --git a/docs/bot/.gitbook/assets/Copy Server ID b/docs/bot/.gitbook/assets/CopyServerID.png similarity index 100% rename from docs/bot/.gitbook/assets/Copy Server ID rename to docs/bot/.gitbook/assets/CopyServerID.png diff --git a/docs/bot/.gitbook/assets/Create Application Dialogue b/docs/bot/.gitbook/assets/CreateApplicationDialogue.png similarity index 100% rename from docs/bot/.gitbook/assets/Create Application Dialogue rename to docs/bot/.gitbook/assets/CreateApplicationDialogue.png diff --git a/docs/bot/.gitbook/assets/Developer Mode Toggle b/docs/bot/.gitbook/assets/DeveloperModeToggle.png similarity index 100% rename from docs/bot/.gitbook/assets/Developer Mode Toggle rename to docs/bot/.gitbook/assets/DeveloperModeToggle.png diff --git a/docs/bot/.gitbook/assets/Discord Applications Page b/docs/bot/.gitbook/assets/DiscordApplicationsPage.png similarity index 100% rename from docs/bot/.gitbook/assets/Discord Applications Page rename to docs/bot/.gitbook/assets/DiscordApplicationsPage.png diff --git a/docs/bot/.gitbook/assets/Discord Applications Page Marked Up b/docs/bot/.gitbook/assets/DiscordApplicationsPageMarkedUp.png similarity index 100% rename from docs/bot/.gitbook/assets/Discord Applications Page Marked Up rename to docs/bot/.gitbook/assets/DiscordApplicationsPageMarkedUp.png diff --git a/docs/bot/.gitbook/assets/Installation Complete Options b/docs/bot/.gitbook/assets/InstallationCompleteOptions.png similarity index 100% rename from docs/bot/.gitbook/assets/Installation Complete Options rename to docs/bot/.gitbook/assets/InstallationCompleteOptions.png diff --git a/docs/bot/.gitbook/assets/Installation Page b/docs/bot/.gitbook/assets/InstallationPage.png similarity index 100% rename from docs/bot/.gitbook/assets/Installation Page rename to docs/bot/.gitbook/assets/InstallationPage.png diff --git a/docs/bot/.gitbook/assets/Installation Tab b/docs/bot/.gitbook/assets/InstallationTab.png similarity index 100% rename from docs/bot/.gitbook/assets/Installation Tab rename to docs/bot/.gitbook/assets/InstallationTab.png diff --git a/docs/bot/.gitbook/assets/image.png b/docs/bot/.gitbook/assets/InviteBotServerSelect.png similarity index 100% rename from docs/bot/.gitbook/assets/image.png rename to docs/bot/.gitbook/assets/InviteBotServerSelect.png diff --git a/docs/bot/.gitbook/assets/Invite Discord Bot Dialogue b/docs/bot/.gitbook/assets/InviteDiscordBotDialogue.png similarity index 100% rename from docs/bot/.gitbook/assets/Invite Discord Bot Dialogue rename to docs/bot/.gitbook/assets/InviteDiscordBotDialogue.png diff --git a/docs/bot/.gitbook/assets/OAuth2 Page b/docs/bot/.gitbook/assets/OAuth2Page.png similarity index 100% rename from docs/bot/.gitbook/assets/OAuth2 Page rename to docs/bot/.gitbook/assets/OAuth2Page.png diff --git a/docs/bot/.gitbook/assets/OAuth2 Tab b/docs/bot/.gitbook/assets/OAuth2Tab.png similarity index 100% rename from docs/bot/.gitbook/assets/OAuth2 Tab rename to docs/bot/.gitbook/assets/OAuth2Tab.png diff --git a/docs/bot/.gitbook/assets/OAuth2 URL Generator b/docs/bot/.gitbook/assets/OAuth2URLGenerator.png similarity index 100% rename from docs/bot/.gitbook/assets/OAuth2 URL Generator rename to docs/bot/.gitbook/assets/OAuth2URLGenerator.png diff --git a/docs/bot/.gitbook/assets/OAuth2 URL Generator Configuration b/docs/bot/.gitbook/assets/OAuth2URLGeneratorConfiguration.png similarity index 100% rename from docs/bot/.gitbook/assets/OAuth2 URL Generator Configuration rename to docs/bot/.gitbook/assets/OAuth2URLGeneratorConfiguration.png diff --git a/docs/bot/.gitbook/assets/Reset Bot Token Button b/docs/bot/.gitbook/assets/ResetBotTokenButton.png similarity index 100% rename from docs/bot/.gitbook/assets/Reset Bot Token Button rename to docs/bot/.gitbook/assets/ResetBotTokenButton.png diff --git a/docs/bot/.gitbook/assets/Reset Bot Token Dialogue b/docs/bot/.gitbook/assets/ResetBotTokenDialogue.png similarity index 100% rename from docs/bot/.gitbook/assets/Reset Bot Token Dialogue rename to docs/bot/.gitbook/assets/ResetBotTokenDialogue.png diff --git a/docs/bot/.gitbook/assets/Server Settings b/docs/bot/.gitbook/assets/ServerSettings.png similarity index 100% rename from docs/bot/.gitbook/assets/Server Settings rename to docs/bot/.gitbook/assets/ServerSettings.png diff --git a/docs/bot/.gitbook/assets/Settings Icon b/docs/bot/.gitbook/assets/SettingsIcon.png similarity index 100% rename from docs/bot/.gitbook/assets/Settings Icon rename to docs/bot/.gitbook/assets/SettingsIcon.png diff --git a/docs/bot/getting-started/quickstart/README.md b/docs/bot/getting-started/quickstart/README.md index 32bff15..18fda89 100644 --- a/docs/bot/getting-started/quickstart/README.md +++ b/docs/bot/getting-started/quickstart/README.md @@ -32,7 +32,7 @@ After deciding on how you want to host the bot and its resources, move onto the [Click this link](https://discord.com/developers/applications) and sign into your discord account. Once you sign in, you should see a page like this: -
Applications page of the Discord Developer Dashboard

Discord Developer Dashboard Applications Page

+
Applications page of the Discord Developer Dashboard

Discord Developer Dashboard Applications Page

This is what's known as your applications page. This is where you'll see and manage all of your Discord bots and applications. {% endstep %} @@ -42,15 +42,15 @@ This is what's known as your applications page. This is where you'll see and man Click the button that says, "New Application". -
Red arrow pointing to button on left navigation pane that says "New Application"

Create a New Application

+
Red arrow pointing to button on left navigation pane that says "New Application"

Create a New Application

After clicking the button, give you Discord Bot a name, click the check box, and then click "Create". -
Create application dialogue

Create Application Dialogue

+
Create application dialogue

Create Application Dialogue

Once you click the "Create" button and complete the CAPTCHA, you should see a page like this: -
Discord application overview page

Discord Application Overview Page

+
Discord application overview page

Discord Application Overview Page

This is the overview page for your Discord bot. Here, you can configure the app icon, the app name, and app description. {% endstep %} @@ -60,28 +60,28 @@ This is the overview page for your Discord bot. Here, you can configure the app In the left navigation pane, click the button that says, "OAuth2". -
Red arrow pointing to button on left navigation pane that says "OAuth2"

OAuth2 Button

+
Red arrow pointing to button on left navigation pane that says "OAuth2"

OAuth2 Button

Once you click the button, you should see a page that looks like this: -
OAuth2 Page

OAuth2 Page

+
OAuth2 Page

OAuth2 Page

Underneath the section that says, "Client Information" where it says "Client ID", click on the "Copy" button. Save this number as we'll need it for later. -
Arrow pointing to "Copy" button under Client ID section

Client ID

+
Arrow pointing to "Copy" button under Client ID section

Client ID

Next, scroll down to this section: -
OAuth2 URL Generator

OAuth2 URL Generator

+
OAuth2 URL Generator

OAuth2 URL Generator

Check the checkbox next to where it says, "bot". Scroll down. Under the "Bot Permissions" section, click the checkbox for "Administrator" under the "General Permissions" section. Next, scroll down again and for the "Intergration Type" dropdown, make sure it says, "Guild Install". In the end, your configuration should look something like this: -
OAuth2 URL Generator Configuration Options

OAuth2 URL Generator Configuration

+
OAuth2 URL Generator Configuration Options

OAuth2 URL Generator Configuration

Click "Copy" next to "Generated URL".\ -
Copy generated URL

Copy Generated URL

+
Copy generated URL

Copy Generated URL

Open a new browser tab, pase in the link, and press Enter. You should then see a screen where you can invite the bot into a Discord server. Select your Discord server from the dropdown menu and click "continue". @@ -89,15 +89,15 @@ Open a new browser tab, pase in the link, and press Enter. You should If you don't see the server you want to add the bot to, it's probably because you don't have the **Manage Server** permission in that Discord server {% endhint %} -
Invite discord bot to server dialogue

Invite Discord Bot Dialogue

+
Invite discord bot to server dialogue

Invite Discord Bot Dialogue

On the next screen, click "Authorize" and if prompted, complete multifactor authentication and the CAPTCHA. -
Authorize Discord Bot

Authorize Discord Bot

+
Authorize Discord Bot

Authorize Discord Bot

If everything was successful, you should see a success message like the one below. -
Discord bot added successfully message

Success Message

+
Discord bot added successfully message

Success Message

The discord bot was successfully added to your selected Discord server. You can now continue with the rest of the guide. {% endstep %} @@ -107,15 +107,15 @@ The discord bot was successfully added to your selected Discord server. You can Click the button on the left navigation pane that says, "Installation". -
Red arrow pointing to button on left navigation pane that says "Installation"

Installation Button

+
Red arrow pointing to button on left navigation pane that says "Installation"

Installation Button

After you click on the button, you'll be greeted by a page that look something like this: -
Installation page

Installation Page

+
Installation page

Installation Page

First, uncheck the checkbox next to "User Install". Next, select "None" from the "Install Link" dropdown (click where it says "Discord Provided Link"). Finally, click "Save" at the bottom of the screen. When you're done, your screen should look like this: -
Updated installation options

Updated Installation Options

+
Updated installation options

Updated Installation Options

Now, it's time to configure the actual Discord bot. {% endstep %} @@ -125,19 +125,19 @@ Now, it's time to configure the actual Discord bot. Click the button on the left navigation pane that says, "Bot". -
Red arrow pointing to button on left navigation pane that says "Bot"
+
Red arrow pointing to button on left navigation pane that says "Bot"
After clicking on the "Bot" tab, you'll see a page like this: -
Discord application bot tab

Discord Application Bot Tab

+
Discord application bot tab

Discord Application Bot Tab

Here, you can configure things such as the username, banner, and icon of your bot. Scroll down to the section that looks like this: -
Discord bot options

Bot Options

+
Discord bot options

Bot Options

Deselect the "Public Bot" option and choose all other options. Make sure to click "Save". Your screen should resemble this: -
Updated bot options

Updated Bot Options

+
Updated bot options

Updated Bot Options

{% hint style="info" %} **Explanation for Selected Options:** @@ -149,15 +149,15 @@ Deselect the "Public Bot" option and choose all other options. Make sure to clic Next, scroll back up to this section: -
Bot details and token configuration options

Basic Bot Configuration and Token Options

+
Bot details and token configuration options

Basic Bot Configuration and Token Options

Underneath the "Token" header, click on the button that says, "Reset Token". -
Reset bot token button

Reset Token Button

+
Reset bot token button

Reset Token Button

Click "Yes, do it!" on the dialogue that pops up. -
Reset bot token confirmation dialogue

Reset Bot Token Dialogue

+
Reset bot token confirmation dialogue

Reset Bot Token Dialogue

Follow the multifactor authentication steps, and once complete, you should see a screen like this: @@ -165,7 +165,7 @@ Follow the multifactor authentication steps, and once complete, you should see a **WARNING: DO NOT SHARE YOUR BOT TOKEN WITH ANYONE. Treat your bot token like a password. If someone gets access to your bot's token, they'll have unrestricted access to your bot and Discord server, meaning they can do anything that they want. Store this token in a safe place as you won't get to see it again and will have to regenerate it.** {% endhint %} -
Discord bot token

Discord Bot Token

+
Discord bot token

Discord Bot Token

Copy your bot token and save it somewhere safe. We'll need it later. {% endstep %} @@ -177,31 +177,31 @@ If you've made it this far without getting lost, give yourself a pat on the back Head on over to [Discord](https://discord.com/app) and click on the settings icon next to your username. -
Red arrow pointing to settings button

Settings Icon

+
Red arrow pointing to settings button

Settings Icon

Next, scroll down on the left navigation pane and click "Advanced". -
Red arrow pointing to button on left navigation pane that says "Advanced"

Advanced Settings Button

+
Red arrow pointing to button on left navigation pane that says "Advanced"

Advanced Settings Button

Find the option that says, "Developer Mode" and turn that on. Once you are done, your screen should look like this: -
Developer mode toggle on

Developer Mode Toggle Turned On

+
Developer mode toggle on

Developer Mode Toggle Turned On

Exit settings and navigate to your Discord server. On the left server selector pane, right click on your Discord server and click the "Copy Server ID" button on the bottom of the options menu. This is what's known as your "Guild ID". Save this ID as we'll need it later. -
Red arrow pointing to button that says "Copy Server ID"

Copy Server ID Button

+
Red arrow pointing to button that says "Copy Server ID"

Copy Server ID Button

Next, in your Discord server, right click on your logs channel and click the "Copy Channel ID" button. Repeat this for your welcome channel. -
Red arrow pointing to button that says "Copy Channel ID"

Copy Channel ID Button

+
Red arrow pointing to button that says "Copy Channel ID"

Copy Channel ID Button

Lastly, click on your server's name at the top and click on "Server Settings". -
Server settings button

Server Settings Button

+
Server settings button

Server Settings Button

Then, click on the "Roles" button in the left navigation pane and find the role(s) that you want to assign to people as soon as they join your server. Right click on each role and select "Copy Role ID". Save these ID's as we'll need them later when configuring the bot. -
Copy role ID for join roles

Copy Join Role ID

+
Copy role ID for join roles

Copy Join Role ID

We are now done with the preparation for our Discord bot. It's now time to setup and deploy the Discord bot and its services. Based on your decision in Step 0, click on the corresponding link to take you to the rest of the quick start guide. {% endstep %}