Installation

Claimo ships as a single shaded jar. There are no required dependencies — optional integrations (PlaceholderAPI, Vault) are detected automatically when present.

Requirements

• PaperMC 1.21.1 – 26.2 (or a Paper fork). Spigot is not supported.
• Java 21+ (matching your Paper build).

Install the plugin

From a release

1. Download the latest Claimo-v<version>.jar from Modrinth, BuiltByBit or Voxel Shop.
2. Drop the jar into your server’s plugins/ folder.
3. Start (or restart) the server. Claimo generates its config files on first run.
4. Edit the generated files and run /code reload to apply changes.

Build from source

1. Clone the repository:

   git clone https://github.com/Naimadx123/Claimo.git
   cd Claimo

2. Build the shaded jar:

   ./gradlew build

3. Grab the result from build/libs/Claimo-v<version>.jar and drop it into plugins/.

Optional integrations

Plugin	Enables
PlaceholderAPI	%placeholder% in commands, the custom requirement, and the claimo expansion
Vault	The rank requirement (permission-group checks)

Tip

Neither is required. Claimo guards every integration behind a plugin-present check, so the jar never links classes that aren’t there — nothing breaks if they’re absent.

What gets created

On first run Claimo writes its data folder:

• Directoryplugins/Claimo/

  • config.yml core settings
  • messages.yml all player-facing text (MiniMessage)
  • gui.yml the voucher list GUI
  • Directoryvouchers/ one .yml per code — the file name is the code

    • test.yml

Head to the Quick start to create your first code.