How to Install

Pterodactyl Install

1. Make sure that you have either created a server or you have been provisioned a server by your hosting provider.
2. Upload the bot into your server container.
3. Edit the config.py.
   • Edit the database variable.
     • Set the 'host' key to be that of your database host (in most cases, it's just 'localhost').
     • Set the 'user' key to be the username of the user to access the database.
     • Set the 'password' key to be the password of the user.
     • Set the 'name' key to be the name of the database.
   • Edit the information variable
     • Set the 'token' key to be that of a Discord bot in your server.
     • Set the 'guild' key to be the ID of your guild.
     • Set the 'name' key to be the name that should appear on the bot.
     • Set the 'domain' key to be the link to your install of Store System (don't include a trailing slash).
     • Set the 'color' key to be RGB values for the color of the bot.
4. Start the container and your bot should work! The bot uses slash commands.
   
   

Linux/Windows Install

1. Make sure that you have Python 3.11 installed on your OS. If you're on Linux, check this link for downloading Python 3.11. If you're on Windows, go here.
2. Make sure to install PyCord. Follow their documentation for installing the development version. This can be done by following their guide here.
3. After installing PyCord, extract the bot into a folder where you can access it.
4. After extracting the folder, you need to edit the config.py.
   • Edit the database variable.
     • Set the 'host' key to be that of your database host (in most cases, it's just 'localhost').
     • Set the 'user' key to be the username of the user to access the database.
     • Set the 'password' key to be the password of the user.
     • Set the 'name' key to be the name of the database.
   • Edit the information variable
     • Set the 'token' key to be that of a Discord bot in your server.
     • Set the 'guild' key to be the ID of your guild.
     • Set the 'name' key to be the name that should appear on the bot.
     • Set the 'domain' key to be the link to your install of Store System (don't include a trailing slash).
     • Set the 'color' key to be RGB values for the color of the bot.
5. After editing the config.py, open up your command prompt and navigate to the folder with the bot inside of it and run the following command: 'pip install -r requirements.txt'.
6. After running this command, you can start the bot with the following command: 'py main.py'