By continuing to use this site, you agree to the Terms of Service of this website, including usage of cookies.

OK, Don't show this again

Development tools plugin for PocketMine-MP
version 1.13.0
Approved
Direct Download How to install?
Switch version
2335 Downloads / 10428 Total
10 Reviews
Plugin Description §

Usage

Loading folder plugins

DevTools loads plugins in folder format in the plugins directory.

For example, if you have these structure:

PocketMine-MP.phar
plugins/DevTools.phar
plugins/MyPlugin/plugin.yml
plugins/MyPlugin/src/My/Plugin/Code.php

DevTools will load MyPlugin like a normal plugin when the server starts.

Creating plugin phars

After a folder plugin is loaded with DevTools, DevTools can turn it into a phar file, with the command:

/makeplugin <plugin name>

where <plugin name> is the plugin name in its plugin.yml (not the folder name). The phar will be created in plugins/DevTools.

Extracting plugin phars

Plugins in phar format can be extracted using the extractplugin command:

/extractplugin <plugin name>

where <plugin name> is the plugin name (not the phar file name). The plugin will be extracted to a subfolder in plugins/DevTools.

Creating server phar

If the server runs from source (not from PocketMine-MP.phar), the command /makeserver will create the phar in the plugins/DevTools folder. Move it next to the start.cmd/start.sh and rename it to PocketMine-MP.phar, and the server will run from the PocketMine-MP.phar instead of running from source.

Checking permissions

DevTools can check the details of a permission and whether a player has the permission.

/checkperm <node> [player name]
  • <node> is the name of the permission node to check.
  • [player name] is the name of the player to test permission for, or yourself (including console) if not provided.

Generating plugin

DevTools can initialize a basic plugin.

/genplugin <plugin name> <author name>

<plugin name> and <author name> must only contain alphabets, numbers and underscores.

A skeleton plugin structure will be generated in the plugins folder, so when you restart the server, the generated plugin will be loaded by DevTools.

Using ConsoleScript

You can use ConsoleScript to build a DevTools phar from source code. Contrary to popular assumption, this is very simple. Assuming you have a php executable in your PATH variable, cd into the DevTools directory (the folder where plugin.yml is located) and simply run the following:

php -dphar.readonly=0 path/to/ConsoleScript.php --make path/to/DevTools --relative path/to/DevTools --out path/to/put/devtools/phar/in/DevTools.phar

You can then load the phar onto a PocketMine-MP server. A correctly-built DevTools phar can also be executed directly from the command line as if it was the ConsoleScript.

Build phars from the command line

You can also use the ConsoleScript or a DevTools phar from the command-line to build PocketMine-MP phars or plugin phars.

The script currently takes the following arguments:

  • --make: The path to the files you want to bundle into a phar
  • --relative: (Optional) Relative path to use when building the phar. This usually isn't necessary for plugins. Used to build PocketMine-MP phars with the src directory without including the files in the repository root.
  • --entry: (Optional) PHP file within the phar to execute when running the phar from the command-line. Usually not needed for plugins, but required for a PocketMine-MP phar. Used to generate phar stubs.
  • --stub: (Optional) PHP file to use as a custom phar stub. The stub will be executed when the phar is run from the command line.
  • --out: Path and filename of the output phar file.

Example command line for building a plugin:

php -dphar.readonly=0 path/to/ConsoleScript.php --make path/to/your/plugin/sourcecode --out path/to/put/your/plugin.phar

Example command line for building PocketMine

php -dphar.readonly=0 path/to/ConsoleScript.php --make path/to/PocketMine-MP/src --relative path/to/PocketMine-MP --entry src/pocketmine/PocketMine.php --out path/to/put/your/PocketMine-MP.phar
What's new §
  • Now uses strict types and typehints throughout.
  • Updated for PocketMine-MP PluginLoader rewrite.
  • Reduced duplication of code between DevTools main and ConsoleScript (now more dependent on ConsoleScript).
  • DevTools 1.12.10, ALPHA12 compatibility
  • Fixed typo in FilesystemIterator
  • Fixed phar building issues on Windows paths (backslashes) (#29)
  • Fixed building with symlinked files with ConsoleScript (#25)
  • Added FolderPluginLoader->canLoadPlugin() to comply with API changes in PocketMine-MP
  • Fixed EOF newlines

support for API version 3.0.0-ALPHA11 release

  • Fixed entry path resolution when relative paths are used in --entry
  • Fixed undefined variable in generated plugin phar stubs
  • DevTools will no longer crash when folder plugins have invalid data directories or have no main class to be found
  • Bump for API 3.0.0-ALPHA10
  • Added /makeplugin * to allow building all folder plugins on the server (#19)
  • Fixed /genplugin crash and cleaned up
  • Updated for ALPHA9
  • Fixed RCE vulnerability in /genplugin (Missing return after regex check on name and author - thanks GH Freax13)
  • /genplugin now automatically sanitizes plugin names and authors which have illegal characters in them
  • bump for ALPHA8
  • Use Phar::buildFromDirectory(), significantly faster for large builds (such as server!), significantly improved performance of /makeserver, /makeplugin and ConsoleScript
  • /makeserver can now only be used on servers running from source code
  • /makeserver and /makeplugin no longer produce spammy output for adding files

(Revision 2)

  • Fixed a stupid Friday-evening bug in the previous revision
  • ALPHA7 support, removed support for older versions
  • Fix bad command permission in generated plugins
Initial version
  • Support for API 3.0.0-ALPHA5, backwards-compatible

Minor bug fixes, please see GitHub Releases for changelogs.


Trazader
using v1.13.0
26 Jul 18
Please update to 4.0.0 :)
MangoTheDev
using v1.13.0
30 Jun 18
useful.
Palente
using v1.13.0
22 Jun 18
jackthehack21
using v1.12.10
10 Jun 18
SIVANNKHOld
using v1.12.10
07 Jun 18
Hello! Did it has the tutorials ?
Thunder33345
Staff
using v1.12.10
20 May 18
MCPE-PC
using v1.12.10
20 Apr 18
jasonwynn10
Staff
using v1.12.9
30 Mar 18
The most useful developer plugin of all time.
llronaldoll
using v1.12.8
05 Jan 18
nice work
jacobb235q
using v1.12.7
22 Nov 17
Good

Reply to review by :

Supported API versions
3.0.0
->
3.2.5
Producers §
  • Collaborators:
    • @dktapps
    • @shoghicp
  • Contributors:
    • @Awzaw
    • @Freax13
    • @Intyre
    • @PEMapModder
    • @SOF3
License §
Categories:
Developer Tools
Keywords
Permissions
Other files
Permissions
Commands

You can leave one review per plugin release, and delete or update your review at any time

Loading...