diff --git a/README.md b/README.md index 2ee2b061..e4ef3296 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ If you are reading this it looks like you are looking to add an egg to your serv * [Muse](/bots/discord/muse) Node JS * [parkertron](/bots/discord/parkertron) Golang * [pixel-bot](/bots/discord/pixelbot) Python +* [PteroDiscord](/bots/discord/PterodiscordBot/Python) Python * [Redbot](/bots/discord/redbot) Python * [Ree6](/bots/discord/ree6) Java * [SinusBot](/bots/discord/sinusbot) diff --git a/bots/discord/PterodiscordBot/Python/README.md b/bots/discord/PterodiscordBot/Python/README.md new file mode 100644 index 00000000..d7d0a88a --- /dev/null +++ b/bots/discord/PterodiscordBot/Python/README.md @@ -0,0 +1,37 @@ +# Pterodactyl Discord Bot Egg + +This is a Pterodactyl Discord Bot egg based on the Python egg from parkervcp. It installs and configures a Discord bot on a Pterodactyl-hosted server. + +## Credits +This egg is based on the [Python egg](https://github.com/parkervcp/eggs/tree/master/generic/python) by [parkervcp](https://github.com/parkervcp). Thanks to parkervcp for the original work and inspiration. + +## Installation +1. Import the egg to your Pterodactyl Panel +2. Make a new server with this egg +3. Start the server and all of the dependencies will be install automatically +4. Configure the bot/config.json. Make sure you set the bot token and the guild ID to your bot and Discord Guild +5. Have fun managing your Pterodactyl Panel from your Discord server + +## Instructions +- The settings file for the Discord bot should be configured according to the documentation of your specific bot. +- Manually upload any other required files to the server unless otherwise specified in the settings file. + +## Docker Images +This egg supports the following Python versions: +- Python 3.12 +- Python 3.11 +- Python 3.10 +- Python 3.9 +- Python 3.8 +- Python 3.7 +- Python 2.7 + +## Variables +- `PY_FILE`: The file that starts the Discord bot. Default value: `bot/start.py`. +- `PY_PACKAGES`: Additional Python packages to install. Use spaces to separate. +- `USER_UPLOAD`: Specify whether the user wants to manually upload all other files. Default value: `0`. + +## Authors +- parkervcp - Original author of the Python egg. +- [Poseidon](https://github.com/Poseidon281) - Customizations for this Discord bot egg and the making of the [Bot](https://github.com/Poseidon281/Pterodactyl-Discord-Bot). + diff --git a/bots/discord/PterodiscordBot/Python/egg-python-pterodactyl-discord-bot.json b/bots/discord/PterodiscordBot/Python/egg-python-pterodactyl-discord-bot.json new file mode 100644 index 00000000..c274a70e --- /dev/null +++ b/bots/discord/PterodiscordBot/Python/egg-python-pterodactyl-discord-bot.json @@ -0,0 +1,48 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-04-10T19:38:51+02:00", + "name": "Python Pterodactyl Discord Bot 2.0", + "author": "parker@parkervcp.com", + "description": "A egg that installs a Pterodactyl Discord Bot\r\n\r\nThis egg is build on the python egg from parkervcp", + "features": null, + "docker_images": { + "Python 3.12": "ghcr.io\/parkervcp\/yolks:python_3.12", + "Python 3.11": "ghcr.io\/parkervcp\/yolks:python_3.11", + "Python 3.10": "ghcr.io\/parkervcp\/yolks:python_3.10", + "Python 3.9": "ghcr.io\/parkervcp\/yolks:python_3.9", + "Python 3.8": "ghcr.io\/parkervcp\/yolks:python_3.8", + "Python 3.7": "ghcr.io\/parkervcp\/yolks:python_3.7", + "Python 2.7": "ghcr.io\/parkervcp\/yolks:python_2.7" + }, + "file_denylist": [], + "startup": "\/usr\/local\/bin\/python \/home\/container\/{{START_FILE}}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"change this part\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n# Pterodactyl Python Bot Install Script\r\n#\r\n# Server Files: \/mnt\/server\r\napt update\r\napt install -y git curl jq file unzip make gcc g++ libtool\r\n\r\ncd \/mnt\/server\r\n\r\necho \"Getting bot from GitHub...\"\r\ngit clone https:\/\/github.com\/Poseidon281\/Pterodactyl-Discord-Bot.git \/mnt\/server\r\n\r\necho -e \"Installation complete.\"\r\nexit 0", + "container": "python:3.8-slim-bookworm", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "App py file", + "description": "The file that you want to start the bot", + "env_variable": "START_FILE", + "default_value": "bot\/start.py", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +}