Spell Development Guide
Complete guide to creating custom spells for FeatherPanel
FeatherPanel Spell System
FeatherPanel uses a "spell" system (similar to Pterodactyl's "eggs") to define how different server types are configured and managed. Spells allow you to create custom server configurations, Docker images, and management scripts for any game or application.
What are Spells?
Spells in FeatherPanel are configuration templates that define:
- Server startup commands and parameters
- Docker container images and configurations
- File management and configuration parsing
- Environment variables and settings
- Installation scripts and dependencies
- Process management and monitoring
Quick Start
- Access Spell Manager in FeatherPanel admin interface
- Create a new spell or copy from existing ones
- Configure Docker image and startup commands
- Set up file management and configuration parsing
- Test your spell with a sample server
- Deploy and distribute your spell
Documentation Structure
- Spell Architecture - How spells work and are structured
- Creating Custom Spells - Step-by-step spell creation guide
- Docker Images - Creating custom Docker images for spells
- Configuration Management - File parsing and configuration
- Spell Variables - Environment variables and settings
- Process Management - Server lifecycle and monitoring
- Spell Examples - Complete spell examples and templates
What Spells Can Do
FeatherPanel spells can:
- Define server types (Minecraft, CS:GO, Discord bots, etc.)
- Manage Docker containers with custom images
- Parse configuration files (JSON, YAML, INI, Properties, XML)
- Handle environment variables and dynamic settings
- Control server lifecycle (start, stop, restart, install)
- Manage file permissions and directory structure
- Provide installation scripts for dependencies
- Monitor server health and resource usage
Spell Types
- Game Servers - Minecraft, CS:GO, Rust, etc.
- Application Servers - Web servers, databases, APIs
- Bot Services - Discord bots, IRC bots, etc.
- Development Environments - IDEs, build tools, etc.
- Custom Applications - Any containerized application
Getting Started
The easiest way to create a spell is using the Spell Manager in the FeatherPanel admin interface:
- Navigate to Admin → Spells
- Click "Create New Spell"
- Configure your spell settings
- Set up Docker image and commands
- Configure file management and variables
- Test your spell with a sample server
For advanced customization, see the Creating Custom Spells guide.
Next Steps
- Read about Spell Architecture to understand how spells work
- Learn about Creating Custom Spells for step-by-step instructions
- Explore Docker Images for container customization
- Check out Spell Examples for complete working examples
Important Notes
⚠️ Warning: You should not edit existing spells that ship with FeatherPanel. Each upgrade can make changes to these, and you'll lose any modifications you've made.
✅ Best Practice: Always create new spells or copy existing ones as templates for your custom configurations.