Docs

Menus

Every menu is a YAML file in plugins/PulsePrison/menus/. Titles, rows, items, slots, texts, conditions and actions can be changed without touching code. The full format is explained at the top of menus/pickaxe.yml, and each file lists its own placeholders and actions.

Changes apply with /prison reload.

Included menus

FileOpened withContent
menus/pickaxe.ymlRight click with the pickaxeEnchants, auto-sell, pickaxe stats
menus/enchant-upgrade.ymlFrom the pickaxe menuBuy levels of an enchant
menus/mines.yml/minesRank mines and private mine access
menus/ranks.yml/rankup menuRanks and requirements
menus/clan.yml/clan menuClan, members and bank
menus/market.yml/marketDynamic market prices
menus/backpack.yml/backpackVirtual backpack
menus/pets.yml/petsPet collection
menus/skills.yml/skillsPickaxe skill tree
menus/robot.yml/robot open or right click a robotRobot management
menus/robot-workshop.ymlRight click a Robot WorkshopDeploy robots
menus/autominer.yml/autominerAutominer time, upgrades and status
menus/afk-block.ymlRight click an AFK blockStored rewards
menus/attributes.yml/attributesPermanent upgrades
menus/boosters.yml/boosterActive boosters
menus/milestones.yml/milestonesMilestone categories
menus/milestone-category.ymlFrom milestonesMilestones of a category
menus/masteries.yml/masteryEnchant masteries
menus/skins.yml/skinsPickaxe skins
menus/crystals.yml/crystalsCrystal sockets
menus/armors.yml/armorArmor sets
menus/abilities.yml/abilityActive abilities
menus/settings.yml/settings or the pickaxe menu buttonPlayer settings

Private mines have their own menus in pmines/menus/ (main, members, public, admin, admin-types).

OptionDescription
titleTitle, accepts @message.key and placeholders
rowsRows, 1 to 6
open-soundSound on open
item-click-cooldownMilliseconds between clicks
back-menuMenu the back action returns to

Item options

OptionDescription
materialMaterial, head-<player>, texture-<base64> or {placeholder}
slot4, 0-8 or 0-8, 45-53
name / loreText; lines starting with [if <condition>] only show when true (=, !=, <, >, <=, >=)
glowtrue, false or a condition
amountNumber or placeholder
custom-model-dataResource pack model, number or placeholder
requirementCondition to show the item
click-requirement / deny-actionsCondition to run the click, and actions when it fails
update-intervalTicks between refreshes of the item
listFills the slots with a list, with pages
fixed-slotsThe list uses the slot each entry defines
left-click-actions · right-click-actions · shift-left-click-actions · shift-right-click-actions · any-click-actionsActions per click type

Texts and placeholders

  • A text that is only @message.key uses each player's language.
  • The menu {placeholders}, listed in each file, and PlaceholderAPI %placeholders%.
  • {module_<id>} is true when the module is enabled, for example {module_crystals} or {module_pickaxe_skins} (dashes are written as underscores).
  • If a multi-line placeholder sits on a line with [if ...], the condition applies to all its lines.

Actions

close, back, refresh, page-next, page-previous, open-menu <menu> [key=value], message <text>, player <command>, console <command>, sound <sound> [volume] [pitch], every bracket action ([message], [console], [give], [title]...) and each menu's own actions, documented in its file.

Example

yaml
title: "@menu.attributes.title"
rows: 4

items:
  filler:
    material: BLACK_STAINED_GLASS_PANE
    slot: "0-35"
    name: " "

  attributes:
    list: attributes
    fixed-slots: true
    material: "{icon}"
    name: "{name}"
    lore:
      - "@menu.attributes.attribute-lore"
    glow: "{maxed}"
    left-click-actions:
      - "attribute-upgrade {id}"
Menus | PulsePrison Core Docs