MrUltimateRewards
Back

Detailed Guides & Tutorials

MrLibCore
Updated 2 weeks ago

Creating an Advent Calendar (calendar.yml)

The calendar.yml configuration is specially designed to unlock rewards gradually according to the current real-world day of the month.

  1. Setup the Timeframe Open calendar.yml and set the active-month. If you want a Christmas Advent Calendar, set it to 12 (December).
 
 
 
calendar.yml
MrUltimateRewards:
  Advent-Menu:
    active-month: 12
    title: "December Advent Calendar"
    size: 54
    command-alias: "advent, xmas"

   2. Configure the Days Under the items section, each key represents a day of the month (1 for December 1st, 24 for December 24th).

 
 
 
calendar.yml
    items:
      "1": # Day 1
        slots: "10"
        material: "CHEST"
        display-name: "&cDay 1"
        lore:
          - "&7Click to open!"
        ActionSystem:
          - "[playsound] BLOCK_NOTE_BLOCK_CHIME 1.0 1.0"
          - "[command] give [Player] diamond 1"
          - "[close]"
i

Important Notice

Players cannot open a day ahead of time! If it is December 10th, they cannot claim Day 11. If they miss a day, they can still claim it retroactively unless you implement specific conditions via PlaceholderAPI.

Creating a Quest-Milestone UI (placeholderrewards.yml)

You can hook into ANY PlaceholderAPI metric on your server to create quest-like progressions!

Scenario: Reward players for reaching 5,000 blocks mined using %statistic_mine_block%.

 
 
 
placholderrewards.yml
MrUltimateRewards:
  Placeholder-Menu:
    items:
      miner_milestone:
        slots: "13"
        material: "IRON_PICKAXE"
        display-name: "&eMiner Tier 1"
        placeholder: "%statistic_mine_block%"
        amount-needed: 5000.0
        mode: "MILESTONE" # Can be MILESTONE (once) or INFINITY (repeatable)
        max-claims: 1
        ActionSystem:
          - "[command] eco give [Player] 1000"

 ActionSystem Syntax (DSL)

Actions allow you to chain client-side and server-side events dynamically when a reward is claimed. The system executes line-by-line:

  • [close] — Shuts the inventory instantly.
  • [playsound] [volume] [pitch] — Plays an immersive sound. (e.g., [playsound] ENTITY_PLAYER_LEVELUP 1 1)
  • [actionbar]  — Fires a clean, non-intrusive actionbar message.
  • [title] <Title>;[Subtitle];[FadeIn];[Stay];[FadeOut] — Spawns massive screen text (time is in ticks, where 20 ticks = 1 second).
  • [command]  — Forces the console to execute a command. You can use the [PlayerName] variable inside this tag to specify the user!
  • [premium-command]  — (Premium Reward) Checks if the player has the specified permission. If they do, it runs the console command. Useful for giving extra bonuses to VIP players! (e.g., [premium-command] vip.reward eco give [PlayerName] 50000)

FAQ

Q: Can I put the main menu or any other menu from this plugin on an NPC?

A: Yes! You can use the Citizens plugin to bind the /rewards (Or Your Command) command to an NPC using /npc cmd add -p rewards.

Q: How do I change the ✔ and ✘ symbols for the fancy placeholders?

A: Go to messages.yml and look for the MrUltimateRewards.Placeholders.Fancy section. You can customize the exact hex colors and unicode symbols used globally by all PlaceholderAPI hooks.

Q: Players are complaining that their Playtime isn't going up. Why?

A: They are likely triggering the Advanced Anti-AFK system. Inform your players that sitting in a minecart, jumping in a water pool, or using simple auto-clickers will not generate reward playtime. They must actively play the game (break blocks, chat, or walk horizontally).

Q: Can I create a daily reward GUI separate from the weekly reward GUI?

A: Absolutely. While classic.yml contains both by default, you can simply remove one of them from classic.yml, and build an entirely new file inside the customrewardsmenu/ folder for the weekly reward. Each file can have its own command-alias.

Q: If I switch from SQLite to MySQL, do I lose my player data?

A: The plugin will automatically connect to the new MySQL instance and begin writing to the new tables. Existing SQLite data will not be automatically migrated. It is recommended to configure MySQL prior to a public server launch.