From e4e52642d2a0c162c1e32bd8e64255836795f46c Mon Sep 17 00:00:00 2001 From: Dane Everitt Date: Sat, 15 May 2021 12:54:01 -0700 Subject: [PATCH] Add more notes and details for contributing. --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d60c373..c8b930a 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,22 @@ A curated collection of core images that can be used with Pterodactyl's Egg system. Each image is rebuilt periodically to ensure dependencies are always up-to-date. -Images are hosted on both `ghcr.io` and `quay.io` for redundancy. To use any of these images, use -`ghcr.io/pterodactyl/yolks:` or `quay.io/pterodactyl/yolks:`. +Images are hosted on `ghcr.io` and exist under the `games`, `installers`, and `yolks` spaces. The following logic +is used when determining which space an image will live under: -Any images ending with `-install` should only be used as a install image for running an install script, these images -will not work to run the actual server and are only designed to reduce installation time and network usage by -pre-installing common installation dependencies such as `curl` and `wget`. +* `games` — anything within the `games` folder in the repository. These are images built for running a specific game +or type of game. +* `installers` — anything living within the `installers` directory. These images are used by install scripts for different +Eggs within Pterodactyl, not for actually running a game server. These images are only designed to reduce installation time +and network usage by pre-installing common installation dependencies such as `curl` and `wget`. +* `yolks` — these are more generic images that allow different types of games or scripts to run. They're generally just +a specific version of software and allow different Eggs within Pterodactyl to switch out the underlying implementation. An +example of this would be something like Java or Python which are used for running bots, Minecraft servers, etc. All of these images are available for `linux/amd64` and `linux/arm64` versions, unless otherwise specified, to use these images on an arm system, no modification to them or the tag is needed, they should just work. + +### Contributing +When adding a new version to an existing image, such as `java v42`, you'd add it within a child folder of `java`, so +`java/42/Dockerfile` for example. Please also update the correct `.github/workflows` file to ensure that this new version +is tagged correctly.