# TreasureCoffer Update Notes

**Update Date : May 21, 2025**

## New Feature: Command Reward System

We are excited to announce that TreasureCoffer plugin now supports command rewards! This brand new feature allows server administrators to set up special rewards that execute predefined commands with OP permissions when a player wins, instead of directly giving items.

### Features

- **Command Execution Rewards** : Instead of giving items, the system executes specified commands when a player wins
- **Variable Support** : ` %player%` in commands is automatically replaced with the winner's name
- **Space Handling** : Use underscores `_` to represent spaces in commands, avoiding parameter parsing errors
- **Custom Icons** : Use any item as the display icon for command rewards
- **Probability Control** : Like regular item rewards, you can set the chance of winning

### How to Use

#### Adding Command Rewards

1. Hold an item in your hand (this item will be used as the display icon for the command reward )
2. Enter the command :
  ```
   /tc addcmd <crate-id> <command> [chance ]
   ```

   - `<crate-id>` - The ID of the crate to add the reward to
   - `<command>` - The command to execute, using underscores instead of spaces, and ` %player%` to represent the winner
   - ` [chance ]` - Optional parameter to set the winning probability (default is 10 %)

#### Examples

```
/tc addcmd default eco_give_ %player%_10000 20
```

This command will execute `eco give PlayerName 10000` with OP permissions when a player wins, with a 20 % chance.

```
/tc addcmd vip lp_user_ %player%_parent_add_vip_7d 5
```

This command will execute `lp user PlayerName parent add vip 7d` with OP permissions when a player wins, with a 5 % chance.

### Important Notes

- Command rewards are executed with console (OP ) permissions, so ensure the commands are secure
- ` %player%` in commands is automatically replaced with the winner's name
- All underscores `_` in commands are automatically replaced with spaces
- Command rewards will use the item you were holding when adding the reward as the display icon in the GUI
- Command rewards can currently only be added to the normal reward pool, not the guaranteed pool

### Permission Node

- `treasurecoffer.admin.addcmd` - Allows adding command rewards

### Command List

| Command | Description |
| ---------| ------------- |
| `/tc addcmd <crate-id> <command> [chance ]` | Add a command reward to the specified crate |

---

Thank you for using the TreasureCoffer plugin! If you have any questions or suggestions, please feel free to contact us.
 

/tc addcmd default eco_give_ %player%_1000 20

# TreasureCoffer Message Configuration File

# Plugin message prefix
prefix : '&6&l [Lottery ] '

# General Messages
general :
  # Message not found
  message-not-found : 'Message not found : %key%'
  # Money
  money : 'Money'
  # Points
  points : 'Points'
  # Key
  key : 'Key'
  # None
  none : ' None'
  # Crate
  crate : 'Crate'
  # Guaranteed (Pity)
  lucky : 'Guaranteed'
  # Normal Rewards
  normal-rewards : 'Normal Rewards'
  # Guaranteed Rewards
  lucky-rewards : 'Guaranteed Rewards'

# Lottery Related Messages
lottery :
  # Lottery success
  success : ' %prefix%&c&lPlayer &a&l%player% obtained %item%!'
  # Guaranteed (Pity) lottery
  lucky : ' %prefix%&c&lPlayer &a&l%player% triggered the guaranteed mechanism and obtained %item% from the guaranteed pool!'
  # Server-wide broadcast
  broadcast : ' %prefix%&c&lPlayer &a&l%player% obtained %item% from %crate%!'
  # Inventory full (single draw)
  inventory-full-single : ' %prefix%&cInventory full! &fPlease clear space in your inventory before drawing.'
  # Inventory full (multiple draws)
  inventory-full-multiple : ' %prefix%&cNot enough inventory space! &fMulti-draw requires %count% slots. Please clear space before drawing.'
  # Inventory full during multi-draw
  inventory-full-during-multi : ' %prefix%&cInventory became full during multi-draw! &fUnused currency has been refunded.'
  # Partial multi-draw (insufficient inventory space)
  partial-multi-draw : ' %prefix%&eDue to limited inventory space, the draw has been adjusted to %actual% draws (originally %expected% draws).'
  # Not enough money
  not-enough-money : ' %prefix%&fNot enough money, %money% money required!'
  # Not enough points
  not-enough-points : ' %prefix%&fNot enough points, %points% points required!'
  # Not enough keys (singular context, e.g., for opening a GUI or single draw)
  not-enough-key : ' %prefix%&fMissing key!'
  # Not enough keys (plural context, for multi-draw)
  not-enough-keys : ' %prefix%&cYou do not have enough keys for a multi-draw, %count% keys required.'
  # Reward pool empty
  no-rewards : ' %prefix%&fThe reward pool for crate %crate% is empty!'
  # Inventory full, items dropped on the ground
  inventory-full-drop : ' %prefix%&fInventory full, item(s) dropped on the ground!'
  # Guaranteed (Pity) pool empty
  lucky-pool-empty : ' %prefix%&fThe guaranteed reward pool for crate %crate% is empty, using normal reward pool instead!'
  # No key to open crate
  no-key : "%prefix%&cYou don't have the required key to open crate &e%crate%&c."

# GUI Related Messages
gui :
  # Lottery button name
  lottery-button-name : '&a&lClick to Draw'
  # Lottery button lore
  lottery-button-lore :
   - ""
    - "&eLeft-click for Single Draw &7| &eRight-click for %multi_count%-Draw"
    - "&7--------------------------"
    - "&b✧ Guaranteed Value : &f%current%/%max%"
    - "&b✧ Cost (Money) : &f%money%"
    - "&b✧ Cost (Points) : &f%points%"
    - "&b✧ Key Required : &f%key%"
    - "&7--------------------------"
    - "&7Guaranteed reward upon reaching the guaranteed value."
    - ""
  # Previous page button name
  previous-page-name : '&e&lPrevious Page'
  # Previous page button lore
  previous-page-lore :
   - '&7Click to view previous page'
  # Next page button name
  next-page-name : '&e&lNext Page'
  # Next page button lore
  next-page-lore :
   - '&7Click to view next page'
  # Border item name
  border-name : ' '

# System Log Messages
system :
  # Directory creation failed
  create-dir-failed : "Failed to create directory: %path%"
  # Player data directory creation failed
  create-player-dir-failed : "Failed to create player data directory: %path%"
  # Configuration file creation failed
  create-file-failed : "Failed to create configuration file: %path%"
  # Configuration file creation error
  create-file-error : "Error creating configuration file: %error%"
  # Configuration file save failed
  save-file-failed : "Failed to save configuration file %file%: %error%"
  # Normal pool empty warning
  normal-pool-empty : "Normal reward pool for crate %crate% is empty!"
  # Guaranteed (Pity) pool empty warning
  lucky-pool-empty : "Guaranteed reward pool for crate %crate% is empty!"

# Command Related Messages
command :
  # No permission
  no-permission : ' %prefix%&cYou do not have permission to execute this command!'
  # Player only command
  player-only : ' %prefix%&cThis command can only be executed by a player!'
  # Console only command
  console-only : ' %prefix%&cThis command can only be executed by the console!'
  # Command usage
  usage : ' %prefix%&fUsage: %usage%'
  # Crate does not exist
  crate-not-exist : ' %prefix%&cCrate %crate% does not exist!'
  # Crate already exists
  crate-already-exist : ' %prefix%&cCrate %crate% already exists!'
  # Crate created successfully
  crate-created : ' %prefix%&aSuccessfully created crate %crate%!'
  # Reward added successfully
  reward-added : ' %prefix%&aSuccessfully added reward to crate %crate%, chance set to %chance%%!'
  # Guaranteed reward added successfully
  lucky-reward-added : ' %prefix%&aSuccessfully added guaranteed reward to crate %crate%, chance set to %chance%%!'
  # Invalid chance
  invalid-chance : ' %prefix%&cChance must be a valid number!'
  # Set draw count success
  set-count-success : ' %prefix%&aSuccessfully set player %player%''s draw count for crate %crate% to %count%!'
  # Player does not exist
  player-not-exist : ' %prefix%&cPlayer %player% does not exist!'
  # Set crate currency type and price success
  set-currency-success : ' %prefix%&aSuccessfully set crate %crate% cost to %price% %type%!'
  # Set crate currency type and price failed
  set-currency-failed : ' %prefix%&cFailed to set cost for crate %crate%!'
  # Invalid price
  invalid-price : ' %prefix%&cPrice must be a valid number!'
  # Invalid currency type
  invalid-currency-type : ' %prefix%&cInvalid currency type!'
  # Currency type info
  money-type-info : ' %prefix%&fAvailable currency types: %type1%, %type2%'
  # Newly added key related command messages
  invalid-boolean : "%prefix%&cInvalid boolean value, please use true or false."
  set-key-usage-success : "%prefix%&aSuccessfully %status% key consumption for crate &e%crate%&a."
  set-key-usage-failed : "%prefix%&cFailed to set key consumption status for crate &e%crate%&c."
  key-added : "%prefix%&aSuccessfully set item in hand as key for crate &e%crate%&a."
  key-add-failed : "%prefix%&cFailed to set item in hand as key for crate &e%crate%&c."
  # Set crate max guaranteed value messages
  set-max-value-success : "%prefix%&aSuccessfully set max guaranteed value for crate %crate% to %value%!"
  set-max-value-failed : "%prefix%&cFailed to set max guaranteed value for crate %crate%!"
  invalid-max-value : "%prefix%&cMax guaranteed value must be an integer greater than 0!"
  # Need item in hand
  need-item-in-hand : "%prefix%&cPlease hold the item you want to set in your hand!"

  # Crate block related messages
  box-item-set : "%prefix%&aSuccessfully set block appearance for crate %crate%!"
  box-item-set-failed : "%prefix%&cFailed to set block appearance for crate %crate%!"
  box-spawned : "%prefix%&aSuccessfully spawned crate %crate% block at current location!"
  box-spawn-failed : "%prefix%&cFailed to spawn crate %crate% block! Please set block appearance first."
  cannot-break-box : "%prefix%&cYou do not have permission to break this crate block!"
  box-removed : "%prefix%&aSuccessfully removed crate %crate% block!"
  shift-right-click-to-remove : "%prefix%&aAdmins can remove crate blocks with Shift + Right-click!"
  box-glow-set : "%prefix%&aSuccessfully %value% glow effect for crate %crate%!"
  box-glow-set-failed : "%prefix%&cFailed to set glow effect for crate %crate%!"
  box-glow-color-set : "%prefix%&aSuccessfully set glow color for crate %crate% to %color%!"
  box-glow-color-set-failed : "%prefix%&cFailed to set glow color for crate %crate%!"

  # Reload related messages
  reload-success : "%prefix%&aPlugin reloaded successfully! Restored %count% crates."
  restore-boxes-success : "%prefix%&aSuccessfully restored %count% crates!"

# Help Menu
help:
  header : "§6§l===== TreasureCoffer Help ====="
  create : "§e/tc create <CrateName> §7- Create a crate"
  add : "§e/tc add <CrateName> [Chance] §7- Add item in hand to crate's normal reward pool"
  addlucky : "§e/tc addlucky <CrateName> [Chance] §7- Add item in hand to crate's guaranteed reward pool"
  open : "§e/tc open <CrateName> §7- View normal rewards of a crate"
  openlucky : "§e/tc openlucky <CrateName> §7- View guaranteed rewards of a crate"
  set : "§e/tc set <PlayerName> <CrateName> <Count> §7- Set a player's draw count for a crate"
  lottery : "§e/tc lottery <CrateName> §7- Open the lottery interface"
  reload : "§e/tc reload §7- Reload the plugin and update crates"
  restoreboxes : "§e/tc restoreboxes §7- Restore all crates"
  money : "§e/tc money <CrateName> <Price> <Type> §7- Set crate's currency type and price"
  keyset : "§e/tc keyset <CrateName> <true/false> §7- Enable or disable key consumption for a crate"
  keyadd : "§e/tc keyadd <CrateName> §7- Set item in hand as the key for a crate"
  setmax : "§e/tc setmax <CrateName> <Count> §7- Set max guaranteed value for a crate"
  setbox : "§e/tc setbox <CrateName> §7- Set crate block appearance (item in hand)"
  spawnbox : "§e/tc spawnbox <CrateName> §7- Spawn crate block at current location"
  setglow : "§e/tc setglow <CrateName> <true/false> §7- Set if the crate block glows"
  setglowcolor : "§e/tc setglowcolor <CrateName> <Color> §7- Set crate block glow color"

# 抽奖消息设置
lottery-messages :
  # 是否广播普通抽奖成功消息（lottery.success）
  broadcast-success : false
  # 是否广播保底抽奖成功消息（lottery.lucky）
  broadcast-lucky : true
  # 是否广播全服公告消息（lottery.broadcast）
  broadcast-global : true