Plexon DailyRewards

Plexon DailyRewards

A standalone, production-oriented daily rewards plugin for Paper 26.2, featuring individual tier configurations, high-performance CSV logging, and flexible eligibility modes.

Highlights

• Streak & Cycle Control: One sequential claim per configured calendar day with per-tier time zones, reset hours, missed-day rules, and repeating or finite cycles.
• Flexible Eligibility: Dynamic tier selection based on GROUP, PERMISSION, WORLD, GROUP_OR_WORLD, or GROUP_AND_WORLD.
• Multi-Track Support: Configurable for HIGHEST_ONLY single-track reward priority or independent ALL_ELIGIBLE multi-track claiming.
• Soft Integration Dependencies: Built-in Vault and LuckPerms primary-group discovery with zero hard requirements.
• Rich GUI & Customization: Fully customizable MiniMessage interfaces, items, lore, sounds, and custom player heads (supports texture hashes, skin URLs, base64, or player names).
• Versatile Reward Engine: Direct items, experience/levels, console commands, player commands, custom sounds, and broadcast messages.
• Robust Interactive Menus: Includes a player reward calendar, admin tier browser, reward previews, and author info screens.
• Durable Storage & Performance: Asynchronous append-only CSV persistence, duplicate-click protection, safe claim reservation, and background atomic compaction.
• Developer API: Public cancellable before-claim and after-claim Bukkit events.

Requirements & Installation

• Platform: Paper 26.2 (Java 25)
• Optional Integrations: Vault and/or LuckPerms

Quick Setup:
[*]Stop the server.
[*]Place PlexonDailyRewards-1.0.0.jar into your plugins directory.
[*]Start the server once to generate default configuration files.
[*]Configure plugins/PlexonDailyRewards/config.yml and your desired track files under tiers/.
[*]Execute /dailyrewards reload or restart the server.

Generated File Layout:
Note: Create new tracks by adding tiers/<new-id>/config.yml. Tier IDs support lowercase alphanumeric characters, underscores, and hyphens. Day sequences must start at 1 and remain contiguous.

Tier Selection Modes

Configure tier-selection.mode in config.yml:

• GROUP — Matches when primary group matches eligibility.groups
• PERMISSION — Matches when the player holds the required tier permission
• WORLD — Matches when the current world matches eligibility.worlds
• GROUP_OR_WORLD — Matches if either the group or world matches
• GROUP_AND_WORLD — Matches only when both group and world match

Group resolution checks Vault first, followed by LuckPerms, explicitly assigned plexondailyrewards.group.<group> nodes, and finally the fallback group. Wildcards (e.g., survival_*) are fully supported.

Commands & Permissions

Aliases: /dailyreward, /drewards, /rewards

• /dailyrewards — Open the eligible reward calendar
  Permission: plexondailyrewards.use
  
• /dailyrewards claim [tier] — Claim today's available reward
  Permission: plexondailyrewards.use
  
• /dailyrewards status [tier] — View active claim status
  Permission: plexondailyrewards.status
  
• /dailyrewards info — Display plugin and author information
  Permission: plexondailyrewards.info
  
• /dailyrewards admin — Open the administrative tier browser
  Permission: plexondailyrewards.admin-gui
  
• /dailyrewards preview <tier> — Preview rewards for any tier
  Permission: plexondailyrewards.preview
  
• /dailyrewards forceclaim <player> [tier] [day] — Force-grant a claim
  Permission: plexondailyrewards.forceclaim
  
• /dailyrewards reset <player> [tier|all] — Reset player reward progress
  Permission: plexondailyrewards.reset
  
• /dailyrewards reload — Reload and validate plugin configurations
  Permission: plexondailyrewards.reload
  
• /dailyrewards save — Force immediate CSV log compaction
  Permission: plexondailyrewards.save

Administrative master node: plexondailyrewards.admin (Grants all admin permissions). Bypass node: plexondailyrewards.bypass-tier.

Reward Placeholders & Formatting

Commands execute via console by default unless designated with [player]:

commands:
- "[console] eco give {player} 500"
- "[player] spawn"

Available placeholders: {player}, {uuid}, {tier}, and {day} (or standard %player% syntax). All GUI elements and messages support MiniMessage formatting.

Operational Notes

• Claims are indexed strictly by Player UUID and Tier ID.
• Important: Do not manually edit claims.csv while the server process is active.
• Enabling fsync-each-claim: true ensures writes are flushed to disk before in-game item delivery occurs.
• Set the inventory overflow policy to DROP to safely deposit items on the ground, or CANCEL to prevent claiming when inventory space is insufficient.
• Disable unwanted default tracks using enabled: false inside their respective config file rather than deleting the directory.

Created by ZpkDxGames — Part of the Plexon software family (PlexonChats | PlexonBackpacks | GhostBlocks).