From d8ba0d795f93c6e879a2858e66f5f2926db01311 Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Fri, 16 Feb 2018 22:05:28 -0500 Subject: [PATCH 1/3] Adding how-to --- HOWTO.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 46 insertions(+) create mode 100644 HOWTO.md diff --git a/HOWTO.md b/HOWTO.md new file mode 100644 index 00000000..ef81930c --- /dev/null +++ b/HOWTO.md @@ -0,0 +1,41 @@ +# So you want to make an Egg + +## General rules + +1. Keep it simple. + We don't need 8 miles of install script +2. Keep it Small. + Only use what is absolutely needed. +3. Try to stay in the stock containers. + If you need something in a container PR it to [my container repo](https://github.com/parkervcp/Containers) where I can review and pull up to the main repo. + +## Step 1. +#### Be aware of the pterodactyl install process. + +The Pterodactyl install process is fairly simple once you know. + + 1. Spin up install container + This uses a volume mount on /mnt/server for the server files. + This can pull or set up all that is needed to run the server. + It is regularly used to just download the files required. Such as server files and configs. + + 2. Stop install container + + 3. Start a new container with the server files in /home/container + This is where the server is actually run. + Any dependencies installed during the install process are gone. + The container that is started should have everything you need. + +## Step 2. +#### Testing + +Make sure your install process is rock solid as I will be testing eggs before they ever hit my repo. + +I will make sugestions and changes at will. +This is to maintain a clean repo that others can pull and be fully aware of what is being done. + + +## Step 3. +#### Don't be afraid to submit PR's to the egg repo. + +I dont bite. I will work with you on the egg and the required things to run it. \ No newline at end of file diff --git a/README.md b/README.md index 7f9c18d0..bd2cf13c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ With that I am also accepting PR's for new service and also updates to the curre If you are submitting PR's try and keep names and titles the same. +## Please read the HOWTO.md before submitting PRs + + +#### Please read the HOWTO.md as it container important information. + ## Current Game Eggs ### GTA #### FiveM From c58c617b16cdd7f58825fed8e5bf52e8b987d9c7 Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Thu, 22 Feb 2018 12:56:12 -0500 Subject: [PATCH 2/3] Updating ATLBot egg Using stock containers and smaller alpine based. --- discordbots/ATLbot/egg-a-t-l-bot.json | 36 +++++++++++++++++++++++++++ discordbots/ATLbot/egg-atl-bot.json | 26 ------------------- discordbots/Readme | 1 - 3 files changed, 36 insertions(+), 27 deletions(-) create mode 100644 discordbots/ATLbot/egg-a-t-l-bot.json delete mode 100644 discordbots/ATLbot/egg-atl-bot.json delete mode 100644 discordbots/Readme diff --git a/discordbots/ATLbot/egg-a-t-l-bot.json b/discordbots/ATLbot/egg-a-t-l-bot.json new file mode 100644 index 00000000..2199d751 --- /dev/null +++ b/discordbots/ATLbot/egg-a-t-l-bot.json @@ -0,0 +1,36 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v1" + }, + "exported_at": "2018-02-22T12:55:13-05:00", + "name": "ATLBot", + "author": "jfeldt19@gmail.com", + "description": "ATLbot in ptero\r\n\r\nhttps:\/\/github.com\/ATLauncher\/discord-bot\/", + "image": "quay.io\/parkervcp\/pterodactyl-images:nodejs", + "startup": "npm run start", + "config": { + "files": "{\r\n \"config\/config.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"client_token\": \"{{server.build.env.CLIENT_TOKEN}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"I am ready!\",\r\n \"userInteraction\": [\r\n \"Request to use token, but token was unavailable\"\r\n ]\r\n}", + "logs": "{\r\n \"custom\": true,\r\n \"location\": \"logs\/latest.log\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "apk add --no-cache openssl\r\n\r\ncd \/mnt\/server\r\n\r\nwget https:\/\/github.com\/ATLauncher\/discord-bot\/archive\/master.zip\r\n\r\nunzip master.zip\r\n\r\nrm master.zip\r\n\r\nmv discord-bot-master\/* .\/\r\n\r\nmv config\/config.json.example config\/config.json\r\n\r\n\/usr\/local\/bin\/npm install --production\r\n\r\n\/usr\/local\/bin\/npm run build", + "container": "node:8.9-alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "client_token", + "description": "Get a discord token at https:\/\/discordapp.com\/developers\/", + "env_variable": "CLIENT_TOKEN", + "default_value": "get_your_own_token_from_discord_", + "user_viewable": 1, + "user_editable": 1, + "rules": "required|string|max:75" + } + ] +} \ No newline at end of file diff --git a/discordbots/ATLbot/egg-atl-bot.json b/discordbots/ATLbot/egg-atl-bot.json deleted file mode 100644 index 53e7c763..00000000 --- a/discordbots/ATLbot/egg-atl-bot.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", - "meta": { - "version": "PTDL_v1" - }, - "exported_at": "2018-02-20T20:34:53-05:00", - "name": "AtlBot", - "author": "jfeldt19@gmail.com", - "description": "ATLbot in pterodactyl, this is based off https://github.com/ATLauncher/discord-bot made by RyantheAllmighty", - "image": "aaronstar\/npm", - "startup": "npm run start", - "config": { - "files": "{}", - "startup": "{\r\n \"done\": \"I am ready!\"\r\n}", - "logs": "{}", - "stop": "^c" - }, - "scripts": { - "installation": { - "script": "apt-get update\r\napt-get install -y unzip\r\nmkdir \/app\r\ncd \/app\r\nwget https:\/\/github.com\/ATLauncher\/discord-bot\/archive\/master.zip\r\nunzip master.zip\r\nrm \/app\/master.zip\r\ncd \/app\/discord-bot-master\/\r\n\/usr\/local\/bin\/npm install --production\r\n\/usr\/local\/bin\/npm run build\r\ncp -r \/app\/discord-bot-master\/. \/mnt\/server", - "container": "node:8", - "entrypoint": "bash" - } - }, - "variables": [] -} diff --git a/discordbots/Readme b/discordbots/Readme deleted file mode 100644 index a4f942d3..00000000 --- a/discordbots/Readme +++ /dev/null @@ -1 +0,0 @@ -If anyone wants to add other discord bots in here, that would be great From d1b0f40cc30cf93cdc6754b26112416f70bcffbe Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Thu, 22 Feb 2018 12:57:40 -0500 Subject: [PATCH 3/3] Updated readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bd2cf13c..ff4cc943 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ If you are submitting PR's try and keep names and titles the same. #### Please read the HOWTO.md as it container important information. -## Current Game Eggs +## Game Eggs ### GTA #### FiveM The [FiveM](https://fivem.net/) GTA 5 dedicated server @@ -28,4 +28,9 @@ The [tShock](https://tshock.co) modded server ### Minecraft #### Spigot This is a direct fork of the default spigot service with the added benefit of being able to build the spigot jar. -(It's noted that building the jar is intensive and time consuming) \ No newline at end of file +(It's noted that building the jar is intensive and time consuming) + +## Bot Eggs +### Discord +#### ATLBot +The [ATLauncher Bot](https://github.com/ATLauncher/discord-bot/) \ No newline at end of file