wiki

[1.18+]

Plugin Introduction
CoDigRewards is a powerful Minecraft Spigot plugin designed for server administrators to create custom mining reward systems. It allows you to set up tasks where players receive item rewards for mining specific quantities of blocks.

Key Features
Core Functions

• Custom Task System: Create unlimited mining tasks
  
  
• Multi-World Support: Different tasks for different worlds
  
  
• Permission System: Granular permission control
  
  
• Level Requirements: Set minimum level requirements
  
  
• One-Time Tasks: Configure tasks to be completed only once
  
  
• Real-time Progress Tracking: Players can view their task progress
  

Advanced Features

• PlaceholderAPI Integration: Support for all PAPI variables
  
  
• Data Persistence: Player progress automatically saved, survives server restarts
  
  
• Asynchronous Saving: High-performance data saving mechanism
  
  
• Multi-language Support: Built-in Chinese and English language files
  
  
• GUI Management Interface: Intuitive task management
  

Performance Optimization

• Asynchronous Data Processing: Won't block main thread
  
  
• Memory Caching: Efficient data caching mechanism
  
  
• Smart Detection: Only processes relevant block break events
  

Installation Guide
1. Download Plugin
Download the latest CoDigRewards-2.1.jar file from the release page.

2. Installation Steps

1. Stop the server
   
   
2. Place the jar file in the plugins/ folder
   
   
3. Start the server, plugin will automatically generate configuration files
   
   
4. Modify configuration files as needed
   
   
5. Use /reward reload to reload configuration
   

3. Optional Dependencies

• PlaceholderAPI (recommended) - Supports more variables and placeholders
  
  
• Vault (optional) - Economy system support (future versions)
  

Configuration Tutorial
Basic Configuration Structure
# Language settings
language: en

# World configuration (auto-generated)
worlds:
world: true
world_nether: true
world_the_end: true

# Data saving settings
data:
auto-save-interval: 5 # Auto-save interval (minutes)
save-on-quit: true # Save data on server shutdown

# Performance optimization
performance:
async-save: true # Asynchronous saving, recommended
cache-language-files: true # Cache language files, recommended

# Placeholder settings
placeholders:
prefix: "&8[&6CoDigRewards&8]"
reward-message: "{prefix} &aYou received &f%codigreward_amount% &f%codigreward_reward% &aas reward!"

# Task configuration
tasks:
# Task name (customizable)
oak_log_task:
block: OAK_LOG # Block type
amount: 10 # Quantity to mine
reward: DIAMOND # Reward item
reward-amount: 1 # Reward quantity
one-time: true # Whether it's a one-time task
worlds: # Applicable worlds
- world
- survival
requirements:
permission: "blockreward.basic" # Required permission
min-level: 0 # Minimum level requirement
message: "{prefix} &aGreat job, &f%player_name%&a!"
Command System
Player Commands
Basic Commands
/reward # View help information
/reward list # View all tasks
/reward info <task> # View task details
/reward progress # View your own progress
Admin Commands
/reward add <task> <block> <amount> <reward> <rewardAmount> [worldList]
/reward remove <task> # Delete task
/reward reload # Reload configuration
/reward give <player> <task> # Manually give rewards
/reward progress <player> # View other players' progress
Permission Nodes
Permission List
Permission Node Description Default
blockreward.* All permissions op
blockreward.use Use basic commands true
blockreward.admin Admin permissions op
blockreward.add Add tasks op
blockreward.remove Remove tasks op
blockreward.reload Reload config op
blockreward.give Give rewards manually op
blockreward.receive Receive rewards true
PlaceholderAPI Support
Available Placeholders
Task-related Placeholders
%codigreward_<taskName>_block% # Task block type%codigreward_<taskName>_amount% # Required quantity%codigreward_<taskName>_reward% # Reward item%codigreward_<taskName>_reward_amount% # Reward quantity