DOCS berries.games ↗

Menus

Menus live in plugins/BerryRTP/menus/. Every file is one menu: rtp.yml is the /rtp world picker and queue.yml is the /rtpqueue menu. Every item, slot, text, sound and click is yours to change, and you can add your own menus.

Turning a menu off

Set enabled: false at the top of the file, or turn it off in config.yml:

rtp:
  open-menu: false     # /rtp teleports in the player's current world instead
queue:
  open-menu: false     # /rtpqueue shows its usage message instead
enabled: true
title: "&8Random Teleport"
rows: 3                     # 1 to 6
refresh-ticks: 20           # redraw live (player counts, cooldowns), 0 = never
open-sound: BLOCK_CHEST_OPEN 0.5 1.4
click-sound: UI_BUTTON_CLICK 0.6 1.2    # for items without their own sound
close-sound: BLOCK_CHEST_CLOSE 0.5 1.4

Items

Items are drawn in order, so put background panes first and buttons after.

items:
  green-panes:
    material: LIME_STAINED_GLASS_PANE
    slots: ["0-2", "9-11", "18-20"]
    hide-tooltip: true
    sound: ""

  overworld:
    material: GRASS_BLOCK
    slot: 10
    world: world
    name: "&#5CFF5C&lOVERWORLD"
    lore:
      - "&#5CFF5C♦ &fRadius: &#5CFF5C<radius> x <radius>"
      - "&#5CFF5C♦ &fPlayers: &#5CFF5C<players>"
    sound: ENTITY_ENDERMAN_TELEPORT 0.6 1.6
    click:
      - "[close]"
      - "[rtp] world"
Option What it does
material Any item, e.g. GRASS_BLOCK, DIAMOND_SWORD, or a custom item like nexo:ruby
slot / slots One slot, or a list with ranges: [0, 1, "9-17"]. Slots count from 0, left to right, top to bottom.
amount Stack size shown
name / lore Text, with colours and placeholders
glow true for the enchanted shimmer
custom-model-data For resource packs
item-model For resource packs (1.21.4+), e.g. "mypack:rtp_icon"
hide-tooltip No tooltip when hovered (good for panes)
sound This item's click sound, or "" for silence
world Which world the placeholders describe
view-requirement Only show the item to players with this permission

Custom items

Menu icons can be items from Nexo, ItemsAdder or Oraxen:

material: nexo:ruby_sword            # Nexo item id
material: itemsadder:myitems:ruby    # ItemsAdder namespace:id (ia: works too)
material: oraxen:ruby                # Oraxen item id
  • The item keeps its texture, model and name. Set name or lore in the menu to replace them.
  • amount, glow and the other options work as usual.
  • If the plugin isn't installed, or has no item with that id, the slot shows a barrier and the console says why once.
  • These plugins load their items a few seconds after startup. A menu opened before that shows the barrier until the items are ready.
  • After changing items in Nexo or ItemsAdder, run /rtp reload so menus pick up the new version. | click | Actions for any click | | left-click / right-click / shift-click | Different actions per click type | | in-queue | A different look while the player is in this world's queue (queue menu) |

In-queue look

  overworld:
    material: GRASS_BLOCK
    in-queue:
      material: LIME_CONCRETE    # anything not set stays the same
      glow: true

Actions

Action What it does
[rtp] <world> RTP the player in that world (with their cooldown and warmup)
[queue] <world> Join that world's queue, or leave if already in it
[queue-join] <world> Join that world's queue
[queue-leave] Leave the queue
[menu] <name> Open another menu (menus/<name>.yml)
[close] Close the menu
[refresh] Redraw the menu
[player] <command> Run a command as the player (no slash)
[console] <command> Run a command from the console (no slash)
[message] <text> Send the player a message
[broadcast] <text> Send everyone a message
[sound] <SOUND> <volume> <pitch> Play a sound to the player
[effect] <EFFECT> <seconds> <level> Give a potion effect (level 0 = I)

<player> and <world> are filled in, and so are PlaceholderAPI placeholders in [console] commands.

Making your own menu

Create menus/vip.yml, then open it from another menu with [menu] vip:

title: "&6VIP Worlds"
rows: 1
items:
  resource:
    material: DIAMOND_PICKAXE
    slot: 4
    world: resource
    view-requirement: "group.vip"
    name: "&b&lRESOURCE WORLD"
    lore:
      - "&7Players here: &f<players>"
    click:
      - "[close]"
      - "[rtp] resource"

Tip: after updating BerryRTP, new default menus only appear if you delete the menus/ folder (back it up first if you changed it).