UI Conigs

You can find all UI configs at /plugins/SpinToWin/ui folder. Its UI name is same as the file name in this folder. For example, ui.yml file's <uiConfig> arg is example.

Free version can only load 1 spin UI, premium version don't have this limit.

Here is an example of UI Conigs.

gui: ":offset_-8::s2w_ui:"
inventory_size: 45
history_gui: ""
history_inventory_size_dynamic: true
slots: [9,10,11,12,13,22,31,40,39,38,37,36,27,18]
reserve: false
replace:
  material: gray_stained_glass_pane
  amount: 1
  display: "&3Acquired"
frame: frame
show_rate: true
auto_reset_when_empty: true
auto_close_when_empty: true
auto_close_when_price_not_meet: false
limits:
  default: 100
  vip: 200
limits-conditions:
  vip:
    - 'permission: group.vip'
buttons:
  spin:
    icons: [spin_1,spin_2,spin_3]
    slots: [33,34,35]
    display: "&aSpin!"
    lore:
      - "&fYou should cost %price%"
      - "&f"
      - "%click%"
  history:
    icons: [history_1,history_2,history_3]
    slots: [42,43,44]
    display: "History"
    lore:
      - "&fCheck the rewards you have drawn."
last_reward:
  material: DIAMOND_SWORD
  amount: 1
last_reward_slot: 16
rewards:
  1:
    material: DIAMOND
    cmd: 0
    display: '&eA赏'
    lore:
      - '&fLine1'
      - '&fLine2'
    commands:
      - 'help'
  2:
    material: IRON_INGOT
    amount: 10
    chance: 20
  3:
    material: GOLD_INGOT
    amount: 5
    chance: 10
  4:
    material: APPLE
    amount: 64
    chance: 10
  5:
    material: DIAMOND
    amount: 2
    chance: 5
  6:
    material: IRON_INGOT
    amount: 10
    chance: 20
  7:
    material: GOLD_INGOT
    amount: 5
    chance: 10
  8:
    material: APPLE
    amount: 64
    chance: 10
  9:
    material: DIAMOND
    amount: 2
    chance: 5
  10:
    material: IRON_INGOT
    amount: 10
    chance: 20
  11:
    material: GOLD_INGOT
    amount: 5
    chance: 10
  12:
    material: APPLE
    amount: 64
    chance: 10
  13:
    material: DIAMOND
    amount: 2
    chance: 5
  14:
    material: IRON_INGOT
    amount: 10
    chance: 20
prices:
  1:
    hook-plugin: EcoItems
    hook-item: test
    amount: 15
    placeholder: 'test x15'
  2:
    material: STONE
    amount: 10
    placeholder: 'STONE x10'
  3:
    economy-plugin: Vault
    amount: 10.0
    placeholder: '$10'
  4:
    vanilla-type: levels
    amount: 5
    placeholder: '5 L'
  5:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  6:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  7:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  8:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  9:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  10:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  11:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  12:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  13:
    economy-type: levels
    amount: 5
    placeholder: '5 L'
  14:
    economy-type: levels
    amount: 5
    placeholder: '5 L'

• gui: Spin UI title name.

• inventory_size: Spin UI size, must be one number of 9, 18, 27, 36, 45, 54.

• history_gui: History GUI title name.

• history_inventory_size_dynamic: Whether history size is depand on claimed rewards amount or just same as inventory_size value.

• slots: Reward item slots.

• reserve: Whether reward can be claimed unlimited times or only one time.

• auto_reset_when_empty: Whether plugin auto reset date when this spin UI rewards all claimed.

• auto_close_when_empty: Whether plugin auto close UI when this spin UI rewards all claimed.

• auto_close_when_price_not_meet: Whether plugin auto close UI when this players are not meet next spin cost.

• replace: The item of will replaced at claimed reward item slot.

• frame: Frame name, see config.yml.

• show_rate: Whether to add a line of lore to the reward item to display its rate.

• limits: Set the maximum times of spin UI. You must enable check-permission-limit option in config.yml file to use this feature.

• limits.default: If player dont have any required permsision, they will use this limit.

• limits.<Condition ID>: Players who meet this condition will use this limit. For example:

limits:
  default: 10
  vip: 20
limits-conditions:
  vip: 
    - 'permission: test.permission'

In this example, players who have test.permission permission will have 20 limits, otherwise they have only 10 limits.

• button: Button configs.

• button.icons: Button icon name, see config.yml.

• last_reward: The reward what will be claimed if players has claimed all normal rewards. See Rewards Option for more info.

• last_reward_slot: Last reward slot.

• last_reward_times: How many spin times after will you get the last reward. If not set (and I recommend you do not add this option), will get last reward after you claim all rewards in a spin UI. You must enable check-permission-limit option in config.yml to use this option.

• rewards: List of normal rewards. See Rewards Option for more info.

• prices: List of prices. See Prices Option for more info.

• For rewards and prices option: Every of them have its ID number. All ID number should be a natural number starting from 1 and incrementing by 1. Prices ID number also mean it the number of spin times it applies, otherwise we will set it as free.