Command Framework Documentation
The complete guide to the Command Framework. Learn how to create commands, handle custom parameters, manage arguments, and use every feature effectively in your plugins.
Getting Started
Section titled “Getting Started” Getting Started Learn about the Command Framework and its key features.
Basics Learn the core concepts, dependency setup, annotations, and command name rules.
Examples Common command examples and real-world use cases.
Command Core
Section titled “Command Core” Command Arguments Understand how arguments, options, flags, sender helpers, and utilities are parsed and used.
Subcommands and Error Messages Learn nested command routing, unknown subcommand handling, and CommandErrorMessage customization.
Cooldowns Advanced cooldown handling and common usage scenarios.
Customization
Section titled “Customization” Creating Custom Parameters Learn how to create and register your own custom parameter types.
Custom Command Arguments Create your own CommandArguments subclass and use it across commands and completers.
Message Formatting Use MiniMessage by default, customize framework error messages, or plug in your own formatter.
Runtime Command Attributes Update command names, aliases, permissions, usage, and sender rules after registration.
Support
Section titled “Support”If you encounter any issues or have questions, use the resources below to get support.
Spigot Discussion Community discussions, feedback, and general user support.
Issue Tracker Report bugs, request features, and track development progress.
Resource Page The official resource page on SpigotMC.
Documents
Section titled “Documents”Access technical references and developer documentation for the Command Framework.
Javadocs Comprehensive API reference for developers.
Browse frequently asked questions and common solutions.
Relocate the Framework Learn how to relocate the Command Framework packages safely in your projects.
Register Commands in a Package Learn how to register command classes inside a package.