Skip to content

Hat Properties

id: DIAMOND_SWORD
damage-value: 0
name: '&eHello World'
Defines the item that the player will interact with in menus.

Icons

icons:
  - WOODEN_SWORD:0
  - IRON_SWORD:0
  - GOLDEN_SWORD:0
Create additional items that will cycle depending on the items display mode.
The Menu Item will be included when cycling.

Labels

label: cool_sword
Give this hat a unique label that can be used in commands.

Tags
tags: (1)
  1. Supported Values:
    • arrows Arrows the player fires will have particles attached.
    • picture_mode Particles will spawn on the nearest Armor Stand.

A property used for debugging, but useful for testing out new features.

Custom equip message

equip-message: 'ooh, shiny!'
en_US.lang includes a global equip message that players will see anytime they equip a particle. Setting the equip-message property will override that value for this specific particle.

Description

description:
  - '&aHere is some text'
  - '&aHere is even more text'
Give your item a description, players will see this when they hover their mouse over the item.

Permission description

permission-description:
  - '&cSorry, but only &eVIP &ccan use this'
Adds a permission denied message at the end of the Description

Permission

permission: vip
Gives this particle effect a unique permission. This value does not need to include particlehats.particle. as it is automatically added when checking for permission.

When you want to give your players this permission use particlehats.particle.[permission]

Permission Denied

permission-denied: "&cOnly &eVIP &ccan use this"
Shows your players a permission denied message when they try to use this particle effect without permission.

Actions
action:
  left-click: 
    id: (1)
    argument: []
  right-click:
    id: []
    argument: []

  1. Supported Values:

    • equip
    • toggle
    • close
    • dummy
    • override
    • clear
    • command
    • open_menu
    • open_menu_permission
    • mimic
    • demo
    • acive_particles
    • purchase_confirm
    • purchase_deny
    • purchase_item

    See Actions for more information.

Changes what happens when a player clicks on this particle effect inside a menu

Display Mode
display-mode: (1)
icon-update-frequency: 2

  1. Supported Values:

    • display_in_order Displays icons in the order you created them.
    • display_randomly Picks an icon at random.

Changes how your Icons are displayed in menus. Changing the icon-update-frequency changes how often the icon is updated.

Sound

sound:
  id: UI_BUTTON_CLICK
  volume: 1.0
  pitch: 1.0
Makes your particle effect play a sound when it is clicked.

Potions

potion:
  id: SPEED
  strength: 1
Applies a potion effect when a player equips this particle effect. The potion will remain active until the particle effect is removed.

Types

type:
  id: (1)
Changes the Type that this particle effect will use.

type:
  id: custom
  name: butterfly_wings_colorable
Uses a custom .png image to display particles. See Custom Types for more information.

  1. Supported Values:
    • halo
    • trail
    • cape
    • wings
    • vortex
    • arch
    • atom
    • sphere
    • crystal
    • helix
    • creeper_face
    • angel_wings
    • susanoo
    • tornado
Location
location: (1)

  1. Supported Values:

    • head
    • chest
    • feet

Changes the starting location that is used when spawning particle effects.

Mode
mode: (1)

  1. Supported Values:

    • active
    • when_moving
    • when_afk
    • when_peaceful
    • when_gliding 1.9+
    • when_sprinting
    • when_swimming 1.13+
    • when_flying

    See Modes for more information.

Determines how a particle effect can spawn.

Animated

animated: true
If the Type you've selected supports animation, you can enable that here.

Duration

duration: 200
If you've given your particles the Demo Click Action, then you can change how long the particle effect stays active before being removed.

Price

price: 10
If you have an economy enabled in config.yml, you can define how much this particle effect will cost to purchase.

Speed

speed: 0.0
Determines how fast particles go when their spawned. Some particles have different properties at different speeds.

Count

count: 1
Determines how many particles are spawned in each pass.

Scale

scale: 1.0
Affects the distance between each particle in a Type

Offset

offset:
  x: 0
  y: 0
  z: 0
Allows finer grain control of where particles are spawned. Affects the Location

Random Offset

random-offset:
  x: 0
  y: 0
  z: 0
Applies a random offset after the Offset is applied.

Angle

angle:
  x: 0
  y: 0
  z: 0
Adjusts the angle of the Type

Update Frequency

update-frequency: 2
The plugin will attempt to spawn a particle every game tick (20 ticks per second), the update-frequency value will determine how often this particle effect will spawn, 1 being every tick, 2 being every other tick, etc..

Tracking Method
tracking: (1)
  1. Supported Values:
    • track_nothing
    • track_head_movement
    • track_body_rotation

Determines where particle effects are spawned relative to the player.

Particles

Color Data
particles:
  '1':
    particle: DUST (1)
    color:
      r: 255
      g: 255
      b: 255
      size: 1.0 (2)
  1. In older versions (1.20.4 and lower) this particle is referred to as REDSTONE
  2. The size property will only work on server version 1.13 and higher.
Block Data
particles:
  '1':
    particle: FALLING_DUST
    block-data: BLUE_WOOL
Item DATA
particles:
  '1':
    particle: ITEM_CRACK
    item-data: APPLE
Item Stack Data
particles:
  '1':
    particle: ITEMSTACK
    items:
      - DIAMOND
      - GOLD_INGOT
    item-duration: 20 (1)
    item-gravity: true (2)
    item-velocity:
      x: 0
      y: 0
      z: 0
  1. How long (in ticks) the item should stay spawned in the world.
  2. This setting will only work on server version 1.10 and higher

Nodes 

nodes:
  '1':
    # All properties above
Nodes are additional particle effects that will spawn alongside the main particle.