From d8ba0d795f93c6e879a2858e66f5f2926db01311 Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Fri, 16 Feb 2018 22:05:28 -0500 Subject: [PATCH] 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