RewardsLite — Official Wiki
Current Version: 1.5
Compatibility: Minecraft 1.19.4 – 1.21.x
Java: 17+
Author: CarJav

RewardsLite Documentation (v1.5)
Introduction
RewardsLite is a lightweight daily rewards and streak system designed to improve player retention through a clean GUI, predictable logic and high performance.

The plugin focuses on simplicity and reliability, avoiding unnecessary complexity while still offering modern features such as HEX colors, placeholders and multilingual support.

⭐ Key Design Goals

• Clean UX: Simple 7-day reward cycle with a clear visual flow
  
  
• High Performance: Minimal disk writes and safe data handling
  
  
• Predictable Logic: No hidden mechanics or confusing behavior
  
  
• Modern Styling: Full HEX color and gradient support
  
  
• Easy Integration: Optional PlaceholderAPI support

⌨️ Commands & Permissions
Command Description Permission
/rewards Opens the rewards GUI rewardslite.use
/rewards reload Reloads configuration and messages rewardslite.admin
/rewards reset <player> Resets a player’s streak and progress rewardslite.admin
Note: rewardslite.use is enabled for all players by default.

⚙️ Configuration Overview
RewardsLite uses three main data sources:

• config.yml → Rewards, GUI, multipliers and logic
  
  
• messages.yml → All player-facing messages (multilingual)
  
  
• data.yml → Player progress and streaks

GUI Settings
GUI Title
settings:
gui-title: "&#fb0000Daily Rewards"

• Supports full HEX colors and gradients (&#RRGGBB)
  
  
• Can use placeholders if PlaceholderAPI is installed

Daily Rewards (7-Day Cycle)
RewardsLite is intentionally designed around a fixed 7-day cycle.

Each day supports:

days:
1:
material: "APPLE"
commands:
- "give %player% apple 2"

Supported fields

• material
  Minecraft material used in the GUI (e.g. DIAMOND, EMERALD)
  
  
• commands
  Console commands executed when the reward is claimed
  Supports placeholders:
  • %player%
    
    
  • %multiplier%

Rewards are executed from console, ensuring compatibility with economy, permission and utility plugins.

Multipliers (v1.5)
RewardsLite includes a simple permission-based multiplier system.

Example:

multipliers:
vip:
permission: "rewardslite.multiplier.vip"
factor: 1.5

How it works

• The plugin checks all configured multipliers
  
  
• The highest applicable multiplier is applied
  
  
• Multipliers affect reward commands via %multiplier%

This system is intentionally minimal to keep the Lite version clean and predictable.

PlaceholderAPI Integration (Optional)
If PlaceholderAPI is installed, RewardsLite automatically registers the following placeholders:

Placeholder Description
%rewardslite_streak% Current streak
%rewardslite_timeleft% Time until next reward (HH:mm:ss)
%rewardslite_available% READY or WAIT (colored)
%rewardslite_next_day% Next reward day
%rewardslite_can_claim_raw% true / false
No additional configuration required.

Multilingual Messages
All messages are defined in messages.yml.

• Fully multilingual (EN, ES, FR, DE, IT by default)
  
  
• HEX color and gradient support
  
  
• Safe auto-migration for new keys
  
  
• Missing keys are automatically added

Admins can freely customize wording without breaking updates.

⏱️ Timing & Logic
Reward Cooldown

• Rewards can be claimed once every 24 hours
  
  
• A live countdown is shown in the GUI if the reward is not ready

Streak Logic

• Missing a single day does not immediately reset the streak
  
  
• Players have up to 48 hours to claim before the streak resets
  
  
• If exceeded, progress resets to Day 1 automatically

This design balances forgiveness with regular engagement.

Data Handling

• Player data is stored locally in data.yml
  
  
• Autosave system writes to disk only when data changes
  
  
• Safe synchronous saving (Lite-safe, no async YAML writes)

No database required.

Installation

1. Download RewardsLite.jar
   
   
2. Place it in your /plugins/ folder
   
   
3. Start or restart the server
   
   
4. Edit config.yml to define rewards
   
   
5. Run /rewards reload

❓ Frequently Asked Questions (FAQ)
Does RewardsLite require PlaceholderAPI?
No. The plugin works fully standalone.
Placeholders are enabled automatically if PAPI is installed.

Can I configure more than 7 days?
No. RewardsLite is designed around a fixed 7-day cycle to keep the GUI and logic simple.

Does the plugin cause lag?
No. RewardsLite uses minimal memory, safe autosaving and efficient placeholder handling.

I edited the config but nothing changed
Make sure to:

1. Save the file
   
   
2. Run /rewards reload
   
   
3. Check the console for YAML errors

Support
Please do not report bugs in the review section.

For help:

• Use the Discussion tab
  
  
• Or send a Private Message

I’m happy to help.

Final Note
RewardsLite is intentionally small, predictable and easy to maintain.
If you’re looking for advanced reward trees, unlimited cycles or complex logic, those ideas are reserved for future expansions — without compromising the Lite philosophy.