The streak reward is designed such that you can earn any number of rewards that follow one after the other, and it is necessary to collect the previous reward in order to unlock the next one.
This type of reward has also the following states, which are in addition to time-based rewards:
upcoming state - this status represents the rewards that follow the current reward (locked until the previous reward is claimed)
claimed state - this state is reached when the current streak level has already been claimed
Streak rewards can also be configured to reset the streak progress after a time period equal to twice its cooldown has elapsed or not, using the following attribute:
resetting [true/false] - if the reward should be reset, that is, if the reset time should be tracked (the time window in which the player must select the reward otherwise the streak resets to 0)
reset-after-completing [true/false] - if resetting is set to false then this can be used to specify whether the reward should be reset when the player reaches the last strike
reset-time [number] - determine the time a player has to claim a streak for a reward streak
numbering-type [text] - available types:
NORMAL (1, 2, 3, 4)
ROMAN (I, II, III, IV)
show-amount-of-the-streaks [true/false] - sets the individual streak level corresponding to the rewards' item to the amount of the item in the inventory (amount of item)
streaks [list] - setting the length and content of single streak reward.
Each single streak then has the following properties
lore [list] - reward's description
actions [list] - a list of actions that will be performed after the streak is claimed
Example configuration
# Decides if rewards will be claimable.enabled:truetype:streak_reward## Reward tag#tag:Streak Reward# When will be the next streak available# after claiming the previous one.cooldown:24# Unit used for cooldownunit:hours# So the cooldown is 24 hours# You can set the numbering type. Available types:# - NORMAL# - ROMANnumbering-type:ROMAN## (Optional) Permission which player must have to be# able to obtain this reward.#permission:ultimaterewards.exampleStreakReward## Format which will be used to show the# general cooldown of this reward.#cooldown-general-format:"%hours% hours"## Format of the cooldown that will be displayed# on the usage of the %cooldown% placeholder in reward GUIs.#cooldown-format:'%hours%:%minutes%:%seconds%'## If set to true, the streak progress will reset if# the player misses the claim schedule.#resetting:true## If resetting is set to false, you can specify# whether it should be reset when the player reaches the final streak.#reset-after-completing:true## Reset time indicates how long# the player has to collect the current streak# (default 24 hours)#reset-time:24# Notifies players that the reward is currently availablelive-reminder-enabled:true# Make the reward available for the player# after their first join on the server.available-after-first-join:true## NOTE THAT ITEM & SOUND NAMES ARE SLIGHTLY DIFFERENT BETWEEN <1.12 & 1.13< VERSIONS!# SO MAKE SURE YOU ARE USING VALID ITEM NAMES (DEFAULT ONES ARE USED FROM 1.13+ VERSIONS)# OTHERWISE, THEY WILL BE REPLACED BY STONE IF AN INVALID NAME IS USED.## When the player can claim this reward,# it will be shown as this:## %lore% will be replaced with each streak's lore# defined at the bottom of the page.available-item:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYTNlOWY0ZGJhZGRlMGY3MjdjNTgwM2Q3NWQ4YmIzNzhmYjlmY2I0YjYwZDMzYmVjMTkwOTJhM2EyZTdiMDdhOSJ9fX0=available-display-name:'&a&lSTREAK REWARD #%number%'available-lore: - ' ' - '%lore%' - ' ' - '&b► Ready to be claimed'# When the player can't claim this reward right now,# it will be shown as this:unavailable-item:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzY1ZjNiYWUwZDIwM2JhMTZmZTFkYzNkMTMwN2E4NmE2MzhiZTkyNDQ3MWYyM2U4MmFiZDlkNzhmOGEzZmNhIn19fQ==unavailable-display-name:'&c&lSTREAK REWARD #%number%'unavailable-lore: - ' ' - '%lore%' - ' ' - '&c ► Available in:' - '&4 %cooldown%'# The next streak reward will be marked, and# it will be shown as this:upcoming-item:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvN2FmNmZhYjc2N2NhNGQ3ZGY2MjE3Yjg5NWI2NjdiY2FjYzUyNGQ0MDcwNjg2MTlmODE5YTA3MGYzZjYyOWNlMCJ9fX0=upcoming-display-name:'&8&lSTREAK REWARD #%number%'upcoming-lore: - ' ' - '%lore%' - ' ' - '&7► Claim rewards before' - '&7 to achieve this reward!'# The claimed streak will be shown as this:claimed-item:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzMyOGRjZGUxNzNiZWZmOWYzZjQxYjkyMzIxM2ZjMWJiNzY3ODk2N2NjYjJlZGU3YTdjZjQwYjE4MzZiMWE3MyJ9fX0=claimed-display-name:'&7&lSTREAK REWARD #%number%'claimed-lore: - '&7 Claimed'## When the player doesn't have the reward's permission,# the following properties will be shown.#no-permission-item:BARRIERno-permission-display-name:"&c&l&mSTREAK REWARD #%number%"no-permission-lore: - "&c ✕ Locked, requires" - "&c %permission% permission"## Sets the number of items in the GUI menu# according to the corresponding streak.#show-amount-of-the-streaks:true## A streak can have an optional length,# generally, when creating a streak, you should follow# this pattern:## 1: # first streak# use-firework: <true/false> # optional value# actions: # List of actions executed after claiming a reward# - <| list of actions |># 2: # second streak# <| another streak reward configurations |>#streaks:1:lore: - '&7Contains:' - '&f 1x Coal'actions: - "[console] give %player% coal 1" - "[subtitle] &aObtained 1st streak!"2:lore: - '&7Contains:' - '&f 1x Iron Ingot'actions: - "[console] give %player% iron_ingot 1" - "[subtitle] &aObtained 2nd streak!"3:lore: - '&7Contains:' - '&f 1x Gold Ingot'actions: - "[console] give %player% gold_ingot 1" - "[subtitle] &aObtained 3rd streak!"4:lore: - '&7Contains:' - '&f 1x Diamond'actions: - "[console] give %player% diamond 1" - "[subtitle] &aObtained 4th streak!"5:lore: - '&7Contains:' - '&d 1x Netherite Ingot'actions: - "[console] give %player% netherite_ingot 1" - "[title] &bGreat Job!" - "[subtitle] &aObtained final streak!" - "[firework]"
