⚾Rewards basics

Well rewards are the bighgest thing in the plugin and they can be really complex. But now lets start with some basics.

How their syntax works?

We are starting just with a number named section (number define the field in the wheel) Then if our wheel is in chance mode, we can specify chance in a double number. After that we have to understand groups in article below.

rewards:
  "<field": # 1, 2, 3...
    chance: 0.001 - 100.0 # only for CHANCE wheels
    groups: <...>

Groups!

with groups we can define what we want from the field to do. We can define conditions for more expensive rewards, we can make different rewards for permission based players, or we can create with other plugin something like boost weekends and more. <definer> - name of group (for basic group I suggest to use name global and then related names)

groups:
  "<definer>":
    conditions: {} # OPTIONAL
    icons: {}
    actions-mode: <> # OPTIONAL
    actions: {}

Conditions:

WIth conditions we can create anything we want to. Please make sure you have correct priority (highest group in the list is on top of priority list)

Current condition types:

• permission:<permission> (check if player has a permission)

• world:<world> (check if player is in specified world)

• %placeholder%==%placeholder% (PAPI paceholder equals PAPI placeholder)

• %placeholder%==Aa%placeholder% (PAPI paceholder equals PAPI placeholder, ignoring case)

• %placeholder%!=%placeholder% (PAPI paceholder not equals PAPI placeholder)

• %placeholder%!=Aa%placeholder% (PAPI paceholder not equals PAPI placeholder, ignoring case)

• %placeholder%>=%placeholder% (Numeric PAPI paceholder is higher or equal to PAPI placeholder)

• %placeholder%<=%placeholder% (Numeric PAPI paceholder is lower or equal to PAPI placeholder)

• %placeholder%>%placeholder% (Numeric PAPI paceholder is higher to PAPI placeholder)

• %placeholder%<%placeholder% (Numeric PAPI paceholder is lower to PAPI placeholder)

Icons

syntax:

icons:
  "<id>":
    material: <>
    amount: 1-64
    custom-model-data: <>
    durability: <>
    unbreakable: true/false
    name: ""
    lore:
      - ""
    item-flags:
      - ""
    enchants:
      - ""
    

How ID works?

Id can be anything, but we suggest to go in numeric way from 1 to up.

Id define item design and when you insert multiple icons, they will rotate.

---

Material

You can use a lot of types for items...

Basic item

Just normal Java item

ex.: STONE

Base64 skull

Textured head

ex.: <base64>id

Player skull

Head with player skin

ex.: <nickname>Player

Items Adder item

item from pack plugin

ex.: <itemsadder>id

Oraxen item

item from pack plugin

ex.: <oraxen>id

---

Item Flags

All available flags can be found here https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html

---

Enchants

format: ENCHANTMENT:LEVEL example: DAMAGE_ALL:2

List of all enchants can be found here https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/enchantments/Enchantment.html

Actions mode

this mode define if you want you actions to dispatch all at field win, or just one random action or chance bundle.

available modes:

NORMAL
RANDOM
CHANCE

For normal and random setup go to this article.

For chance setup go here.