🥚 Game Server Eggs Documentation

Welcome to the beginner-friendly, comprehensive guide for creating game server eggs! 🎮

This documentation will teach you everything you need to know about making eggs for game server management panels like Pterodactyl. Whether you're 14 or 40, we'll guide you through the process step by step!

🎯 Quick Navigation - Where to Start?

I'm Brand New - Where Do I Start?

👉 Start here: Egg Creation Basics

This teaches you what eggs are, how they work, and helps you create your first simple egg.

I Know the Basics - What's Next?

👉 Next step: Configuration Variables Reference

Learn how to make your eggs customizable with variables that users can adjust.

I Want to Create a Real Egg

👉 Then read: Extending and Creating Eggs

Learn how to extend existing eggs or create completely new ones from scratch with real examples.

I'm Ready for Advanced Features

👉 Master these:

• Wings Variables Reference - Special variables the panel provides
• File Parsers Guide - Automatically manage configuration files
• Wings Variables Extracted from Real Eggs - Real variables from 300+ actual eggs

📚 Complete Documentation Structure

#	Document	Level	What You'll Learn	Time
01	Egg Basics	🐣 Beginner	What are eggs? How do they work? Your first egg	20-30 min
02	Configuration Variables	🛠️ Basic	Variable types, creating customizable settings, validation	20 min
03	Extending Eggs	🔧 Intermediate	Extending existing eggs, creating new ones, real examples	30-40 min
04	Wings Variables	🌐 Advanced	Panel-provided variables, special syntax, scopes	25 min
05	File Parsers	📝 Advanced	JSON, YAML, INI, properties parsers, managing config files	30 min
06	Wings Variables Extracted	🔍 Reference	Real variables from 300+ eggs, statistics, patterns	15 min
07	Egg Creation Checklist	✅ Reference	Complete checklist before releasing your egg	10 min

🚀 Recommended Reading Paths

Path 1: Complete Beginner (Total: 2-3 hours)

1. Egg Basics - Understand fundamentals
2. Configuration Variables - Learn customization
3. Extending Eggs - Create your first real egg
4. Wings Variables Extracted - See real examples

Path 2: Intermediate Developer (Total: 3-4 hours)

1. Egg Basics - Refresh understanding
2. Configuration Variables - Review variables
3. Extending Eggs - Study examples
4. Wings Variables - Learn special variables
5. File Parsers - Master config management
6. Wings Variables Extracted - See real patterns

Path 3: Advanced User (Total: 4-5 hours)

1. Read all documents in order
2. Focus on advanced sections
3. Use Wings Variables Extracted for real examples
4. Use Egg Creation Checklist before release

📖 Documentation Overview

01 - Egg Creation Basics 🥚

Your introduction to eggs. Explains what they are, shows the structure, and helps you create your first simple egg with step-by-step instructions and working examples.

02 - Configuration Variables Reference ⚙️

Learn how to create variables that let users customize your eggs. Covers all variable types, validation, best practices, and troubleshooting.

03 - Extending and Creating Eggs 🔧

Deep dive into creating and extending eggs. Shows real examples from actual eggs, explains file management, and provides complete working code samples.

04 - Wings Variables Reference 🌐

Master the special variables provided by the Wings panel system. Explains {{server.build.default.port}}, {{server.build.env.VAR}}, variable scopes, and more.

05 - File Parsers Guide 📝

Learn how to automatically manage configuration files in different formats (JSON, YAML, INI, properties, plain text). Includes practical examples for each format and real-world use cases.

06 - Wings Variables Extracted from Real Eggs 🔍

Reference guide with real variables extracted from 300+ actual eggs. See what variables are actually used, naming patterns, statistics, and complete working examples.

07 - Egg Creation Checklist ✅

Complete checklist for creating professional, working eggs. Use this as your final review before sharing your egg with the community.

🎯 Documentation by Topic

Understanding Eggs

• What is an egg? → Egg Basics
• Egg structure → Egg Basics
• Why use eggs? → Egg Basics

Creating Variables

• Variable types → Configuration Variables
• Creating variables → Configuration Variables
• Variable validation → Configuration Variables
• Best practices → Configuration Variables

Creating & Extending Eggs

• Understanding structure → Extending Eggs
• Extending existing eggs → Extending Eggs
• Creating from scratch → Extending Eggs
• Real examples → Extending Eggs

Using Wings Variables

• What are they? → Wings Variables
• Common variables → Wings Variables
• Complete reference → Wings Variables
• Real examples → Wings Variables Extracted

Managing Configuration Files

• Why use parsers? → File Parsers
• Parser types → File Parsers
• Choosing parsers → File Parsers
• Real examples → File Parsers

Learning from Real Eggs

• Discord bots → Wings Variables Extracted
• Game servers → Wings Variables Extracted
• Web apps → Wings Variables Extracted
• Databases → Wings Variables Extracted

Before You Share

• Complete checklist → Egg Creation Checklist
• Testing guide → Egg Creation Checklist
• Common mistakes → Egg Creation Checklist

🔍 Quick Reference Sections

Variable Quick Reference

• All variable types - String, number, boolean, select, password
• Wings variables - {{server.build.default.port}}, etc.
• Extracted variables - From real eggs
• Variable naming - Best practices

File Parsers Quick Reference

• JSON parser - For .json files
• YAML parser - For .yml files
• File parser - For plain text
• INI parser - For .ini files
• Properties parser - For Java properties

Egg Examples by Type

• Discord bots - Tokens, prefixes, database configs
• Game servers - Ports, players, game modes
• Web apps - Ports, passwords, API keys
• Databases - Ports, users, passwords

🎓 Learning by Skill Level

🐣 Complete Beginner

You're new to eggs and game servers.

Read:

1. Egg Basics - Full document
2. Configuration Variables - Sections 1-3
3. Try the examples!

Goal: Understand what eggs are and create your first simple one Time: 1-2 hours

🛠️ Intermediate

You understand the basics and want to create real eggs.

Read:

1. Egg Basics - Skim for review
2. Configuration Variables - Full document
3. Extending Eggs - Full document
4. File Parsers - Sections 1-4

Goal: Create customizable eggs that manage configuration files Time: 2-3 hours

🚀 Advanced

You want to master egg creation and use advanced features.

Read:

1. All documents in order
2. Focus on advanced sections
3. Study real examples from Wings Variables Extracted
4. Use Egg Creation Checklist

Goal: Create complex, professional-grade eggs Time: 3-4 hours

🆘 Common Questions & Answers

Q: What are Wings variables? A: Special variables provided by the panel system. See Wings Variables and Wings Variables Extracted.

Q: How do I make my egg customizable? A: Create variables in your egg. See Configuration Variables.

Q: How do I edit config files automatically? A: Use file parsers! See File Parsers.

Q: What's the difference between {{VAR}} and {{server.build.env.VAR}}? A: {{VAR}} is for startup commands, {{server.build.env.VAR}} is for config files. See Wings Variables.

Q: How do I extend an existing egg? A: Copy it and modify it! See Extending Eggs.

Q: What parser should I use for my config file? A: Check File Parsers - Choosing the Right Parser.

Q: Can I see real examples? A: Yes! Check Wings Variables Extracted - it has real variables from 300+ eggs!

Q: What should I check before releasing my egg? A: Use the Egg Creation Checklist - it has everything you need!

📊 Documentation Statistics

• Total pages: 7 comprehensive guides + this landing page
• Total content: 7,000+ lines of detailed documentation
• Real eggs analyzed: 300+
• Real examples included: 50+
• Variables documented: 100+
• Code snippets: 200+
• Diagrams & tables: 40+

✅ What's Covered

✅ What are eggs and why use them? ✅ Egg structure and components ✅ Creating your first egg ✅ Variable types and validation ✅ Extending existing eggs ✅ Creating eggs from scratch ✅ Wings-provided variables ✅ Configuration file management ✅ JSON, YAML, INI, properties, file parsers ✅ Real-world examples from 300+ eggs ✅ Best practices and design patterns ✅ Troubleshooting and debugging ✅ Complete variable reference ✅ Statistics and patterns from real eggs ✅ Pre-release checklist ✅ Testing strategies

🎮 What You Can Make

With eggs, you can create servers for:

• Minecraft (Java & Bedrock)
• Counter-Strike (CS2 & CS:Source)
• ARK: Survival Evolved
• 7 Days to Die
• Valheim
• Rust
• Discord Bots
• Web Applications
• Databases
• And many more!

💡 Key Concepts Made Simple

What is an Egg?

An egg is like a recipe for setting up a game server. It contains:

• ✅ All the files needed
• ✅ Installation instructions
• ✅ Customizable settings
• ✅ Startup commands
• ✅ Configuration file management

Why Use Eggs?

• Fast: Set up servers in minutes, not hours
• Easy: Change settings without editing files
• Reliable: Same result every time
• Shareable: Give your egg to friends
• Professional: Create complex configurations easily

How Do Eggs Work?

1. You create the egg (the recipe)
2. Someone installs it (follows the recipe)
3. The panel runs your scripts (cooks the meal)
4. Players join and have fun! (enjoy the meal)

🎨 Documentation Style

This documentation is designed to be:

• Simple - Explains everything in plain English
• Practical - Focus on what you can actually do
• Complete - Covers every case and scenario
• Accessible - Understandable to 14-year-olds
• Well-linked - Jump between related topics easily
• Example-rich - Real code from actual eggs
• Encouraging - Everyone starts somewhere!

📱 Navigation Tips

• Use Ctrl+F (Cmd+F on Mac) to search within a page
• Click the links to jump between related topics
• Check the table of contents at the top of each page
• Use the "See Also" sections for related guides
• Return to this page to navigate quickly

🚀 Ready to Start?

Choose your path:

• 🐣 Brand new? → Egg Basics
• 🛠️ Know basics? → Configuration Variables
• 🔧 Ready to build? → Extending Eggs
• 🌐 Advanced user? → Wings Variables
• 📝 Need reference? → File Parsers or Wings Variables Extracted
• ✅ Ready to release? → Egg Creation Checklist

💡 Pro Tips

1. Read in order - Each page builds on previous knowledge
2. Try examples - Hands-on practice is the best teacher
3. Start simple - Create a basic egg before advanced features
4. Test often - Test your eggs frequently
5. Use real eggs as reference - Check Wings Variables Extracted
6. Ask questions - No question is too simple!
7. Make mistakes - That's how you learn best
8. Share your knowledge - Help others learn too

📞 Support & Resources

If you get stuck:

1. Search this documentation - Use Ctrl+F to find keywords
2. Check common questions - See the FAQ section above
3. Review real examples - Wings Variables Extracted
4. Try the examples - Extending Eggs has complete working code
5. Use the checklist - Egg Creation Checklist has all steps
6. Read error messages - They usually tell you exactly what's wrong!

🎉 Your Success Path

By the time you finish this documentation, you'll be able to:

✅ Create eggs from scratch ✅ Extend existing eggs ✅ Make customizable eggs with variables ✅ Manage configuration files automatically ✅ Use Wings-provided variables effectively ✅ Follow industry best practices ✅ Create professional-grade eggs ✅ Test thoroughly before release ✅ Share your creations with the community

🌟 Learning Journey

START HERE ↓
   ↓
[Egg Basics] Learn what eggs are
   ↓
[Try Examples] Follow the guide
   ↓
[Configuration Variables] Make eggs customizable
   ↓
[Extending Eggs] Modify and create eggs
   ↓
[Wings Variables] Use panel features
   ↓
[File Parsers] Manage config files
   ↓
[Real Examples] See 300+ actual eggs
   ↓
[Creation Checklist] Final review
   ↓
CREATE YOUR OWN EGG! 🎉
   ↓
SHARE WITH COMMUNITY 🚀

📚 About This Documentation

This comprehensive guide was created by analyzing 300+ real eggs in the repository to extract:

• Real variable usage patterns
• Common configurations
• Best practices in the wild
• Working examples you can learn from
• Complete Wings variable reference
• All file parser types with examples

Everything here is based on actual, working eggs - not just theory!

🤝 Contributing

Found an issue or want to improve the docs?

1. Found a mistake? Let us know!
2. Have a better explanation? Suggest it!
3. Want to add examples? Share them!
4. Good at explaining? Help write more guides!

💪 Remember

Every expert was once a beginner. You've got this! The fact that you're reading this means you're already on your way to becoming an egg expert.

Start simple, test often, and gradually add complexity. Before you know it, you'll be creating amazing eggs that impress everyone!

---

🎯 Start Your Journey Now!

Jump to Egg Creation Basics →

Happy egg creating! 🥚🎮😊