Building from source

You need a bash shell (git bash works on Windows), git, PHP 8.2 or newer, and composer, all reachable from your shell.

Clone and install

git clone https://github.com/altayofficial/Altay.git
cd Altay
composer install

If you use one of the project's custom PHP binaries, call composer through it:

path/to/your/php path/to/composer.phar install

Build the phar

composer make-server

Drops Altay.phar into the current directory. --out changes the filename.

Or run straight from source

php src/PocketMine.php

Faster to iterate on than rebuilding a phar for every change.

Release builds

composer install --no-dev --classmap-authoritative
composer make-server

Smaller phar, faster autoloading, no development dependencies.

Switching branches

git checkout <branch>
composer install

Re-run composer install after any checkout. Branches move their dependency versions, and a stale vendor/ produces errors that look like server bugs but are not.

Contributing

Read CONTRIBUTING.md before opening a pull request. If you are looking for somewhere to start, the easy task issues are scoped for exactly that.