mirror of
https://github.com/ahmadk953/poixpixel-discord-bot.git
synced 2025-05-10 02:33:06 +00:00
docs: update file names - GITBOOK-2
This commit is contained in:
gitbook-bot
parent
a859e0ea4f
commit
6bf290d447
33 changed files with 31 additions and 31 deletions
|
|
@ -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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Discord Applications Page" alt="Applications page of the Discord Developer Dashboard"><figcaption><p>Discord Developer Dashboard Applications Page</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/DiscordApplicationsPage.png" alt="Applications page of the Discord Developer Dashboard"><figcaption><p>Discord Developer Dashboard Applications Page</p></figcaption></figure>
|
||||
|
||||
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".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Discord Applications Page Marked Up" alt="Red arrow pointing to button on left navigation pane that says "New Application""><figcaption><p>Create a New Application</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/DiscordApplicationsPageMarkedUp.png" alt="Red arrow pointing to button on left navigation pane that says "New Application""><figcaption><p>Create a New Application</p></figcaption></figure>
|
||||
|
||||
After clicking the button, give you Discord Bot a name, click the check box, and then click "Create".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Create Application Dialogue" alt="Create application dialogue"><figcaption><p>Create Application Dialogue</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/CreateApplicationDialogue.png" alt="Create application dialogue"><figcaption><p>Create Application Dialogue</p></figcaption></figure>
|
||||
|
||||
Once you click the "Create" button and complete the CAPTCHA, you should see a page like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Home Page" alt="Discord application overview page"><figcaption><p>Discord Application Overview Page</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotHomePage.png" alt="Discord application overview page"><figcaption><p>Discord Application Overview Page</p></figcaption></figure>
|
||||
|
||||
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".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/OAuth2 Tab" alt="Red arrow pointing to button on left navigation pane that says "OAuth2""><figcaption><p>OAuth2 Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/OAuth2Tab.png" alt="Red arrow pointing to button on left navigation pane that says "OAuth2""><figcaption><p>OAuth2 Button</p></figcaption></figure>
|
||||
|
||||
Once you click the button, you should see a page that looks like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/OAuth2 Page" alt="OAuth2 Page"><figcaption><p>OAuth2 Page</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/OAuth2Page.png" alt="OAuth2 Page"><figcaption><p>OAuth2 Page</p></figcaption></figure>
|
||||
|
||||
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.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Client ID Copy" alt="Arrow pointing to "Copy" button under Client ID section"><figcaption><p>Client ID</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/ClientIDCopy.png" alt="Arrow pointing to "Copy" button under Client ID section"><figcaption><p>Client ID</p></figcaption></figure>
|
||||
|
||||
Next, scroll down to this section:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/OAuth2 URL Generator" alt="OAuth2 URL Generator"><figcaption><p>OAuth2 URL Generator</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/OAuth2URLGenerator.png" alt="OAuth2 URL Generator"><figcaption><p>OAuth2 URL Generator</p></figcaption></figure>
|
||||
|
||||
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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/OAuth2 URL Generator Configuration" alt="OAuth2 URL Generator Configuration Options"><figcaption><p>OAuth2 URL Generator Configuration</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/OAuth2URLGeneratorConfiguration.png" alt="OAuth2 URL Generator Configuration Options"><figcaption><p>OAuth2 URL Generator Configuration</p></figcaption></figure>
|
||||
|
||||
Click "Copy" next to "Generated URL".\
|
||||
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Copy Generated OAuth2 URL" alt="Copy generated URL"><figcaption><p>Copy Generated URL</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/CopyGeneratedOAuth2URL.png" alt="Copy generated URL"><figcaption><p>Copy Generated URL</p></figcaption></figure>
|
||||
|
||||
Open a new browser tab, pase in the link, and press <kbd>Enter</kbd>. 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 <kbd>Enter</kbd>. 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 %}
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image.png" alt="Invite discord bot to server dialogue"><figcaption><p>Invite Discord Bot Dialogue</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/InviteBotServerSelect.png" alt="Invite discord bot to server dialogue"><figcaption><p>Invite Discord Bot Dialogue</p></figcaption></figure>
|
||||
|
||||
On the next screen, click "Authorize" and if prompted, complete multifactor authentication and the CAPTCHA.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Authorize Discord Bot" alt="Authorize Discord Bot"><figcaption><p>Authorize Discord Bot</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/AuthorizeDiscordBot.png" alt="Authorize Discord Bot"><figcaption><p>Authorize Discord Bot</p></figcaption></figure>
|
||||
|
||||
If everything was successful, you should see a success message like the one below.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Added Success Message" alt="Discord bot added successfully message"><figcaption><p>Success Message</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotAddedSuccessMessage.png" alt="Discord bot added successfully message"><figcaption><p>Success Message</p></figcaption></figure>
|
||||
|
||||
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".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Installation Tab" alt="Red arrow pointing to button on left navigation pane that says "Installation""><figcaption><p>Installation Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/InstallationTab.png" alt="Red arrow pointing to button on left navigation pane that says "Installation""><figcaption><p>Installation Button</p></figcaption></figure>
|
||||
|
||||
After you click on the button, you'll be greeted by a page that look something like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Installation Page" alt="Installation page"><figcaption><p>Installation Page</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/InstallationPage.png" alt="Installation page"><figcaption><p>Installation Page</p></figcaption></figure>
|
||||
|
||||
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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Installation Complete Options" alt="Updated installation options"><figcaption><p>Updated Installation Options</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/InstallationCompleteOptions.png" alt="Updated installation options"><figcaption><p>Updated Installation Options</p></figcaption></figure>
|
||||
|
||||
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".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Tab (1)" alt="Red arrow pointing to button on left navigation pane that says "Bot""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotTab.png" alt="Red arrow pointing to button on left navigation pane that says "Bot""><figcaption></figcaption></figure>
|
||||
|
||||
After clicking on the "Bot" tab, you'll see a page like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Tab" alt="Discord application bot tab"><figcaption><p>Discord Application Bot Tab</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotPage.png" alt="Discord application bot tab"><figcaption><p>Discord Application Bot Tab</p></figcaption></figure>
|
||||
|
||||
Here, you can configure things such as the username, banner, and icon of your bot. Scroll down to the section that looks like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Options" alt="Discord bot options"><figcaption><p>Bot Options</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotOptions.png" alt="Discord bot options"><figcaption><p>Bot Options</p></figcaption></figure>
|
||||
|
||||
Deselect the "Public Bot" option and choose all other options. Make sure to click "Save". Your screen should resemble this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Options Complete" alt="Updated bot options"><figcaption><p>Updated Bot Options</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotOptionsComplete.png" alt="Updated bot options"><figcaption><p>Updated Bot Options</p></figcaption></figure>
|
||||
|
||||
{% 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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Basic Bot Config Options" alt="Bot details and token configuration options"><figcaption><p>Basic Bot Configuration and Token Options</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BasicBotConfigOptions.png" alt="Bot details and token configuration options"><figcaption><p>Basic Bot Configuration and Token Options</p></figcaption></figure>
|
||||
|
||||
Underneath the "Token" header, click on the button that says, "Reset Token".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Reset Bot Token Button" alt="Reset bot token button"><figcaption><p>Reset Token Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/ResetBotTokenButton.png" alt="Reset bot token button"><figcaption><p>Reset Token Button</p></figcaption></figure>
|
||||
|
||||
Click "Yes, do it!" on the dialogue that pops up.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Reset Bot Token Dialogue" alt="Reset bot token confirmation dialogue"><figcaption><p>Reset Bot Token Dialogue</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/ResetBotTokenDialogue.png" alt="Reset bot token confirmation dialogue"><figcaption><p>Reset Bot Token Dialogue</p></figcaption></figure>
|
||||
|
||||
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 %}
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bot Token" alt="Discord bot token"><figcaption><p>Discord Bot Token</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/BotToken.png" alt="Discord bot token"><figcaption><p>Discord Bot Token</p></figcaption></figure>
|
||||
|
||||
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.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Settings Icon" alt="Red arrow pointing to settings button"><figcaption><p>Settings Icon</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/SettingsIcon.png" alt="Red arrow pointing to settings button"><figcaption><p>Settings Icon</p></figcaption></figure>
|
||||
|
||||
Next, scroll down on the left navigation pane and click "Advanced".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Advanced Settings Tab" alt="Red arrow pointing to button on left navigation pane that says "Advanced""><figcaption><p>Advanced Settings Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/AdvancedSettingsTab.png" alt="Red arrow pointing to button on left navigation pane that says "Advanced""><figcaption><p>Advanced Settings Button</p></figcaption></figure>
|
||||
|
||||
Find the option that says, "Developer Mode" and turn that on. Once you are done, your screen should look like this:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Developer Mode Toggle" alt="Developer mode toggle on"><figcaption><p>Developer Mode Toggle Turned On</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/DeveloperModeToggle.png" alt="Developer mode toggle on"><figcaption><p>Developer Mode Toggle Turned On</p></figcaption></figure>
|
||||
|
||||
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.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Copy Server ID" alt="Red arrow pointing to button that says "Copy Server ID""><figcaption><p>Copy Server ID Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/CopyServerID.png" alt="Red arrow pointing to button that says "Copy Server ID""><figcaption><p>Copy Server ID Button</p></figcaption></figure>
|
||||
|
||||
Next, in your Discord server, right click on your logs channel and click the "Copy Channel ID" button. Repeat this for your welcome channel.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Copy Channel ID" alt="Red arrow pointing to button that says "Copy Channel ID""><figcaption><p>Copy Channel ID Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/CopyChannelID.png" alt="Red arrow pointing to button that says "Copy Channel ID""><figcaption><p>Copy Channel ID Button</p></figcaption></figure>
|
||||
|
||||
Lastly, click on your server's name at the top and click on "Server Settings".
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Server Settings" alt="Server settings button"><figcaption><p>Server Settings Button</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/ServerSettings.png" alt="Server settings button"><figcaption><p>Server Settings Button</p></figcaption></figure>
|
||||
|
||||
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.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Copy Role ID" alt="Copy role ID for join roles"><figcaption><p>Copy Join Role ID</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/CopyRoleID.png" alt="Copy role ID for join roles"><figcaption><p>Copy Join Role ID</p></figcaption></figure>
|
||||
|
||||
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 %}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue