UltimateChristmas 4.0 Wiki

UltimateChristmas / Festive pass

Festive pass

A Christmas battle pass. Players earn pass XP from everything they do all season and claim tier rewards as they level. Every tier has a free reward — and a premium reward for pass holders, which makes the pass a natural item for your store.

module id: pass config: modules/pass.yml

How players use it

/christmas pass (permission ultimatechristmas.pass) opens the pass: tiers, progress, and claim buttons for anything unlocked.

Where XP comes from

xp:
  # Experience from specific events.
  per-advent-door: 100
  per-quest: 50

  # Experience per unit of a tracked stat (may be fractional).
  per-stat:
    shards_earned: 0.05
    presents_found: 25
    snowballs_hit: 2
    bosses_slain: 250
    ornaments_hung: 15
    gifts_given: 10

On top of that, any reward anywhere in the plugin can carry pass-xp directly — advent doors, boss loot, quest payouts.

Premium

Premium is granted either by permission or by command:

premium-permission: ultimatechristmas.pass.premium
/christmas pass premium <player>     (permission: ultimatechristmas.admin.pass)

Selling the premium pass on your webstore is one console command: christmas pass premium %player% — or grant the permission through LuckPerms for a rank-based premium.

Tiers

xp is the total experience needed to reach the tier. Each tier may carry a free and a premium reward:

tiers:
  "1":
    xp: 100
    free:    { shards: 100 }
    premium: { shards: 200, items: [ { material: COOKIE, amount: 8 } ] }
  "5":
    xp: 1500
    free:    { shards: 500 }
    premium: { items: [ { material: NETHERITE_SCRAP, amount: 1 } ] }
  "10":
    xp: 7500
    free:
      shards: 2000
      items: [ { material: DIAMOND, amount: 8 } ]
    premium:
      shards: 3000
      items:
        - { material: NETHERITE_INGOT, amount: 2 }
        - { material: ELYTRA, amount: 1 }
      broadcast: ["&6%player% &ereached the final festive pass tier!"]
      firework: true

The default pass ships ten tiers from 100 XP to 7500 XP, ending in an elytra for premium holders and a server-wide broadcast. Add as many tiers as you like.