DOCS berries.games ↗

Menus

Every menu is a file in plugins/BerryHomes/menus/. Change materials, slots, names, lore, sounds and click actions, then /ahome reload. Delete a file to get the default back on the next start.

File Menu
homes.yml The slots menu: numbered home slots with a button under each
homes-list.yml The list menu: every home, paged (used with menu-style: list)
home.yml One home's settings (right-click a home)
icons.yml The icon picker
confirm.yml "Are you sure?" (deleting, moving, unsafe homes)

Any other .yml file you put in menus/ becomes a menu too. Open it with [menu] <file name>.

The slots menu

rows: 5
home-slots: [11, 12, 13, 14, 15]   # where homes 1, 2, 3... go on each page
action-slots: [20, 21, 22, 23, 24] # the button under each home ([] for none)
use-home-icon: true                # show a home's own icon instead of the bed

Each slot uses a template depending on its state:

Template Used for
home A set home on this server
home-elsewhere A home on another server
locked-home A home above the player's limit
empty A free slot (click to set a home there)
locked A slot above the limit
action-set / action-empty / action-locked The button under each of those

More homes than slots on a page means more pages, with the [page] next / [page] previous buttons.

By default the bottom row is a grey bar with the page arrows, a Sort button, Your Homes (counts) and Close. When sorted by anything but number, the set homes come first in that order and the free slots after them.

The sort button

<sort_slot>, <sort_pinned>, <sort_name>, <sort_last_used>, <sort_created> and <sort_server> each show one line for the sort button, with the current order marked (sort-line-on / sort-line-off in lang.yml). A lore line that's only one of these, with nothing to show, is left out, so <sort_server> disappears on a single server.

Items

  teleport:
    material: ENDER_PEARL        # or nexo:id, itemsadder:namespace:id, oraxen:id
    slot: 10                     # or slots: [1, 2, "5-8"]
    amount: 1
    glow: true
    custom-model-data: 1001
    item-model: "myserver:home_icon"
    name: "&#5CE1C1&lTeleport"
    lore: ["&7<world> &8• &7<x>, <y>, <z>"]
    hide-tooltip: false
    sound: UI_BUTTON_CLICK 0.6 1.2
    view-requirement: some.permission
    show-if: own                 # has-previous, has-next, admin, own, other, economy, slots-style, list-style, has-icon
    click: ["[teleport]"]        # or left-click / right-click / shift-click

Lore lines whose only content is an empty <description>, <server_note> or <pinned> are left out, so homes without a description don't get a blank line.

Actions

Action What it does
[teleport] Go to the home
[sethome] Set a home in this (empty) slot
[home-menu] Open the home's settings
[delete] Delete the home (asks first)
[pin] Pin or unpin it (pinned homes sort first and glow)
[move] Move the home to where the player is standing (asks first)
[rename] Change its name
[display] Give it a fancy name
[describe] Set its description
[icon-menu] / [set-icon] / [held-icon] / [clear-icon] Choose its icon from the picker, use the held item, or go back to the default
[locked] Explain why a slot is locked
[page] next / [page] previous Change page
[sort] next / [sort] previous Change the order: number, pinned first, name, last used, newest, and server (on a network). Each player's choice is remembered until they log off.
[menu] <name> Open another menu
[back] / [refresh] / [close]
[confirm] / [cancel] Yes / no (confirm menu)
[message] ... [console] ... [player] ... [sound] ... [effect] ... The general actions, anywhere

Placeholders in menus

On home items: <home> <home_name> <number> <world> <server> <x> <y> <z> <description> <created> <last_used> <icon_name> <server_note> <pinned>.

Anywhere in a menu: <count> <limit> <page> <pages> <sort> <owner>, the sort lines above, <player>, and PlaceholderAPI %placeholders%.

Custom items

material: nexo:ruby_house, itemsadder:myitems:house or oraxen:house uses that plugin's item, for menu items and for home icons in icons.yml. If the item isn't loaded yet, it shows as a barrier until it is.