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.14.0
Approved
Direct Download How to install?
Switch version
11054 Downloads / 40673 Total
34 Reviews
Plugin Description §

Development Tools for PocketMine-MP

DevTools is a collection of utilities used for developing PocketMine-MP plugins.

Features

  • Generate skeleton files to bootstrap a new plugin
  • Build plugin phars from source code
  • Load plugins directly from source code (folder plugins), useful for rapid development
  • Check player permissions using commands

Commands

  • /genplugin : Generates skeleton files for a new plugin
  • /makeplugin <pluginName>: Creates a Phar plugin archive for its distribution
  • /makeplugin *: Creates Phar plugin archives for all loaded plugins
  • /checkperm <node> [playerName]: Checks a permission node

Using 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 plugin 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:

argument required description
--make yes The path to the files you want to bundle into a phar
--relative no 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 no 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 no (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 yes 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
What's new §
  • Removed /makeserver. This command is now redundant with the introduction of a specialized build script in PocketMine-MP itself.
  • Cleaned up README: now provides more useful information.

/genplugin now generates a true skeleton plugin without extra useless junk.

Fixed --make paths matching prefix instead of full folder name

  • Don't try to build phars if phar.readonly is set, closes #39
  • Remove deprecated method usage, require PM 3.4.0+
  • Fixed crash in /makeplugin when the source files for a folder plugin were deleted from disk at runtime

This release is compatible with PocketMine-MP 3.0.0 and all later minor/patch releases.

  • Fixed file (non directory) paths not working as --make arguments for ConsoleScript
  • Cleaned up genplugin command - now it doesn't write useless files to disk
  • Fixed ConsoleScript ignoring compression type
  • Fixed some duplicated directory separators
  • Fixed projects not being buildable if they were contained in a hidden directory or otherwise excluded build path.
  • 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.


radledazzler13
using v1.14.0
04 Jul 20
I’m trying to use this for making my own plugin using /genplugin but when I finish the plugin do I have to make it a .phar because it doesn’t work. If I don’t is it just because the script is wrong?
mmm545
using v1.14.0
14 Jun 20
Every plugin developer should have this plugin
HyperFlareMC
using v1.14.0
19 May 20
UnEnanoMas
using v1.14.0
07 Apr 20
Just send me a error Server thread/CRITICAL ParseError: "syntax error, unexpected 'private' (T_PRIVATE)" (EXCEPTION) in "plugins/Test/src/Test/Main" at line 29 07.04 08:22:54 [Server] Server thread/DEBUG #0 vendor/pocketmine/classloader/src/BaseClassLoader
Invy55
using v1.14.0
06 Mar 20
BobbyTowers
using v1.14.0
02 Mar 20
If you're not using this, then my friend you shouldn't be running PM server.
Itzdvbravo
using v1.14.0
06 Feb 20
how do i use it?
IceCruelStuff
using v1.14.0
06 Feb 20
Nice plugin!
GamakCZ
using v1.13.5
06 Apr 20
Cannot use it for building server
ItzLighting9332
using v1.13.5
10 Jan 20
Gg
padreon
using v1.13.5
01 Dec 19
AndreasHGK
using v1.13.5
28 Oct 19
thank you for improving /genplugin
RetchroVinox
using v1.13.4
30 Sep 19
Minecraftfan714
using v1.13.4
08 Sep 19
very useful :D
Seyz123
using v1.13.4
28 Aug 19
UnknowG
using v1.13.4
22 Jun 19
<3
JustJ0rd4n
using v1.13.3
01 Jun 19
The best
DarksidexYT
using v1.13.3
24 May 19
AlexPads
using v1.13.3
01 May 19
LITERALLY THE BEST
CryptoKey98
using v1.13.3
08 Mar 19
Can't count how many times this plugin has been useful for me.
Zedstar16
using v1.13.3
07 Feb 19
The most essential plugin for Development. So useful
superbobby2000
using v1.13.0
27 Feb 19
JackMD
using v1.13.0
02 Dec 18
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
JaxkDev
Staff
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
xXKHaLeD098Xx
using v1.12.1
18 Jun 20

Reply to review by :

Supported API versions
3.11.3
->
3.14.0
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...