Skip to main content

🥚 Creating an Egg on Pterodactyl

Eggs are server templates that define how Pterodactyl installs and manages a game or application.
Each Egg belongs to a Nest and contains information such as:

  • The Docker image to use
  • Configuration variables (e.g., game version, bot token, motd, etc.)
  • Installation and launch scripts

1. Access Egg creation​

  1. Log in to your admin panel (https://votre_panel.fr/admin).
  2. In the side menu, click Nests.
  3. Select the Nest in which you want to create the Egg.
  4. Click Create New Egg.

2. Fill in the general information​

Name​

  • Name of the Egg (example: PaperMC, Bot Discord Node.js).

Description​

  • Short description of what the Egg does.

Docker Image​

  • Docker image used to run the server.
  • Example: ghcr.io/pterodactyl/yolks:java_17 for a modern Minecraft server.
Important

Only use official or trusted Docker images to avoid any security risks.

3. Egg Configuration​

Startup Command​

  • Command used to start the server.
  • Example for a Minecraft server:
  java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar server.jar

Variables​

  • Allow you to customize the Egg without directly modifying the files.
  • Examples:
    • VERSION → game version
    • SERVER_JARFILE → .jar file used
    • TOKEN → bot API key
Tip

Use variables to make your Eggs flexible and reusable by your users.

4. Installation script​

Define the script that will be executed when the server is first installed.
Example for downloading PaperMC:

#!/bin/bash
curl -o server.jar https://api.papermc.io/v2/projects/paper/versions/{{VERSION}}/builds/{{BUILD}}/downloads/paper-{{VERSION}}-{{BUILD}}.jar

5. Finalize creation​

Click Create Egg to save.

note

Your Egg is now available in the chosen Nest and can be used when creating servers.

✅ Conclusion​

You now know how to create a custom Egg for Pterodactyl.
This is an essential step in offering new games or applications to your users.