Skip to content

EndstoneMC/pterodactyl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Endstone Pterodactyl Egg

A Pterodactyl / Pelican egg for running Endstone servers. Endstone is a plugin framework for Minecraft Bedrock Dedicated Server, similar to Bukkit/Spigot/Paper for Java Edition.

Quick Start

  1. Download egg-endstone.json from this repo
  2. In your panel, go to Admin > Nests > Import Egg and upload the file
  3. Create a new server using the Endstone egg
  4. Start the server

The egg automatically runs the latest version of Endstone on first start.

Configuration

Endstone Version

The ENDSTONE_VERSION variable controls which version to run. Leave it blank to always run the latest release, or enter a version number to pin a specific release.

Value Effect
(blank) Always run the latest release (default)
0.11.5 Pin a specific version

Available versions are listed on PyPI.

Local Wheel File

The SERVER_WHLFILE variable installs Endstone from a local .whl file instead of PyPI — useful for running a development build or a version not published to PyPI. Leave it blank to install from PyPI using ENDSTONE_VERSION; when set, it takes precedence over the version.

Value Effect
(blank) Install from PyPI (default)
endstone-0.12.0-py3-none-any.whl Install a .whl uploaded to the server
https://example.com/endstone-0.12.0-py3-none-any.whl Install from a direct URL

Upload the .whl to the server's root folder via the panel's file manager or SFTP, then set this variable to its filename.

Docker Image

The egg supports Python 3.11 through 3.14. Python 3.12 is recommended for most users. Choose a different image only if a plugin requires a specific Python version.

Server Properties

A default server.properties is created on first install. You can edit it through the panel's file manager or via SFTP. Common settings:

Property Default Description
server-port 19132 IPv4 port (managed by the panel)
server-name Endstone Server Server name shown in the server list
gamemode survival Default game mode: survival, creative, adventure
max-players 10 Maximum player count
difficulty easy World difficulty
online-mode true Require Xbox Live authentication

Installing Plugins

  1. Build or download a plugin .whl file
  2. Upload it to the plugins/ folder via the panel's file manager or SFTP
  3. Restart the server

Find plugins on PyPI or build your own using the Python or C++ plugin templates.

Updating Endstone

If ENDSTONE_VERSION is left blank (the default), simply restarting the server will run the latest version. If you've pinned a version, update the variable and restart.

Documentation

License

MIT License

About

Pterodactyl / Pelican egg for running Endstone Minecraft Bedrock servers

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

10 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors

Languages