UltimateRewards Wiki
  • Getting started
    • Support
  • Addons
  • Configs
    • Player Levels
    • Referrals
    • Loginstreak
  • USAGE
    • Installation
    • Commands
  • configuration
    • Rewards
      • Creating Reward
      • Reward Types
        • Afk Reward
          • World Afk Reward
          • Area Afk Reward
          • Region Afk Reward
        • Advent Calendar
        • Pickable Reward
        • Time Reward
        • Time Fixed Reward
        • Streak Reward
        • Streak Fixed Reward
        • Vote Reward
        • Renewable Vote Reward
        • Per Vote Reward
        • Streak Vote Reward
        • Play Time Reward
        • Renewable Play Time Reward
        • Referral Reward
        • Renewable Referral Reward
        • Purchasable Reward
        • Re-Purchasable Reward
        • One Time Reward
        • Time Limited Reward
        • Custom Reward
        • Multiple Custom Reward
        • Coupon Reward
        • Discord Reward
      • Reward Settings
      • Reward Actions
      • Reward Features
        • Auto Claim
        • Notifications
        • Reward NPC
        • Discord Support
        • Reward Requirements
        • Reward Variants
        • Selectable Rewards
        • Randomization
          • Execution Chances
          • Random Placeholders
        • AFK Checkers
        • Leaderboards
    • Menus
      • Basics
      • Example of GUIs
      • Setting Menu
    • Schedules & Timers
  • Colors & Models
  • Placeholders
  • API
    • Events
    • Examples
    • Setting up own playtime calculator
  • Policies
    • TOS
Powered by GitBook
On this page
  • Checkers for Rewards
  • Checkers for Affiliates
  1. configuration
  2. Rewards
  3. Reward Features

Reward Requirements

PreviousDiscord SupportNextReward Variants

Last updated 5 months ago

Before a player can claim a reward, they must pass through a series of toggleable checkers. Here is a list of these checkers:

Checkers for Rewards

  • Limit Accounts per IP

    • Blocks claiming rewards if the number of accounts on one IP address exceeds a certain amount.

    • This is a global setting in config.yml using max-accounts-per-ip: <amount>

    • A logging system is in place for better management - when a player logs in, all his registered accounts are displayed in the console, you can toggle this by log-accounts: true/false in config.yml

    • Bypass permission: ultimaterewards.iplimit.bypass or for certain amount use ultimaterewards.iplimit.bypass.<amount>

  • Permission Checker

    • Checks if the claimer has stated permission.

    • Multiple permission can be used, see

    • Permission can be set per reward in reward's .yml using permission: "<text>" (set to "" for no required permission)

  • Enough Inventory Slots Checker

    • Cancels the claiming if the player doesn't have enough free inventory slots.

    • Can be specified per reward in it's .yml file by required-slots: <number> property.

  • Discord Account Synchronization Checker

    • Verifies if the player has their Discord account.

    • To specify that a reward requires synchronization, add require-discord-sync: true to the reward’s .yml file.

    • Bypass permission: ultimaterewards.discordSync.bypass

  • Discord Account Is Boosting Checker

    • This checker is used to check if the discord user boosts the discord server, if not, the player cannot claim the reward.

    • To specify that a reward requires user to boosting discord server, add require-boosting-discord: true to the reward’s .yml file.

  • Claiming in Disabled World(s) Checker

    • Prevents claiming of rewards if the player is located within a designated disabled world.

    • Worlds can be specified per-reward by listing them in the disabled-worlds section of the reward's .yml file.

    • Bypass permission: ultimaterewards.disabledWorld.bypass

  • Enough Play-Time Checker

    • Determines if the reward can be claimed based on the total time the player has spent on the server.

    • This can be configured in the config.yml file: first-time-join-required-play-time: <number> (set to 0 to disable this checker)

    • Bypass permission: ultimaterewards.firstTime.bypass

  • Session Play-Time Checker

    • Checks if the player has accrued the required amount of session time to claim a reward.

    • This can be configured in the config.yml file: session-required-play-time: <number> (set to 0 to disable this checker)

    • Bypass permission: ultimaterewards.session.bypass

Checkers for Affiliates

  1. Referral Creation Required Time Checker

    • Enables players to create their own referral after they have accumulated sufficient play-time.

    • Configuration can be set in referrals.yml using referral-create-required-play-time: <number> (set to 0 to disable this checker)

    • Bypass permission: ultimaterewards.requiredPlayTime.bypass

  2. Maximum Play-Time to Apply Referral Checker

    • Disallows the activation of player referrals if the player has reached the maximum play-time.

    • This limit can be configured in referrals.yml using maximum-playtime-for-referred-player: <number> (set to 0 to disable this checker)

    • Bypass permission: ultimaterewards.maximumPlayTime.bypass

  3. IP Checker

    • Prevent referral activation if the applier and referrer have the same IP address.

    • This limit can be configured in referrals.yml using disable-activation-within-same-ip: <true/false>

Reward Variants
synchronized