🔘 Bottom Buttons (Bottom)¶

The Bottom node defines the interactive button area at the bottom of the menu, with three layout modes available: notice, confirmation, and multi. Inside multi.buttons, you can also use type: repeat to generate dynamic button lists.

Configuration Structure¶

Bottom:
  type: 'mode_type'   # notice | confirmation | multi
  # Mode-specific configuration...

信息

repeat is not a Bottom.type layout mode, so do not write Bottom.type: repeat. It is a dynamic button template written under Bottom.type: multi as buttons.<buttonId>.type: repeat.

Type Overview¶

Type	Name	Purpose	Common Use Cases
`notice`	Single button mode	Displays one confirm button	Information confirmation, reward claims, simple submit actions
`confirmation`	Confirm/cancel dual button mode	Displays confirm and cancel buttons	Purchase confirmation, delete confirmation, dangerous-action confirmation
`multi`	Multi-button matrix mode	Displays multiple buttons with configurable columns and optional exit button	Main menus, control panels, category entries, complex action menus

Layout Modes And Dynamic Buttons¶

notice - Single Button Mode¶

Displays only one confirm button, suitable for information display or simple trigger actions.

Configuration:

Field	Description
`confirm.text`	Button text, supports color codes and conditions
`confirm.width`	Optional, button width (1-1024)
`confirm.actions`	List of actions to execute on click

Example:

Bottom:
  type: 'notice'
  confirm:
    text: '&a[ Claim Reward ]'
    actions:
      - 'console: give %player_name% diamond 1'
      - 'tell: &aYou claimed a diamond!'
      - 'sound: entity.player.levelup'

confirmation - Confirm/Cancel Dual Button Mode¶

Displays confirm and cancel buttons, suitable for dangerous operations requiring secondary confirmation.

Configuration:

Field	Description
`confirm.text`	Confirm button text, supports conditions
`confirm.width`	Optional, confirm button width (1-1024)
`confirm.actions`	List of actions to execute on confirm click
`deny.text`	Cancel button text, supports conditions
`deny.width`	Optional, cancel button width (1-1024)
`deny.actions`	List of actions to execute on cancel click

Example:

Bottom:
  type: 'confirmation'
  confirm:
    text: '&a[ Confirm Purchase ]'
    actions:
      - 'console: eco take %player_name% 100'
      - 'console: give %player_name% diamond_sword 1'
      - 'tell: &aPurchase successful!'
      - 'sound: entity.experience_orb.pickup'
  deny:
    text: '&c[ Cancel ]'
    actions:
      - 'tell: &7Purchase cancelled.'
      - 'sound: block.note_block.bass'

multi - Multi-Button Matrix Mode¶

Supports multiple custom buttons arranged in a matrix, with an optional exit button.

Configuration:

Field	Type	Default	Description
`columns`	`Int`	`2`	Number of button columns per row
`buttons`	Node	—	List of buttons (arranged in YAML order)
`exit`	Node	—	Optional exit/return button (displayed at the end of the button list)

Button Configuration:

Field	Type	Description
`show-condition`	String	Optional, button display condition; button is hidden when condition is not met
`type`	String	Optional. Omit for normal buttons; set to `repeat` for a dynamic button list
`text`	String/List	Button text, supports color codes, conditions, and MiniMessage tags
`width`	Int	Optional, button width (1-1024); uses default width if not set
`tooltip`	List	Optional, button hover tooltip (one string per line), supports color codes and MiniMessage
`actions`	List	Optional, list of actions to execute on click; if not set, clicking does nothing

repeat - Dynamic Button Lists¶

A button under multi.buttons can use type: repeat to generate real Paper Dialog buttons from a dynamic data source. This is useful for online player lists, warp lists, friend lists, mail lists, and other content with unknown item counts.

Basic location:

Bottom:
  type: multi
  buttons:
    list_id:
      type: repeat
      source: "data source"
      item:
        text: "&a{item.value}"
        actions:
          - "tell: You clicked {item.value}"

JavaScript:
  getWarpList: |
    JSON.stringify([
      { id: "home", name: "Home", world: "world", x: 100, y: 64, z: 200 },
      { id: "mine", name: "Mine", world: "world", x: -30, y: 12, z: 80 }
    ]);

Bottom:
  type: multi
  columns: 2
  buttons:
    warp_list:
      type: repeat
      source: "[getWarpList]"
      page_size: 20
      item:
        text: "&a{item.name}"
        width: 160
        tooltip:
          - "&7World: &f{item.world}"
          - "&7Location: &f{item.x}, {item.y}, {item.z}"
          - "&eClick to teleport"
        actions:
          - "actions: teleport_warp,{item.id}"
      empty:
        text: "&7No warps"
        actions:
          - "toast: type=task;msg=No data;icon=barrier"

    prev:
      text: "&ePrevious"
      show-condition: "{page:warp_list} > 1"
      actions:
        - "page: warp_list prev"
        - "reset"

    next:
      text: "&eNext"
      show-condition: "{page:warp_list} < {pages:warp_list}"
      actions:
        - "page: warp_list next"
        - "reset"

repeat Configuration:

Field	Type	Default	Description
`type`	String	—	Must be `repeat`
`source`	String	—	Data source. Recommended format is `[functionName]`, calling a `JavaScript` function that returns a JSON array
`split`	String	—	Optional separator for non-JSON string lists, such as `","`
`trim`	Boolean	`true`	Whether to trim each item when `split` is used
`page_size` / `page-size`	Int	`20`	Number of generated buttons per page, range `1-99`
`item`	Node	—	Button template for each list item
`empty`	Node	—	Optional button shown when the source has no items

source is resolved through KaMenu internal variables, PAPI, {js:...}, and other text variables first. The resolved result can be a JSON array, newline text, or a simple string list used with split. Items may be objects, strings, or numbers. Object fields become {item.fieldName} and can be used in button text, tooltip, show-condition, and actions.

Built-in list variables {list:key} and {glist:key} return JSON array strings and can be used directly as source:

Bottom:
  type: multi
  buttons:
    friends:
      type: repeat
      source: "{list:friends}"
      item:
        text: "&a{item.value}"
        actions:
          - "tell: You clicked {item.value}"

If the data source returns a simple string list such as player1, player2, player3, use split:

Events:
  Open:
    - "data: type=set;key=recent_players_raw;var=`player1, player2, player3`"

Bottom:
  type: multi
  buttons:
    player_list:
      type: repeat
      source: "{data:recent_players_raw}"
      split: ","
      trim: true
      item:
        text: "&a{item.value}"
        actions:
          - "tell: You clicked {item.value}"

Built-in item variables:

Variable	Description
`{item.xxx}`	Field from the current item object
`{item.value}`	Value when the current item is a string or number
`{item.index}`	Index in the full list, starting at 0
`{item.number}`	Number in the full list, starting at 1
`{item.page_index}`	Index on the current page, starting at 0
`{item.page_number}`	Number on the current page, starting at 1

Pagination variables can be used in normal Bottom.multi.buttons and repeat item templates:

Variable	Description
`{page:listId}`	Current page
`{pages:listId}`	Total pages
`{total:listId}`	Total item count
`{start:listId}`	Current page start index
`{end:listId}`	Current page end index

Pagination actions:

- "page: warp_list next"
- "page: warp_list prev"
- "page: warp_list 1"
- "page: warp_list +1"
- "page: warp_list -1"

The page: action only changes page state. It does not refresh the dialog by itself. Usually follow it with reset, open, or force-open.

Exit Button Configuration:

Field	Type	Description
`text`	String/List	Exit button text, supports color codes, conditions, and MiniMessage tags
`width`	Int	Optional, exit button width (1-1024)
`actions`	List	Optional, list of actions to execute on click; if not set, clicking does nothing

Example:

Bottom:
  type: 'multi'
  columns: 3

  buttons:
    btn_shop:
      text: '&6[ Shop ]'
      actions:
        - 'open: shop/main'

    btn_profile:
      text: '&b[ Profile ]'
      actions:
        - 'open: profile'

    btn_settings:
      text: '&7[ Settings ]'
      actions:
        - 'open: settings'

    btn_admin:
      text: '&4[ Admin Panel ]'
      actions:
        - 'open: admin/tools'

  exit:
    text: '&8[ Close ]'
    actions:
      - 'actionbar: &7Menu closed'
      - 'close'

You can also use show-condition in Multi mode to control button visibility:

Bottom:
  type: multi
  columns: 2
  buttons:
    1:
      show-condition: "%player_is_op% == true"  # Only admins can see this button
      text: '[ Admin Button ]'
      actions: ...
    2:
      show-condition: "%player_level% >= 10"  # Players level 10+ can see
      text: '[ VIP Button ]'
      actions: ...
    3:
      text: '[ Normal Button ]'  # No condition, visible to all players
      actions: ...

Conditional Button Text¶

The text field of all buttons supports conditions:

Bottom:
  type: 'confirmation'
  confirm:
    text:
      - condition: "%player_level% >= 10"
        allow: '&6[ VIP Confirm ]'
        deny: '&a[ Confirm ]'
    actions:
      - 'tell: &aConfirmed'
  deny:
    text: '&c[ Cancel ]'
    actions:
      - 'tell: &7Cancelled'

For complete condition syntax, see 🔍 Conditions.

Button Width¶

All buttons support custom width configuration via the width field.

Applicable Scope:

Confirm button in notice mode (confirm.width)
Confirm and cancel buttons in confirmation mode (confirm.width and deny.width)
All buttons in multi mode (buttons and exit buttons)

Width Values:

Range: 1 - 1024
Uses default width (determined by Paper Dialog API) if not set
Supports conditions

Example:

# notice mode
Bottom:
  type: 'notice'
  confirm:
    text: '&a[ Confirm ]'
    width: 200
    actions:
      - 'tell: &aOperation confirmed'

# confirmation mode
Bottom:
  type: 'confirmation'
  confirm:
    text: '&a[ Confirm ]'
    width: 200
    actions:
      - 'tell: &aOperation confirmed'
  deny:
    text: '&c[ Cancel ]'
    width: 100
    actions:
      - 'tell: &cOperation cancelled'

# multi mode
Bottom:
  type: 'multi'
  columns: 2

  buttons:
    wide_button:
      text: '&a[ Wide Button ]'
      width: 200
      actions:
        - 'tell: &aThis is a wide button'

    narrow_button:
      text: '&b[ Narrow Button ]'
      width: 50
      actions:
        - 'tell: &bThis is a narrow button'

    conditional_width:
      text: '&c[ Conditional Width ]'
      width:
        - condition: '%player_is_op% == true'
          allow: 200
          deny: 100
      actions:
        - 'tell: &cButton width changes based on permission'

  exit:
    text: '&8[ Exit ]'
    width: 80
    actions:
      - 'close'

Note:

Width values affect the actual display size of buttons on screen
Too large widths may cause buttons to extend beyond the screen
Adjust width values based on actual display needs