NightExpress's Plugins Wiki

Create custom items with custom actions on use!

Custom Actions:

  • Define what the item will do when player uses it!
  • Execute commands from console, as OP or by a player.
  • Play sounds and particle effects.
  • Select the target by conditions and apply actions on it.
  • Apply potion effects.
  • And a lot more! Check the Actions Guide...

Upon 4th different actions:

  • Define the mouse (left, right) keys with in a shift key combination and assign custom actions and cooldown for each.​

Custom Variables:

  • Define your own custom variables, that may be different on each item level, and use them in item actions - make the item more flexible.​​

Player Requirements:

  • Add player requirements such as class and level to allow use the item.​

Limit Item Usage:

  • Define the amount of item uses depends on item level before it will disappear.
  • Or make it unlimited!

Settings.yml

Default module settings are described HERE. There are no additional settings.


Items

Default module item settings and placeholders are described HERE.

Module Item Types: Usable + Limited + Leveled.

Variables Placeholders:

  • Use the %var_name% placeholders in lore and actions. Where name is variable name in LOWER CASE.

# Default item settings
material: MAP:0
name: '&eScroll of Fire %rlevel%'
lore:
- '&7Tier: &eUnique'
- '&7Uses: &f%uses%&7/&f%uses-max%'
- ''
- '%LEVEL%'
- ''
- '&7Ignites all enemies in a radius of &f%var_rad% &7blocks'
- '&7for %var_dur% &7and applies &fBlind&7 effect to them.'

# Create custom variables here.
variables-by-level:
  # Item level
  '1':
    # Key: Variable-Name, Value: Variable Value.
    # Values can be text or numeric.
    rad: 4.0
    dur: '&f10 &7seconds'
    durTick: 200
  '2':
    rad: 7.0
    dur: '&f15 &7seconds'
    durTick: 300
  '3':
    rad: 10.0
    dur: '&f20 &7seconds'
    durTick: 400

min-level: 1
max-level: 3

uses-by-level:
  1: 1
  2: 2
  3: 3
user-requirements:
  level: 15
  classes: 'Mage'

# Custom actions on item use.
# Check the Actions Guide HERE.
usage:
  # Usage key.
  # Allowed values: RIGHT, LEFT, SHIFT_RIGHT, SHIFT_LEFT
  RIGHT:
    # Usage cooldown in seconds.
    cooldown: 1
    # Custom actions.
    actions:
      target-selectors:
        radius:
        - '[RADIUS] ~distance: %var_rad%; ~allow-self: false; ~party-member: false; ~attackable: true;'
        self:
        - '[SELF]'
      action-executors:
      - '[PROGRESS_BAR] ~title: &e&lCasting...; ~subtitle: •; ~color-empty: &7; ~color-fill: &e; ~duration: 35; ~target: self;'
      - '[PARTICLE_SIMPLE] ~offset: 0.2,0.3,0.2; ~speed: 0.1; ~name: FLAME; ~target: radius; ~amount: 30; ~delay: 23;'
      - '[POTION] ~name: BLINDNESS; ~amount: 1; ~duration: %var_durTick%; ~target: radius; ~delay: 23;'
      - '[BURN] ~duration: %var_durtick%; ~target: radius; ~delay: 23;'
      - '[SOUND] ~name: BLOCK_FIRE_EXTINGUISH; ~target: self; ~delay: 23;'

Navigation