Vista Dialogs

Vista

Server menus built on Minecraft's own dialog screens

No chest inventories. No filler panes. No item names pretending to be labels.
One YAML file per screen, rendered for each player who opens it.

Why this one?

With other dialog plugins a button runs one command, and that is the whole feature. Vista adds
everything a real menu needs, put price: 1000 on a button and it is a shop that checks their
balance, confirms, takes the money and if they're short, it tells them how short they are; buttons can be hidden from, the wrong ranks, locked behind a level, or marked Owned once bought; players get on/off settings, and player lookup; and the G key and the Escape-menu button work from the first start, with no datapack and no second restart.

Things to build with it

A server hub. The G key opens it, every feature is one press away, and staff-only entries
appear with a show-if on a permission.

A profile. One file, lookup: true, and a search box for anyone else's numbers.

Leaderboards. Body lines of placeholders with `` drawn beside each one.

Kits, warps, crates. A list screen, one button each, click-if for the requirement and
deny for the reason.

Rules and guides. Body text, a button per section, no plugin dependency at all.

Settings. type: toggle buttons that flip on and off in place, remember themselves per
player, and run a command on each side.

The possibilities are nearly endless. If you can imagine a menu, Vista gives you the tools to build it.

The G keybind and the pause button, from first start

Vista automatically adds its G key Quick Actions and Escape menu integration. Just drop the plugin in, start your server, and it works. No datapacks, reloads, or extra setup required.

quick-actions:
enabled: true
dialog: menu
label: 'Menu'

pause-screen:
enabled: true
dialog: menu
label: 'Menu'

Point both at the same dialog and editing that one file changes both.

Wiki

The dialog format

Every key is optional except title and buttons.

Screen

title: 'Crate Keys' # window title. Placeholders work.
external-title: 'Keys' # the label when opened from the pause menu
command: 'keys' # registers /keys
aliases: ['k', 'crates'] # extra names for it
overwrite: true # take /keys even if another plugin has it
permission: 'server.keys' # required to open at all
back: 'shop' # where Back goes when there is no history
columns: 2 # buttons per row
escape: true # can Esc close it
close-button: 'Close' # bottom-right button that closes; omit for none
back-button: 'Back' # or one that goes back; omit for none
currency: 'coins' # what price: is counted in
prefix: 'SHOP ▶ ' # chat prefix for messages this screen causes
lookup: false # resolve placeholders for a searched player
open-if: # conditions checked before it opens

• '%player_level% >= 5'

Key · Meaning
title · Window title. Placeholders resolve per viewer
external-title · Label used when this screen is the pause-menu button
command · Registers /thatname, live — no restart
aliases · Extra names for that command
overwrite · Whether command and aliases take a name another plugin already uses. Default true
permission · Node required to open the screen
back · Dialog the Back button falls back to
columns · Buttons per row. 1 is a tall list, 2 suits a hub
escape · Whether Esc closes it. Default true
close-button · Text of a bottom-right button that closes. Omit it for none
back-button · Text of a bottom-right button that goes back. Omit it for none
currency · Which currency price: means here
prefix · Chat prefix for messages this screen causes
lookup · Resolve placeholders for a searched player instead of the viewer
open-if · Conditions, all of which must pass

Body

Lines of text above the buttons. An empty string is a blank line.

body:

• 'Keys go straight into your inventory.'
• 'Choose one below'
• ''
• 'Balance: %economy_balance%'

Buttons

Each key under buttons: names one button. The name is yours and shows up in /vista list.

buttons:
vote-key:
label: 'Vote Key'
tooltip:

• 'Vote Key'
• ''
• 'Opens the Vote Crate.'

width: 150
slot: 1
priority: 0
permission: 'server.keys.vote'
show-if:

• '%player_level% >= 10'

click-if:

• '%player_world% == survival'

deny:

• '[message] Only in the survival world.'

price: 100
owned: 'server.perk.fly'
url: 'example.com';
run:

• '[console] crates give %player_name% vote %amount%'

Key · Meaning
label · The button text
| tooltip | A list of lines, or one string using `
` |
width · Pixels, 1–1024. Default 150
slot · Draw order. Buttons sharing one are resolved by priority
priority · Lower wins the slot. Default 0
permission · Node required to see and press it
show-if · Conditions; failing hides the button
click-if · Conditions; failing blocks the press and runs deny
deny · Actions run when click-if fails
price · Cost in the screen's currency
amounts · Quantity-to-price map, for anything sold in sizes
owned · Permission meaning "already bought"
url · Opens a link instead of running anything
with-permission · Permissions the player holds only while this button's actions run
type: toggle · Makes it a switch over a setting named after the button
for-each: items · Repeats the button once per item in the game — see [Item lists](#item-lists)
search · With for-each, the input whose text narrows the list
run · The actions, in order

Inputs

Text fields, drawn above the buttons and written like buttons: a name, then what it is. A button
reads one back as $(name).

inputs:
player:
label: 'Look up a player'
max-length: 16
initial: '%player_name%'
width: 200

search:
label: 'Search'
run:

• '[player] find $(player)'

$(name) works in conditions too, so a click-if can check what was typed before anything runs,
and in an input's own initial: — initial: '$(search)' keeps the text in the box when the
screen redraws. Opening a screen starts its inputs empty.

What was typed can be tidied on the way in:

Written · " My Home " becomes
$(name\ · trim) · My Home — outer and doubled spaces dropped
$(name\ · lower) / $(name\ · upper) · my home / MY HOME
$(name\ · slug) · my_home — one safe word, for ids and commands

They chain, left to right: $(name|trim|upper).

Actions

run: is a list, carried out in order. A chain stops at the first step that refuses.

Action · Does
[player] · Runs the command as the player
[console] · Runs it as the console
[message] · Sends the player a message
[broadcast] · Sends it to everyone
[log] · Writes a console line
[sound] [volume] [pitch] · Plays a sound
[open] · Opens another dialog
[server] · Sends the player to that server through the proxy
[back] · Goes back one screen
[close] · Closes the screen
[refresh] · Redraws it in place
[lookup] · Makes the next screen describe that player
[set] · Remembers text for this player — see [Variables](#variables)
[unset] · Forgets it
[givepermission] · Grants a permission
[takepermission] · Removes one

An untagged line is treated as [message].

A step can also be a choice, made when the chain reaches it:

run:

• if: '$(name|slug) != %vista_var_home%'

run:

• '[player] essentials:renamehome %vista_var_home% $(name|slug)'

else:

• '[message] Same home, new spelling.'
• '[open] homes-manage'

if: takes any [condition](#conditions) line, or a list of them. else: is optional.

[server] is how a server selector works. /server belongs to the proxy, not to the server the
player is standing on, so running it as them does nothing; [server] survival asks the proxy
directly over the BungeeCord plugin channel, which Velocity answers as well. Nothing to install
or configure on either side.

There is no click-sound setting, on purpose: the client plays its own click when a dialog button
is pressed, so a second from the server doubles it up. A button that wants a particular noise
asks with [sound].

Conditions

show-if hides a button. click-if lets it be seen but blocks the press. Both are lists, and
every line must pass. A leading ! inverts one.

show-if:

• '%player_level% >= 30'
• '%player_world% == survival'
• 'has permission server.vip'
• '!has permission server.banned'
• 'has any permission server.vip server.mvp'
• '%player_prefix% contains Gold'
• '$(name) matches [A-Za-z0-9_]{1,16}'

Operator · Compares
| > >= `

Shops

The whole of it

Define a currency once:

currencies:
coins:
name: 'Coins'
balance: '%economy_balance%'
take: 'eco take %player_name% %amount%'
format: '