aikar/commands
Commands
This project is a Java command dispatch framework that maps user input to application logic using annotation-based processing. It provides a unified interface for registering and executing commands, allowing developers to define command syntax, parameter requirements, and execution logic through standard method annotations.
The framework distinguishes itself through its cross-platform command handler, which abstracts platform-specific input and registration systems into a single codebase. This allows for consistent command processing across diverse environments, including server proxies, chat bots, and various plugin architectures. It further simplifies development by automatically converting raw string input into typed domain objects and injecting necessary runtime context directly into command methods.
Beyond core dispatching, the library includes comprehensive tools for managing command lifecycles and user interaction. It supports automated help menu generation, dynamic argument completion suggestions, and command aliasing. Security is integrated through a permission management system that enforces access control, ensuring that only authorized users can trigger specific administrative actions.
To maintain stability in shared environments, the framework includes dependency relocation bundling, which packages external libraries into custom namespaces to prevent version conflicts. The project is designed to reduce boilerplate code by automating argument parsing, validation, and metadata extraction from compiled bytecode.
Features
- Application Command Dispatchers - Maps user input to application logic using annotations to define command syntax and execution requirements.
- Argument Parsing - Automatically parses and validates command arguments based on defined signatures.
- CLI Command Mapping - Maps user input to application logic using annotations to define command syntax and parameters.
- Annotation-Based - Uses method annotations to automatically generate command structures, help menus, and argument validation.
- Cross-Platform Command Handlers - Provides a unified interface for registering and processing commands across multiple server environments and bot platforms.
- Command Abstraction Layers - Provides a unified interface that abstracts platform-specific input and registration systems for consistent command processing.
- Annotation-Based Model Mapping - Maps command-line arguments to class methods using annotations for declarative command definition.
- Minecraft Plugin Development - Enables the creation of command structures for Minecraft server plugins that function across multiple server platforms.
- Automated Help Generators - Automatically generates structured help menus and documentation from command definitions.
- CLI Command Frameworks - Initializes a central command handler tailored to specific server or proxy environments.
- Command Line Argument Parsing - Automates the parsing and validation of command-line arguments for Java applications.
- Command Argument Resolvers - Resolves raw input into domain objects and validates permissions before command execution.
- Resolver Context Injection - Resolves and injects complex data types into command methods via custom parameter providers.
- Server Command Registrations - Registers custom command logic classes with a central manager for execution.
- Cross-Platform Bot Frameworks - Provides a unified framework for building bots that operate consistently across multiple messaging platforms.
- Cross-Platform Command Wrappers - Ensures consistent command execution across diverse server environments through a unified abstraction layer.
- Metadata Extraction - Reads method parameter names and types from bytecode to automatically generate help documentation.
- Type-Safe Argument Mappings - Converts raw string input into strongly-typed domain objects using registered parsers.
- Typed Argument Parsers - Converts raw string input into typed objects and domain entities while handling validation and parameter resolution.
- Command Permissions - Enforces permission checks on command execution to ensure only authorized users can trigger administrative actions.
- Role-Based Access Control - Implements role-based access control to restrict command execution based on user authorization levels.
- Dependency-Injected Contexts - Injects runtime context and server state directly into command methods to simplify access to shared dependencies.
