Skip to content
Berke Akçen edited this page Sep 21, 2024 · 4 revisions

Overview

Command Framework is a lightweight, annotation-based command system designed to simplify command handling in your Minecraft plugins. It works similarly to Bukkit's event system, eliminating the need to add commands to your plugin.yml while still allowing you to configure essential command features directly in your code.

Key Features

  • No plugin.yml: Effortlessly manage commands directly through annotations, eliminating the need to modify your plugin.yml file.
  • Configurable Options: Customize every aspect of your commands right in the code. Easily set command usage, descriptions, permissions, aliases, sender types, cooldowns, and argument limits, ensuring that your commands behave exactly as intended.
  • Custom Parameters: Speed up your development by creating and adding custom parameters. Make command inputs fit your needs easily, without complicated setups.
  • Cooldown Management: Implement advanced cooldowns to control how frequently commands can be executed, preventing spam and ensuring a smoother experience.
  • Confirmation System: Add an extra layer of user interaction by requiring players to confirm critical commands before execution, enhancing user experience and preventing accidental actions.
  • Arguments as Options: Utilize the flexibility of argument parsing with options formatted as --option=value, allowing for more intuitive command usage.
  • Arguments as Flags: Implement flags with a simple --flag format for quick command modifications, enabling users to toggle specific functionalities without needing additional commands.

Getting Started

Ready to dive in? Here’s how to begin:

  • Learn the Basics: Start with the Command Basics page to understand the foundational concepts.
  • Explore Command Arguments: Move on to the Command Arguments page for in-depth details on handling arguments.
  • Creating Custom Parameters: Check out the Creating Custom Parameters page to learn how to speed up your development with custom parameters.

After reviewing these pages, you’ll have a solid grasp of the framework and be ready to implement it in your projects.

Need Help?

If you encounter any issues or have questions, our Command Examples page provides a variety of sample codes for common commands. Don’t hesitate to reach out if you need further assistance!