From 6d4a0211d50a9a094c57688dc6f2da47f745cf2b Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 26 Feb 2021 21:18:42 +0200 Subject: [PATCH] Add default egg variable list (#333) * Add default variable list * Resolve reviews --- community/config/eggs/creating_a_custom_egg.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/community/config/eggs/creating_a_custom_egg.md b/community/config/eggs/creating_a_custom_egg.md index 39df5ad1..34f74fcb 100644 --- a/community/config/eggs/creating_a_custom_egg.md +++ b/community/config/eggs/creating_a_custom_egg.md @@ -201,3 +201,18 @@ regex as any letters or numbers (`\w\d`) including underscore (`_`), periods (`. They will then be visible when managing the startup for a server in both the Admin CP and on the Front-End. ![](../../../.vuepress/public/community/config/eggs/Pterodactyl_Create_New_Egg_Startup.png) + +## List of default variables + +The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. + +| Variable | Description | Example | +|----------|-------------|---------| +| TZ | Time Zone | `Etc/UTC` | +| STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` | +| SERVER_MEMORY | Memory available for the server in MB | `512` | +| SERVER_IP | Default ip of the server | `127.0.0.1` | +| SERVER_PORT | Primary Server Port | `27015` | +| P_SERVER_LOCATION | Location of the server | `Example City` | +| P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` | +| P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` |