Before Updating
Pre-update Checklist
Check release notes
- Visit GitHub Releases
- Read changelog for breaking changes
- Note API version changes
- Review migration guides
Verify plugin compatibility
- Check if your plugins support the new version
- Visit Poggit for plugin updates
- Contact plugin developers if unsure
Schedule downtime
- Notify players in advance
- Choose low-traffic time
- Plan for potential rollback time
Update Methods
Method 1: Automatic Update (Recommended)
PocketMine-MP can update itself automatically:- Using Update Command
- Automatic Notification
Automatic updates only work for point releases (e.g., 5.0.0 → 5.0.1). Major version updates require manual installation.
Method 2: Manual Update
- Linux/macOS
- Windows
- Using Installation Script
Method 3: Docker Update
If using the official Docker image:After Updating
Monitor for issues
- Watch console for errors
- Check server.log
- Monitor performance (TPS, memory)
- Listen to player feedback
Understanding Release Channels
PocketMine-MP uses different release channels:Stable
Recommended for production
- Thoroughly tested
- No known major bugs
- Suitable for public servers
- Updated less frequently
Beta
For testing upcoming features
- New features
- Less tested
- May have bugs
- For adventurous admins
Alpha
Early testing versions
- Very new features
- Likely has bugs
- Breaking changes possible
- For developers/testers
Development
Bleeding edge
- Latest commits
- Unstable
- Can break anytime
- For development only
Configure Release Channel
pocketmine.yml
Major Version Updates
Major version updates (e.g., 4.x → 5.x) often include:- Breaking API changes
- Plugin incompatibility
- Configuration changes
- World format updates
Major Update Process
Research breaking changes
- Read migration guides
- Review release notes thoroughly
- Check GitHub discussions
Update all plugins first
- Get versions compatible with new API
- Remove plugins without updates
- Find alternatives if needed
Plan migration day
- Schedule maintenance window
- Notify players well in advance
- Prepare rollback plan
Major updates are released infrequently. Most updates are minor versions with backward compatibility.
Rollback Procedure
If the update causes critical issues:Rollback is why backups are critical. Always backup before updating.
Update Best Practices
Keep regular update schedule
Keep regular update schedule
- Check for updates weekly
- Subscribe to GitHub release notifications
- Join Discord for announcements
- Read changelogs regularly
Don't skip versions
Don't skip versions
- Update sequentially through versions
- Don’t jump multiple major versions
- Read all changelogs between versions
Maintain multiple backups
Maintain multiple backups
- Keep multiple backup generations
- Store backups off-server
- Test backup restoration occasionally
Document your configuration
Document your configuration
- Keep notes on custom settings
- Document plugin configurations
- Track what you’ve changed from defaults
Test updates in development first
Test updates in development first
- Clone production to test server
- Update test server first
- Verify everything works before production update
Automated Update Script
Example update script for Linux servers:update.sh
Getting Update Notifications
- GitHub
- Discord
- RSS/Atom Feed
- Go to PocketMine-MP repository
- Click “Watch” → “Custom” → “Releases”
- Receive email notifications for new releases
Frequently Asked Questions
Do I need to update plugins when updating server?
Do I need to update plugins when updating server?
Usually yes, especially for major version updates. Check plugin compatibility:
- Visit plugin pages on Poggit
- Read plugin update notes
- Test plugins after server update
- Replace incompatible plugins
Will updating reset my configuration?
Will updating reset my configuration?
No.
server.properties and pocketmine.yml are preserved during updates. However:- New options may be added with defaults
- Deprecated options may be removed
- Some values may change behavior
- Always review changelogs
Can I downgrade if needed?
Can I downgrade if needed?
Yes, with caveats:
- Restore old PocketMine-MP.phar
- May need to restore world backups
- Some new features may break
- Data created in new version may not work
- Always use pre-update backups
How often should I update?
How often should I update?
For stable channel:
- Update for security patches immediately
- Update for bug fixes when convenient
- Update for new features as desired
- Generally, update monthly or when notified
What if my hosting doesn't support updates?
What if my hosting doesn't support updates?
Some options:
- Contact hosting support for assistance
- Request they enable auto-updates
- Use hosting control panel update feature
- Consider switching to better hosting
- Migrate to VPS for full control
Next Steps
Configuration
Optimize settings after updating
Troubleshooting
Resolve issues after updates