BetterAltayInstallation
Create an empty folder for your server. Download the release PHAR, the matching PHP distribution and your platform’s launcher from the downloads page. Preserve the archive layout when extracting PHP.
Put the PHAR and launcher at the top level of that folder, then start the launcher. Complete any first-run prompts and wait for the startup process to finish.
# Linux: run from the server folder
chmod +x start.sh
./start.shWindows: run start.cmd. Do not rename the server package unless you also adjust the launcher.
Configure your server
After the first launch, stop the server before editing generated configuration. Keep a backup of your original files.
| File | Purpose |
|---|---|
| server.properties | Server name, networking and basic gameplay settings. |
| pocketmine.yml | PocketMine-related server settings. |
| altay.yml / betteraltay.yml | Fork-specific options, when generated by your build. |
Use the comments and defaults supplied with your exact release. Restart after saving changes.
Connect to your world
Use a Minecraft: Bedrock client version supported by your installed release. Add a server using the host’s LAN address and the port shown in its configuration or startup log.
For players outside your network, allow the configured UDP port through the host firewall and configure your router or hosting provider as needed. A LAN address is only reachable locally.
Everyday commands
help
list
plugins
stopEnter commands in the server console without a slash. Use help to inspect the commands available in your build and its installed plugins. Use stop for a clean shutdown before backups or updates.
Install plugins
- Find a release explicitly supporting the server’s plugin API.
- Read the project’s dependencies and installation instructions.
- Stop the server and copy the plugin PHAR into
plugins/. - Restart and read the log for loading errors.
- Edit generated plugin settings as documented by its author.
Modern PocketMine API 4 or 5 releases are not automatically compatible with API 3. Do not simply change the declared API version to suppress an incompatibility error. Developer libraries may need to be bundled into a plugin instead of installed directly.
Updates & backups
Stop the server and make a separate copy of the entire server directory, including worlds, plugins and configuration. Read the target release notes before replacing the PHAR or runtime.
Test the new release against a copy first. Keep the old runtime and server package with your backup so rollback remains possible. Never open your only world copy in an experimental build.
Client protocol support does not guarantee that every newer block, item or world storage format is supported. Check world compatibility separately before migrating.
Troubleshooting
PHP binary not found
Confirm the archive is extracted, not just downloaded. Check the executable path expected by your launcher and avoid accidentally creating an extra nested folder.
Plugin failed to load
Read the first error in the startup log. Check its API declaration, dependencies and supported PHP version. Test the plugin on a separate server with the same build.
Players cannot connect
Verify the client version, host address, configured port and UDP firewall rules. Try a LAN connection first to separate server problems from external routing problems.
Worlds show missing or update blocks
Stop testing on the original world. Restore a copy and check whether your build supports the world format and its block types. A newer client connection alone does not establish world compatibility.
Reference: upstream repository · Always check instructions supplied with your selected release.