AFK Rewards Mod

Overview

AFK Rewards is a server mod that lets server admins create special zones where players get rewarded for staying in one place. Set up reward areas with items, currency, or commands that trigger automatically at regular intervals!

Features

Create Custom Reward Zones: Use simple commands to define cuboid areas where rewards are given
Automatic Rewards: Players get rewards every 5 minutes (configurable) while in a zone
Flexible Rewards: Give items, currency, or execute commands as rewards
Chat Notifications: Players see messages when entering/leaving zones and when they receive rewards
Easy Management: Simple commands to create, delete, and list all reward zones

How to Use

Setting Up a Reward Zone

Set Position 1: Stand at one corner of your zone and run:
```
/afkregion pos1
```
Set Position 2: Move to the opposite corner and run:
```
/afkregion pos2
```
Create the Zone: Create the zone with a name:
```
/afkregion create <name>
```
Example: /afkregion create spawn_rewards

Managing Zones

List all zones: /afkregion list
Delete a zone: /afkregion delete <name>
Reload config: /afkregion reload

For Players

Players will see a chat message when they enter a reward zone. If they stay in the zone and remain idle for the AFK threshold, they'll receive rewards automatically. The rewards stop immediately if they leave the zone or move.

Tips & Tricks

Create zones near spawn or popular gathering spots to encourage players to visit
Use reward zones as incentives for players to explore your world
Combine item rewards with currency rewards for maximum engagement
Zones are invisible to players - they discover them through exploration or word-of-mouth!

Configuration

The mod writes two JSON files in the plugin data folder on first run:

config.json - global settings
regions.json - saved region definitions and rewards

Global Settings (`config.json`)

afk_threshold_seconds: How long a player must remain idle before rewards begin
reward_interval_minutes: How often rewards are granted while AFK
messages_enabled: Enable/disable chat notifications
currency_command: Command template used for currency rewards (leave empty to disable)
reward_permission: Optional permission required to receive rewards (leave empty to allow everyone)

Currency and command rewards support placeholders:

{player} - player name
{uuid} - player UUID
{amount} - currency amount (currency rewards only)

Region Rewards (`regions.json`)

Each region stores a list of rewards. Supported reward types:

item: item_id:quantity (quantity optional, default 1)
currency: numeric amount (uses currency_command)
command: server command to run (leading / is optional)

Known Limitations

Reward zones are cuboid (rectangular box) shaped only
Players must be in the exact world where the zone is defined to receive rewards
Rewards can optionally require a permission node to receive rewards