Developer Reference: More specifications

pmmp / doc.pmmp.io

Documentation for PocketMine-MP

https://doc.pmmp.io

13 stars 48 forks source link

Developer Reference: More specifications #24

Open dktapps opened 5 years ago

dktapps commented 5 years ago

[ ] Setting up an IDE for development (PhpStorm)
[ ] Creating your first plugin (with examples)
[x] Events spec (needs more work)
[ ] Scheduler
[ ] Commands
[x] plugin.yml (needs more work)
[ ] Permissions
[x] API versioning
[ ] How to reliably identify players (document name, UUID, XUID)
[x] Anatomy of an Inventory Transaction
and more...

ghost commented 3 years ago

Dylan, for commands do you want everything regarding commands, or just how to register your own command?

dktapps commented 3 years ago

permissions
different types of command senders (player, console, rcon, ...)
what aliases are and how they are used
fallback prefixes
what CommandExecutor is used for
parsing arguments (and rejecting invalid arguments, e.g. by using InvalidCommandSyntaxException)

etc etc

SOF3 commented 3 years ago

@Dapro718 In case you aren't aware, the goal of this issue is not just a tutorial/documentation, but to precisely define some behaviour that were previously unclear. For example, is it valid (when?) to implement CommandSender for other classes from plugins? How exactly is command name/alias clash handled? What are the exact rules for argument grouping (not just spaces)?