cswimr/SeaCogs
cswimr/SeaCogs
1
1
Fork 1
Code Issues 7 Pull requests 4 Projects 1 Packages Wiki Activity Actions
SeaCogs/.docs/pterodactyl/installing-red.md
SeaswimmerTheFsh eecf1fb70f
Some checks failed
Actions / Lint Code (Ruff & Pylint) (push) Failing after 21s
Details
Actions / Build Documentation (MkDocs) (push) Successful in 25s
Details
docs(pterodactyl): added a guide on installing Red on Pterodactyl
2024-03-04 15:26:25 -05:00

2.9 KiB
Raw Blame History

Installing Red

This guide will explain how to create an instance of Red-DiscordBot (referred to as 'Red') on a Pterodactyl panel.

Running the bot on Pterodactyl is not required to use the Pterodactyl cog. If you already have a working instance of Red, you should look at Getting Started.

/// admonition | Caveats type: warning There are a few caveats to running an instance of Red on Pterodactyl.

  • You will not receive any support from the Red developers.
  • The built-in Audio cog will not work.
  • Depending on your host, you might have to request a tmpfs size increase.

If these are unacceptable to you, you should install Red normally. ///

/// admonition | Requirements type: info

Creating a Server Split

  1. Navigate to your host's server split option.
  2. Select Discord Bots in the Server Category dropdown
  3. Select Red in the Server Type dropdown
  4. Allocate 1gb of RAM to Red. You can get away with less, but for the purposes of this guide we'll be using 1gb.
  5. Allocate 5gb of storage space to Red.
  6. Click the Split Server button. The installation process will take a few minutes, once it's done, continue to the next section.

server-split-img

Configuring Startup Variables

  1. Navigate to the Startup page of your new server split.
  2. Enter in your bot token.
  3. If you want to change the default prefix that the bot will respond to, do so here.
  4. If you want to change the owner of the bot, you can do so here. This defaults to the owner of the application the bot user is from.

server-startup-img

Inviting the Bot

  1. Navigate to the Console page of your server split.
  2. Click the Start button.
  3. Click the Invite URL in your console, once the bot starts.

console-img

Initial Setup

Red is quite a large bot, so I'll focus on the specifics of getting the bot working with my Pterodactyl cog specifically.

/// admonition | [p] is your bot's prefix type: tip ///

  1. Load the Downloader cog.
[p]load downloader
  1. Add my repository to the bot
[p]repo add sea-cogs https://www.coastalcommits.com/SeaswimmerTheFsh/SeaCogs
  1. Install and load the Pterodactyl cog
[p]cog install sea-cogs pterodactyl
[p]load pterodactyl
  1. Follow the instructions given in Getting Started