Getting Started

Getting Started with Imperat

Imperat is a powerful general-purpose command framework designed for modern application development. It provides a modern API and annotations to create command hierarchies.

Installation

Imperat is a multi-modular project, you must install the core module as a starter.

Platforms

Choose your platform to get started, each platform has its own set of features and limitations. You can find detailed information for each supported environment in the Platforms section.

Dependency

Add your chosen platform as a dependency.

REPLACE {platform} with the platform's name.

Ensure you use the same version for both imperat-core and the platform-specific module (e.g., imperat-bukkit) to avoid compatibility issues.

Shading Imperat into your project.

To avoid classpath conflicts, shade and relocate Imperat packages in your final artifact.