> For the complete documentation index, see [llms.txt](https://headhunter-1.gitbook.io/headhunter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://headhunter-1.gitbook.io/headhunter/configurations/mask-rewards-config-mask-rewards.yml.md).

# Mask Rewards Config (mask-rewards.yml)

### File Location

```
plugins/HeadHunter/mask-rewards.yml
```

***

### Global Settings

<table data-full-width="false"><thead><tr><th>Setting</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:$success;">MaskRewards.Enabled</mark></td><td>Boolean</td><td>true</td><td>Master switch to enable/disable all mask rewards</td></tr></tbody></table>

### Rewards Fields

<table data-full-width="false"><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:$success;">Message</mark></td><td>String</td><td>Message shown to the player</td></tr><tr><td><mark style="color:$success;">Commands</mark></td><td>List</td><td>Commands executed when mask is created</td></tr></tbody></table>

***

### How Mask Levels Work

Masks have levels (I, II, III, etc.). You can reward players differently at each mask level:

* Level 1 = First/basic mask
* Level 2 = First upgrade
* Level 3 = Second upgrade
* And so on...

***

### Reward Structure

Rewards are defined under <mark style="color:$success;">MaskRewards.Rewards.\<MOB\_TYPE>.</mark> where:

* MOB\_TYPE = Entity type (<mark style="color:$success;">PIG, COW, ZOMBIE, etc.</mark>)
* LEVEL = Mask level number (<mark style="color:$success;">1, 2, 3, etc.</mark>)

### Default Configuration

{% hint style="info" %} <mark style="color:$success;">Rewards are optional!</mark> You only need to define rewards for masks where you want something special to happen.
{% endhint %}

{% code expandable="true" %}

```yaml
# ################################# #
# HeadHunter Plugin by DisabledGoat #
# ################################# #

# MaskRewards Configuration:
# ------------------------------------
# This section allows you to define rewards for creating Masks.
# You can customize messages and commands for each Mask.
# 
# General Settings:
# - Enabled: Set to true to enable rewards, false to disable.
# 
# Rewards Section:
# - Define rewards for specific Masks based on mob types (e.g., PIG, COW).
# - Rewards are optional. You don't need to specify rewards for all Masks.
# - Mob names must match those in the MOBS section of the config file.
# 
# Reward Options:
# - Level: Specify the Mask level to apply the reward to.
# - Message: Custom message shown to the player when they create a Mask.
# - Commands: Commands executed when the player creates a Mask.
#   Use placeholders for dynamic values:
#   - {player}: The player's name.
#   - {mask}: The created mask's name.
# 
# Example:
# MaskRewards:
#   Enabled: true
#   Rewards:
#     PIG:
#       1:
#         Message: "You received 100$ for creating {mask}!"
#         Commands:
#         - "eco give {player} 100"

Mask-rewards:
  Enabled: true
  Rewards:
    PIG:
      '1':
        Message: '&aYou received $1000 for creating a {mask}!'
        Commands:
        - eco give {player} 1000
      '3':
        Message: '&aExample to add permission. Use your permissions plugin to handle
          that!'
        Commands:
        - give {player} permission HeadHunter.test
      '5':
        Message: '&aYou received 10 Pig heads for creating a {mask}!'
        Commands:
        - hh heads give {player} Pig 10
    COW:
      '2':
        Message: '&aYou received $500 for creating a {mask}!'
        Commands:
        - eco give {player} 500
      '4':
        Message: '&aYou received a diamond axe!'
        Commands:
        - give {player} diamond_axe 1

```

{% endcode %}