mirror of
https://github.com/parkervcp/eggs.git
synced 2024-11-11 19:57:22 +08:00
a8230eb7f9
added blank lines as needed removed trailing spaces added code block for install process removed punctuation from headers
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
# 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, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where I can review and pull it up to the main repo. In addition, there is a larger quantity of [images here](https://github.com/parkervcp/images) for you to use that have not been migrated to Yolks yet.
|
|
|
|
4. Don't be afraid to submit PR's to the egg repo.
|
|
I don't bite. I will work with you on the egg and the required things to run it.
|
|
|
|
## Step 1
|
|
|
|
### Be aware of the pterodactyl install process
|
|
|
|
The Pterodactyl install process is fairly simple once you know.
|
|
|
|
```md
|
|
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 suggestions 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
|
|
|
|
### Make a branch and do your work in there
|
|
|
|
I have been getting messy PR's due to people always PRing from their master branch. Please make a seperate branch and PR from there.
|