Syntax

# This option can also be:
# open_requirement:
# view_requirement:
# left_click_requirement:
# right_click_requirement:
# shift_left_click_requirement:
# shift_right_click_requirement:
click_requirement:
  # This option is not needed.
  # If you use this, only one of the
  # requirements needs to be meet.
  minimum_requirements: 1
  # This option is needed if you
  # want to use minimum_requirements.
  stop_at_success: true
  requirements:
    # You can define multiple requirements.
    # Each requiremnt should have a unique name.
    requirement_name:
      type: TYPE
      # These commands will be exeucted if
      # the requirement they're set for is
      # met even if the others are not.
      success_commands:
      - "[ACTIONTYPE] ACTION"
      - "[ACTIONTYPE] ACTION"
      # These commands will be executed if
      # the requirement they're set for is
      # not met even if the others are.
      deny_commands:
      - "[ACTIONTYPE] ACTION"
      - "[ACTIONTYPE] ACTION"
      # This option is not needed.
      # It makes it so if the other requirements
      # are met and this one is not, it will
      # not execute the general deny commands.
      optional: true
  # This can only be defined for open and
  # left/right click requirement
  deny_commands:
    - "[ACTIONTYPE] ACTION"
    - "[ACTIONTYPE] ACTION"

Requirements allow you to restrict certain actions or even an entire menu and only allow certain players to see and/or use the menu.

Requirements

Requirement types

Has permission

type: has permission
permission: TEXT

Checks if the player has the specified permission.

To invert the requirement (Check if the player doesn't have the permission) you can simply add the exclamation mark before the type name (like this type: "!has permission").

Has money

type: has money
amount: #

Checks if the player has the specified amount of money (Vault is required).

To invert the requirement (Check if the player doesn't have the amount of money) you can simply add the exclamation mark before the type name (like this type: "!has money").

Has Item

type: has item
material: "TEXT"
data: #
amount: #
name: "TEXT"
lore:
  - "TEXT"

Required fields:

• Material

• Amount

Checks if the player has the specified item in the inventory.

To invert the requirement (Check if the player doesn't have the item) you can simply add the exclamation mark before the type name (like this type: "!has item").

Has Meta

type: has meta
key: "TEXT"
meta_type: <STRING, BOOLEAN, DOUBLE, LONG, INTEGER>
value: EXPECTED VALUE

Required fields:

• key

• meta_type

• value

Checks if the player has the specified meta.

If the meta_type is a number format (DOUBLE, LONG, INTEGER) it will check if the player's meta value is greater than or equal to the value

To invert the requirement (Check if the input doesn't match the output) you can simply add the exclamation mark before the type name (like this type: "!has meta").

Is Near

type: is near
location: "WORLDNAME,X,Y,Z"
distance: #

Required fields:

• location

• distance

Checks if the player is within distance of location.

To invert the requirement (Check if the input doesn't match the output) you can simply add the exclamation mark before the type name (like this type: "!is near").

JavaScript

type: javascript
expression: 'EXPRESSION'

Example:

type: javascript
expression: '%vault_eco_balance% >= 100'

Evaluates a JavaScript expression that must return true or false.

String Equals

type: string equals
input: "TEXT"
output: "TEXT"

Example:

type: string equals
input: "%server_name%"
output: "HelpChat"

Checks if input: matches output: (Case sensitive).

To invert the requirement (Check if the input doesn't match the output) you can simply add the exclamation mark before the type name (like this type: "!string equals").

String Equals Ignore Case

type: string equals ignorecase
input: "TEXT"
output: "TEXT"

Example:

type: string equals ignorecase
input: "%server_name%"
output: "helpchat"

Checks if input: matches output: (Case insensitive).

To invert the requirement (Check if the input doesn't match the output) you can simply add the exclamation mark before the type name (like this type: "!string equals ignorecase").

String Contains

type: string contains
input: "TEXT"
output: "TEXT"

Example:

type: string contains
input: "%server_name%"
output: "chat"

Checks if input: contains output: (Case sensitive).

To invert the requirement (Check if the input doesn't contain the output) you can simply add the exclamation mark before the type name (like this type: "!string contains").

Regex matches

type: regex matches
input: "TEXT"
regex: "EXPRESSION"

Checks if input: contains the regular expression in regex:. Visit this site to create regular expressions easily.

To invert the requirement (Check if the input doesn't contain the regular expression) you can simply add the exclamation mark before the type name (like this type: "!regex matches").

Comparators

type: (==, >=, <=, !=, >, <)
input: #
output: #

Compares input: with output:.

Available options

Examples

Open Requirement

open_requirement:
  requirements:
    example_1:
      type: has permission
      permission: open.menu.one
  deny_commands:
    - "[message] &cYou don't have the permission."

View Requirement

view_requirement:
  requirements:
    example_2:
      type: string equals
      input: "%player_is_op%"
      output: "yes"

Left/Right Click Requirement

# left_click_requirement: or
right_click_requirement:
  requirements:
    example_3:
      type: has money
      amount: 100
  deny_commands:
    - "[message] &7You don't have enough money."

Minimum Requirements

click_requirement:
  minimum_requirements: 1
  stop_at_success: true
  deny_commands:
    - "[message] &7You don't have 1 of the 2 permissions required."
  requirements:
    perm1:
      type: has permission
      permission: perm.1
    perm2:
      type: has permission
      permission: perm.2
click_commands:
- "[message] &7You have 1 of the 2 permissions required."