XzHarvest

!(https://cdn.modrinth.com/data/cached_images/ceb9a3ff29d7b947e6b5f45d9bbf389e1598f290.webp)

# XzHarvest

XzHarvest is a Paper/Purpur farming plugin that adds rare crop drops, harvest leaderboards, a Vault-backed harvest shop, and audit-safe farming progression for SMP servers.

It is designed for survival and economy servers that want farming to feel more rewarding without relying on custom resource packs or unsafe item-name checks.

## What XzHarvest Adds

XzHarvest adds a rare-drop system to vanilla crop farming. When players harvest supported crops, they can receive special rare harvest items with configurable names, lore, glint, and rarity.

Supported crops:

• Pumpkin
• Wheat
• Carrot
• Melon
• Potato
• Beetroot
• Nether Wart
• Cocoa

Default rarity tiers:

• Fine
• Golden
• Enchanted
• Giant

Each crop can be configured separately, including whether it is enabled, what material it uses, whether player-placed blocks are tracked, and what rare drops can roll.

## Why Use XzHarvest?

XzHarvest gives farming a stronger purpose on SMP servers.

Players get:

• Rare crop drops while farming
• Leaderboards for daily, weekly, and all-time farming competition
• A harvest shop for selling crops and rare harvest items
• Clear feedback when rare drops are found

Server owners get:

• Configurable crop drop chances
• Secure rare item identity using PersistentDataContainer
• Player-placed pumpkin and melon tracking to reduce farming abuse
• Async audit logs for rare drops, harvest totals, shop sales, and daily stats
• Storage diagnostics through admin commands
• Safe config update and reload commands

## Harvest Shop XzHarvest includes a Vault-backed shop for selling supported vanilla crops and rare harvest items.

The shop can be configured through `shop.yml`, including:

• Menu title
• Item layout
• Filler items
• Button templates
• Vanilla crop prices
• Rare harvest item prices

Vault and an economy provider are required for shop features.

## Leaderboards And Stats XzHarvest tracks harvest activity and exposes leaderboard and stats commands.

Players can view:

• Top farmers
• Crop-specific rankings
• Daily rankings
• Weekly rankings
• All-time rankings
• Aggregate crop stats

PlaceholderAPI support is included for scoreboard integrations, including ajLeaderboards-compatible placeholders.

## Configuration

On first startup, XzHarvest creates:

```text plugins/XzHarvest/ |-- config.yml |-- messages.yml |-- shop.yml |-- leaderboard.yml `-- crops/ |-- beetroot.yml |-- carrot.yml |-- cocoa.yml |-- melon.yml |-- nether_wart.yml |-- potato.yml |-- pumpkin.yml `-- wheat.yml ```

Main configuration areas:

• `config.yml` controls worlds, messages, leaderboard points, audit settings, and performance settings.
• `crops/*.yml` controls each crop and its rare drops.
• `shop.yml` controls the harvest shop.
• `leaderboard.yml` controls leaderboard menu layout and display templates.
• `messages.yml` controls player-facing messages.

## Requirements

• Java 21+
• Paper or Purpur 1. 21. 11
• XzCore 0. 2. 0+
• Vault optional
• PlaceholderAPI optional
• ajLeaderboards optional

## Commands

`/harvest` Opens the default harvest command flow.

`/harvest top ` View harvest leaderboards.

`/harvest stats ` View harvest stats.

`/harvest shop` Open the harvest shop.

`/harvest version` View plugin and database status.

`/xzharvest reload` Reload config, crop, message, shop, and leaderboard files.

`/xzharvest give ` Give rare harvest items.

`/xzharvest iteminfo` Inspect the held XzHarvest item identity.

`/xzharvest update ` Check or apply safe config migrations.

`/xzharvest data` View storage diagnostics and table row counts.

## Permissions

| Permission | Default | Description | | --- | --- | --- | | `xzharvest.top` | Everyone | View harvest leaderboards. | | `xzharvest.stats` | Everyone | View harvest stats. | | `xzharvest.shop` | Everyone | Open and use the harvest shop. | | `xzharvest.admin` | OP | Grants all XzHarvest admin permissions. | | `xzharvest.admin.reload` | OP | Reload XzHarvest configuration. | | `xzharvest.admin.give` | OP | Give rare harvest items to players. | | `xzharvest.admin.iteminfo` | OP | Inspect XzHarvest item identity data. | | `xzharvest.admin.update` | OP | Check and apply safe config updates. | | `xzharvest.admin.data` | OP | View storage diagnostics and table health. |

## PlaceholderAPI

When PlaceholderAPI is installed, XzHarvest registers numeric placeholders:

```text %xzharvest_points__% ```

```text %xzharvest_points_all_weekly% %xzharvest_points_pumpkin_all% %xzharvest_points_wheat_today% %xzharvest_points_carrot_weekly% ```