Wheel YAML Example

Wheel example of one wheel YML file. Wheels are separated into multiple yml files. One wheel = one YAML file

This page showcases the example structure of whole wheel YAML doc

settings:
  enabled: true
  view_distance: 15
  # FW2 allows you to put same wheel at multiple different locations
  # Get location where you stands using command /stringifylocation (--center)
  locations:
    - 'world(0,100,0,0,0)'
  # Available modes:
  # - PUBLIC
  # - PER_PLAYER - Multiple players can spin wheel at same time (
  wheel_mode: PUBLIC

rotation_settings:
  speeding_factor: 1.0
  # not really change the speed
  target_speed: 25
  # in ticks
  roll_time: 35-60
  slowing_factor: 1.0
  reward_show_time: 40

wheel:
  skin:
    # types:
    # - PACK - resourcepack wheel
    # - CUSTOM - custom item wheel
    type: PACK
    texture: wheels/default
    # custom-item:
    #   material: PAPER
    #   model-data: 123456
  fields: 8
  pointer:
    use: true
    # When pointer is animated, the angle of winning filed is moved but player really see what he won
    animated: true
  # Design addition (less optimized RX)
  catch_points:
    use: true
    material: BLACK_CONCRETE

tickets:
  "example_physical":
    # types:
    # - PHYSICAL - item in inventory
    # - DIGITAL - no item, just command
    # - TIMED - no item, no command, just time limit between spins (best for timed rewards) (provides placeholders, can be found on wiki page)
    type: PHYSICAL
    # remove pack-item to use your own item
    pack-item: "tickets/default"
    item:
      # material will be ignored if pack-item is set and resourcepack builder is used
      material: PAPER
      name: "&e&lWheel Ticket"
      lore:
        - "&7Use this ticket to spin the wheel!"
  "example_digital":
    type: DIGITAL

reward_display:
  use: true
  model:
    # Offset from origin round location +/- going from/to center of the wheel (base radius is 2 from center)
    offset: 0.0
    # Scale of the icon
    scale: 1.0
  tooltip:
    use: true
    # placeholders:
    # - %name% - reward name
    # - %item_amount% - amount of items in the reward
    # - %base_chance% - base chance of the reward
    # - %manipulated_chance% - chance after all manipulations (ready for upcomming features - better to show bcs of state regulations)
    # - %lore% - after line with this placeholder, it will make specific amount of item lore lines
    format:
      - '&f(%item_amount%) %name% (%manipulated_chance%)'
      - '%lore%'
      - ''
      - '&e(Left click) Show whole item...'
    lore_lines: 3
    and_more: "&7...and %amount% more"
    offset:
      x: 0.0
      z: 0.4
    chat_preview: "&eHover your mouse over the item to see reward details"

# Use early hook to make your players spand more money on the wheel
# On X first spins user get guaranteed rewards from the list
# If you have changing loadout, rewards not included in current loadout will be skipped
early_hook:
  use: false
  spins: 2
  rewards:
    - test

# Use guaranteed rewards to give players some nice rewards every Y spins
# If you have changing loadout, rewards not included in current loadout will be skipped
guaranteed_rewards:
  use: true
  # User have a guarancy of receiving centrain reward every y spins
  data:
    - 'test;1000'

wheel_filling:
  # winning modes:
  # - RANDOM - rewards can be won based on random base (like realistic wheel)
  # - CHANCE - rewards can be won based on a chance added to every reward
  # - CAPACITY - Set each reward to exactly how many times it will land in x number of spins (the total number of spins is the sum of Y values for all rewards).
  winning_mode: CHANCE
  loadout:
    # loadout modes:
    # - STATIC - basic wheel with static rewards preset, takes first loadout in the list
    # - ROTATING - every X amount of time, wheel will change to different set of rewards
    loadout_mode: STATIC
    rotate_settings:
      # Acceptable values:
      # - DAY - at midnight
      # - WEEK - at midnight on Monday
      # - MONTH - at midnight on new Month
      # - time value - example: 1d 10s (based on first run)
      change_every: DAY
    data:
      "loadout1":
        - reward: test
          var_amount: 64
          chance: 20.0%
        - reward: test
          var_amount: 3
          chance: 20.0%
        - reward: test
          var_amount: 1
          chance: 20.0%
        - reward: test
          var_amount: 5
          chance: 20.0%