Reward

Description

• name: EXAMPLE

  • This is the name of the reward, in this case, it is called "EXAMPLE".

• countdown: 300

  • This is the time in seconds before you can claim the reward again. In this case, the countdown is set to 300 seconds (5 minutes).

• oneTime: false

  • This indicates whether the reward can be claimed only once or several times. In this case, it is set to "false", which means that the reward can be claimed more than once.

• update: false

  • This setting refers to whether the reward will be updated automatically. In this case, it is set to "false", which means that the reward will not be updated automatically.

• requiredSlots: -1

  • Here you can add a minimum slot requirement that the player must have free. use -1 not to use it.

• require_permission:

  • Here you specify whether a specific permission is required to claim the reward. In this case, it is enabled and requires the "rewards.example" permission.

• slot: 11

  • This is the slot number in which the reward will be displayed in the rewards menu.

• page: 1

  • This is the reward menu page where the reward will be displayed.

• requirements:

  • This section lists the requirements that must be met to claim the reward.

• actionsOnClaim:

  • Here are listed the actions that will be performed when the reward is claimed. For example, give coins to the player, display a message, play a sound, etc.

---

Important (Slots)

If you want to put multiple rewards in different slots... (if you use a texture) you can use the following slot format.

• -slot: 1,2,3,4

Using this format the compensation will be added in slots 1, 2, 3 and 4.

---

Requirements

You will be able to set requirements before claiming a reward. If you do not wish to use requirements you can use:

requirements:
- 'none'

Number

---

1. ">=" (Greater than or equal to): Checks if the value of the variable is greater than or equal to the value specified in the condition.

2. ">=" (Greater than or equal to): Checks if the value of the variable is greater than or equal to the value specified in the condition.

3. "<=" (Less than or equal to): Checks if the value of the variable is less than or equal to the value specified in the condition.

4. "==" (Equal to): Checks if the value of the variable is equal to the value specified in the condition.

5. "!=" (Different from): Checks if the value of the variable is different from the value specified in the condition.

6. ">" (Greater than): Checks whether the value of the variable is greater than the value specified in the condition.

7. "<" (Less than): Checks if the value of the variable is less than the value specified in the condition.

8. "<-" (Contains): Checks if the variable contains the substring specified in the condition.

Text

---

1. "<-" (Contains): Checks if the variable contains the substring specified in the condition.

2. "!=" (Different from): Checks if the value of the variable is different from the value specified in the condition.

3. "=" (equal to): Checks if the value of the variable is equal to the value specified in condition

4. "|-" (Starts with): Checks if the variable starts with the substring specified in the condition.

5. "-|" (Ends with): Checks if the variable ends with the substring specified in the condition.

Examples

requirements:
- '%vault_eco_balance% >= 0'

requirements:
- '%player_world% = world'

---

items | Material

#item-or-material

Actions On Claim

#basic-commands

Template

Remember that for more information you can see the different actions you can perform at Actions

# Name of reward
name: reward-example
# Waiting time in seconds to claim the reward again
countdown: 300
# If true, reward can only be claimed once
oneTime: false
# Determines whether the reward should be updated in the reward inventory
update: false
# Do you require available slots to claim?
requiredSlots: -1

# Setting permissions to claim the reward
require_permission:
  # Indicates whether a permit is required to claim the reward
  enabled: true
  # Permission required to claim
  permission: rewards.example
  # Message if you do not have permission
  message: '&6&lREWARD &8| &cYou need the reward.example permission to claim.'

# Slot in the inventory where the reward is shown
# You can also use (,) to use more slots.  1,2,3
slot: '13'
# Inventory page where the reward is located
page: 1

# Requirements for claiming the reward
# Use 'none' to not use any requirement.
requirements:
  - 'none'
  #- '%vault_eco_balance% >= 0' # The economic balance of the player must be greater than or equal to 0.
  #- '%statistic_hours_played% >= 1' # The player must complete 1 hour played on the server.

# Actions performed when claiming the reward
actionsOnClaim:
      ##
      ## You can use {player} to get the name of the player or
      ##
      ## Remember to install PlaceholderAPI and load the expansion Player :
      ## /papi ecloud download Player or %player_name% will not work.
      ##
  - '[command] eco give {player} 10000 <delay=40>'  # Gives 10,000 coins to the player after 40 ticks
  #- '[chance=50] [command] say Hi {player}' # With a 50% probability, the server says "Hi" to the player.
  #- '[player] /rewards' # Execute the /rewards command as the player
  #- '[message] &aYou have correctly claimed your reward' # Sends a confirmation message to the player
  #- '[sound] BLOCK_NOTE_BLOCK_HARP;1.0f;1.0f' # Plays a sound to the player SOUND;YAW;PITCH
  #- '[broadcast] &8» &eThe player &7{player} &ehas claimed his &7Basic &ereward using &7&o(&a/rewards&7)'  # Public message announcing the reward
  #- '[title] &a&lCLAIMED;&fsuccess;10;20;10' # Displays a title to the player
  #- '[close]' # Closes the player's inventory
  #- '[actionbar] &aYou have correctly claimed your reward' # Send a message in the actionbar to the player

  # MiniMessage > https://docs.advntr.dev/minimessage/format.html#minimessage-format
  #- '[minimessage] <MiniMessage>'
  #- '[minibroadcast] <MiniMessage>'

# Configuration of the item that is displayed when the reward is available
available:
  material: CHEST_MINECART  # Item material
  amount: 1  # Number of items (usually 1)
  model_data: 0  # Model data to customize the item
  display_name: '&aBasic Reward'  # Item name
  lore:  # Item description
    - '&8Daily Reward'
    - ''
    - ' &#6041FBDescription:'
    - '  &8● &fHere you can claim a basic'
    - '&f    reward every day.'
    - ''
    - ' &#6041FBInformation: '
    - '  &8● &fState: {state}'
    - '  &8● &fRequired: &7¡None!'
    - ''
    - ' &#6041FBRewards: '
    - '  &8● &610.000 &fCoins'
    - '  &8● &ex16 Golden Apples'
    - '  &8● &dx1 Enchanted Apples'
    - ''
    - '&e ► Click here to claim!'

# Configuration of the item to be displayed when the reward is counting down
incountdown:
  material: MINECART
  amount: 1
  model_data: 0
  display_name: '&cBasic Reward'
  lore:
    - '&8Daily Reward'
    - ''
    - ' &#6041FBDescription:'
    - '  &8● &fHere you can claim a basic'
    - '&f    reward every day.'
    - ''
    - ' &#6041FBInformation: '
    - '  &8● &fState: {state}'
    - '  &8● &fWaiting Time: &a{countdown}'
    - '  &8● &fRequired: &7¡None!'
    - ''
    - '&c ► Oh! You still can''t claim'

# Configuration of the item to be displayed when the player does not have the required permission
permission:
  material: TNT_MINECART
  amount: 1
  model_data: 0
  display_name: '&cBasic Reward'
  lore:
    - '&8Daily Reward'
    - ''
    - ' &#6041FBDescription:'
    - '  &8● &fHere you can claim a basic'
    - '&f    reward every day.'
    - ''
    - ' &#6041FBInformation: '
    - '  &8● &fState: {state}'
    - '  &8● &fRequired: &7¡None!'
    - ''
    - '&c ► You need to have rank &fUser &c!'

# Configuration of the item to be displayed when the reward is a one-time reward
onetime:
  material: HOPPER_MINECART
  amount: 1
  model_data: 0
  display_name: '&cBasic Reward'
  lore:
    - '&8Daily Reward'
    - ''
    - ' &#6041FBDescription:'
    - '  &8● &fHere you can claim a basic'
    - '&f    reward every day.'
    - ''
    - ' &#6041FBInformation: '
    - '  &8● &fState: {state}'
    - '  &8● &fRequired: &7¡None!'
    - ''
    - '&c ► You can only claim this once!'

file-version: 1