sof3/pharynx

0.3.8 2024-09-28 19:42 UTC

Requires

• php: >=8.0
• composer/composer: ^2.5.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• phpstan/phpstan: ^1.7
• phpunit/phpunit: ^9.5.16 <9.5.17

Apache-2.0

• SOFe

README

A tool to recompile PHP sources into a phar in PSR-0

USAGE
  -v           : Enable verbose output.
  -i PATH      : Equivalent to `-f plugin.yml:PATH/plugin.yml -f PATH/resources -s PATH/src`.
  -f NAME:PATH : Copy the file or directory at PATH to output/NAME.
                 `:` is not considered as a separator if immediately followed by a backslash.
                 Can be passed multiple times.
  -s PATH      : Use the directory at PATH as a source root.
                 Can be passed multiple times
  -r NAME      : The path of the source root in the output.
                 Default `src`.
  -o PATH      : Store the output in directory form at PATH.
  -p[=PATH]    : Pack the output in phar form at PATH.
                 If no value is given, uses the path in `-o` followed by `.phar`.
                 If neither -o nor -p are passed, or only `-p` is passed but without values,
                 `-p output.phar` is assumed.
  -a ANTIGEN   : The virion antigens to shade.
                 Can be passed multiple times
  -c[=PATH]    : Infer source paths and antigens from composer.
                 Assumes that `composer install` was already run.
                 If a value is not provided, uses the same path as `-i`.
                 Otherwise, PATH should be the path to the directory containing composer.json.

EXAMPLES
  Package a plugin phar:
  $ php pharynx.phar -i path/to/your/plugin -p my-plugin.phar

  Package a plugin phar with composer virion dependencies:
  $ php pharynx.phar -i path/to/your/plugin -c -p my-plugin.phar

  Bundle output to a directory without building phar
  $ php pharynx.phar -i path/to/your/plugin -o output

  Package a plugin phar to output.phar, along with generated files in a gen directory:
  $ php pharynx.phar -i path/to/your/plugin -s path/to/gen

Use with PocketMine plugins

Download start.cmd/start.sh, pharynx.phar and bootstrap-plugin-dev.php from releases and copy them to your PocketMine install directory. Replace PocketMine's start.cmd/start.sh with the one you downloaded. Edit start.sh/start.cmd and change "plugin_source/MyPlugin" to the plugin(s) to build with pharynx (only start.sh supports multiple plugins). Then just start the server as usual!