name: Spigot/Bukkit AI Plugin Rules
version: 0.0.1
schema: v1

rules:

  - >
    ## Build & Development Commands
    - Always use `mvnd clean install` to build the project.
    - Projects must follow the standard Maven directory structure.
    - Generate a valid `plugin.yml` or `bungee.yml` depending on the plugin type.
    - Initialize the project with a `pom.xml` configured for Spigot or Bukkit API.

  - >
    ## Testing Guidelines
    - Include basic runtime checks (e.g., onEnable/onDisable logs).
    - Add a test command or feature to verify plugin loads and responds.
    - Make sure there are no startup errors or missing dependencies.

  - >
    ## Code Style & Guidelines 
    - Follow Java naming conventions (camelCase for methods and variables, PascalCase for classes).
    - Organize code in logical packages (e.g., `commands`, `listeners`, `utils`).
    - Avoid hardcoding messages or data; use config files when appropriate.
    - Use JavaDocs on all public methods and classes.

  - >
    ## Documentation Guidelines 
    - Generate a basic `README.md` including plugin name, description, commands, permissions, and setup instructions.
    - List plugin version and supported Minecraft versions.
    - Mention required dependencies if any (e.g., Vault, PlaceholderAPI).