Customize Menus

On this page, you will find information on how to customize the player menus.

#Player Menus

Each menu players open is its own file in menus inside the plugin folder, created on first use. /pcur reload reads them again.

File	Menu
wallet.yml	The wallet, with every currency the player can use.
history.yml	The balance history chart.

The in-game editor and the transaction log are admin screens, and their text is in the translation file.

Every menu starts with the same settings block: the title, the number of rows, how often the menu refreshes and the actions run when it opens.

settings:
  type: WALLET
  title: Wallet
  rows: 6
  refresh:
    enabled: true
    rate: 40
  on-open-actions: []

Leave type as it is, it tells the plugin which menu the file belongs to. The rate is in ticks. Titles, names and lore accept color codes.

#Slots and Items

Slots are counted from 0, starting at the top left of the menu, so the first row is 0 to 8. A slot takes a single slot ('4'), a range ('0-8'), or a comma separated mix of both.

The items section holds the decoration, with any names you like. Each item takes slot, material, amount, custom-model-data, item-model, glow, hide-attributes, display-name, lore, tooltip-style and actions. The plugin's own buttons, such as close, sit at the top level of the file and take the same keys.

The actions of an item and the on-open-actions of a menu are written as [TYPE] arguments, with the arguments separated by ;.

Action	Syntax
[ACTION_BAR]	`[ACTION_BAR] <message>`
[CLOSE_INVENTORY]	`[CLOSE_INVENTORY]`
[SOUND]	`[SOUND] <sound>; <volume>; <pitch>`
[TITLE]	`[TITLE] <title>; <subtitle>; <fadein>; <stay>; <fadeout>`

#Wallet

The currencies fill the pagination slots, with previous-item and next-item to turn pages and empty shown when the player has no currency here. Each currency is drawn with its own icon, the entry name and lore, then the click lines for what it allows: top-lore when it has a leaderboard, pay-lore when it can be paid, exchange-lore when it has rates, and history-lore. no-rank is shown as the rank of a player without one.

Placeholders	Description
%currency%, %currency_plain%	The display name, with and without colors.
%id%	The currency's id.
%symbol%	The symbol.
%balance%, %balance_compact%	The player's balance, in full and short.
%rank%	The player's place on the leaderboard.
%player%	The player's name, also in the title.

#Balance History

The chart section draws the days: first-column is where the first day goes, days-per-page how many days one page shows, height how many rows the tallest bar takes, bar-up and bar-down the cells of a day that went up or down, and empty the cells above them. date-format writes the day, as a Java date pattern, and change-up, change-down and change-none write the change. previous and next move a page of days, summary sums up the period and close closes the menu.

Placeholders	Where	Description
%date%, %balance%, %change%	Chart cells	The day, the balance at its end and its change.
%amount%	`change-up`, `change-down`	The size of the change.
%currency%, %currency_plain%, %player%	Title, summary	The currency and the player.
%days%, %balance%, %highest%, %lowest%	Summary	The days shown, the balance now, and the highest and lowest balance in the period.

Last updated about 3 hours ago

Customize Menus

#Player Menus

#Menu Settings

#Slots and Items

#Menu Actions

#Wallet

#Balance History