galaxygames/ovommand

a normal framework virion designed to parse command data for PocketMine - MP

dev-main 2025-05-07 02:20 UTC

Requires

• php: ^8.2
• muqsit/simple-packet-handler: ^0.1.5

Requires (Dev)

• phpstan/phpstan: ^2.0
• pocketmine/pocketmine-mp: ^5.27.1

GPL-3.0

README

a feature-rich virion framework to handle commands for PocketMine-MP
📔Docs⠀⠀🔌Demo plugin

📖 Introduction

Ovommand is a command parsing and handling framework for PocketMine-MP. It made it easy for defining, registering, and executing commands with complex parameter structures, validation, and hierarchical organization.

Important

Please note that this project is still at a very early stage and has not yet been released officially, and interfaces may be added or removed without notice. Please do not use Ovommand in a production!

^{This project is under construction....}

Features

1. • Custom command with rich customizability
2. • Custom subcommand/parameters with command enum supports
3. • Parser for complex parameters with syntax checker
   • • Position parameter (~~ ~, 12 -31 ~123, etc) - Done?
   • • Target parameter (@a, @s, etc...) - Currently unstable
   • • Float, Int, Text,... parameter
   • • Json parameter
4. • Default enums support (player list, gamemode, boolean, etc)
5. • Visible/Hidden aliases for subcommands.
6. • Constraints for commands
7. • Auto-generated usage for commands/subcommands
8. • Command namespace (from vanilla addon: /plugin1:test)
9. • Duplicate command name handle (adding counter to the command name)
10. • Attribute supports (temp abandoned)
11. • ?

Requirement

• PHP 8.2 or higher
• PMMP 5.27.0 or higher
• simple-packet-handler 0.1.5 or higher

Getting Started

Contributing

Yes, please...

Note

A. Namespace system

1. If plugin A has namespace: ns set in plugin.yml then
   a) plugin A has force namespace

Issues:

1. • $returnRaw in BaseResult is confusing and useless?
2. • isBlockPos current do nothing in CoordinateResult
3. • Allow users to decide how the subcommand aliases are handled (multiple overloads vs packed enum)
4. • Command namespace system (as vanilla addon) and duplicate command name.

Show useless dumps

Enums system:

	Soft Enum	Hard Enum
Can value be read by owner?	YES	YES
Can value be read by other? (Public)	YES	YES
Can value be read by other? (Private)	NO	NO
Can value be written by owner? (Before server starts)	YES	YES
Can value be written by others? (Private)	NO	NO
Can value be written by others? (Before server starts, not Protected)	YES	YES
Can value be written by owner? (After server starts)	YES	NO
Can value be written by others? (After server starts, not Protected)	YES	NO
Can value be written by others? (Before server starts, Protected)	NO	NO
Can value be written by others? (After server starts, Protected)	NO	NO
Can alias be written by owner? (Before server starts)	YES	YES
Can alias be written by owner? (After server starts)	YES	NO
Can alias be written by others? (Before server starts, not Protected)	YES	YES
Can alias be written by others? (Before server starts, Protected)	NO	NO
Can alias be written by others? (After server starts, not Protected)	YES	NO
Can alias be written by others? (After server starts, Protected)	NO	NO

TODO:

• make reasonable enum that handle it value correctly (string -> value)
• custom enum, parameters, enum-based parameters
• feature rich
• usage messages
• result system (parser), not that good tho :l
• attribute supports (temp abandoned)
• SubCommand doesn't require perms if wanted
• make syntax parser based on its string pos, not the string itself for the accuracy in catching broken syntax spoiled
• fix a bug where the parser cannot check the correct span leading to this to be valid: /tp ~~~ a, where a is not valid but the parser cannot know that because it don't expect that to be a case!
• fix broken SYNTAX_PRINT_VANILLA
• fix an issue where it failed to parse the parameter after position parameter that has less than the span! eg: ~~~ a, failed to parse a

Suggest:

• make canParse and parse into one
• empty parameter functionality
• allow parameter to not provide data to the ingame auto-complete
• make overloadId global which will make the code shorter
• template? (temp abandoned)
• move part of Ovommand to BaseCommand
• do subCommand even need description?
• more features to the syntax parser
• rename parsedId & matchedId in Results to rawParsedCount & parsedCount

Discuss:

• Default Enums should have its own register and a version checker!? (temp abandoned)
• the problem with shared data is that if other plugins try to use other plugins enum... the enum might not exist due to plugin loading order!
• Default enums can have duplicated values if the event called more than twice on different plugins!
• Merge onRun() and onSyntaxError()?
• Add supports for private enums and synced properties for soft enums

Self note:

• Soft enums cannot spread out its value using flag 1!
• Two enums, one soft and one hard could have a same name
• Enum name could be set to anything, not just ascii / UTF-8

❌ ✔️ ✅

checked	unchecked	crossed
✓	_	✗
☑	☐	☒