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.

v4 is snapshot-only Imperat v4 has not been released to a stable Maven coordinate yet — it is currently published only as 4.0.0-SNAPSHOT. To pull v4 into your project you MUST add the Sonatype snapshots repository (see Snapshots below) BEFORE the install blocks resolve.

If you need a tagged release for production, stay on the latest v3 line until v4 graduates from snapshot.

Installation

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

Snapshot repo required The version blocks below resolve against 4.0.0-SNAPSHOT. They will fail to resolve unless your build script declares the snapshots repository — jump to Snapshots and add the <SnapshotRepoBlock/> snippet first, then come back.

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.