CustomScreenMenu

Getting Started

This tutorial will详细介绍 how to create and use the holographic cursor menu system of the CustomScreenMenu plugin. Through this tutorial, you will learn how to create feature-rich interactive menus from scratch.

Basic Menu Creation

In this section, we'll create a simple menu to demonstrate the basic structure and configuration options of menus.

Creating a Menu File

First, create a new YAML file in the plugins/CustomScreenMenu/menu/ directory, for example, example_menu.yml.

Basic Configuration Structure

Here is a simple menu configuration example:

example_menu:
  permission: cursormenu.menu.example_menu
  camera-position:
    world: world
    x: 0
    y: 64
    z: 0
    yaw: 0
    pitch: 0
  layout:
    button1:
      name: "Welcome to the Menu System"
      x: 0
      y: 1
      z: 3
      command:
        - "[player] say I'm using CustomScreenMenu!"

Advanced Features

Permission Control

You can set permission nodes for the entire menu or individual buttons:

example_menu:
  permission: cursormenu.menu.example_menu  # Menu-wide permission
  camera-position:
    world: world
    x: 0
    y: 64
    z: 0
    yaw: 0
    pitch: 0
  layout:
    button1:
      permission: cursormenu.button.example_button1  # Button permission
      name: "Restricted Button"
      x: 0
      y: 1
      z: 3
      command:
        - "[player] say I have permission to use this button!"

Command Execution

Menu buttons can execute various types of commands:

layout:
  player_command:
    name: "Player Command"
    x: -1
    y: 1
    z: 3
    command:
      - "[player] say This is a player command"
  console_command:
    name: "Console Command"
    x: 0
    y: 1
    z: 3
    command:
      - "[console] say This is a console command"
  op_command:
    name: "OP Command"
    x: 1
    y: 1
    z: 3
    command:
      - "[op] gamemode creative"

Menu Navigation

You can set buttons to navigate to other menus:

layout:
  next_menu_button:
    name: "Next Menu"
    x: 0
    y: 1
    z: 3
    next-menu:
      enabled: true
      menu: another_menu

Design Principles

Layout Planning

When designing menus, consider the following coordinate system:

• X-axis: Horizontal direction, negative values to the left, positive values to the right
• Y-axis: Vertical direction, negative values down, positive values up
• Z-axis: Depth direction, larger values are farther from the player

User Experience

Consider the following factors when creating menus:

• Maintain appropriate spacing between buttons to avoid mis-clicks
• Place important functions in easily clickable positions
• Use clear and explicit button labels
• Organize menu structure reasonably to avoid excessive complexity

Practical Examples

Player Main Menu

A complete player main menu example:

main_menu:
  permission: cursormenu.menu.main
  camera-position:
    world: world
    x: 0
    y: 64
    z: 0
    yaw: 0
    pitch: 0
  layout:
    teleport_menu:
      name: "Teleport Menu"
      x: -1
      y: 1
      z: 3
      next-menu:
        enabled: true
        menu: teleport_menu
    kit_menu:
      name: "Kit Menu"
      x: 1
      y: 1
      z: 3
      next-menu:
        enabled: true
        menu: kit_menu
    close:
      name: "Close Menu"
      x: 0
      y: 0
      z: 3
      command:
        - "[console] cursormenu stop"

Teleport Menu

A teleport function menu example:

teleport_menu:
  permission: cursormenu.menu.teleport
  camera-position:
    world: world
    x: 0
    y: 64
    z: 0
    yaw: 0
    pitch: 0
  layout:
    spawn:
      name: "Return to Spawn"
      x: -1
      y: 1
      z: 3
      command:
        - "[player] spawn"
    world_nether:
      name: "Go to Nether"
      x: 0
      y: 1
      z: 3
      command:
        - "[player] tp world_nether 0 64 0"
    world_the_end:
      name: "Go to The End"
      x: 1
      y: 1
      z: 3
      command:
        - "[player] tp world_the_end 0 64 0"
    back:
      name: "Back to Main Menu"
      x: 0
      y: 0
      z: 3
      next-menu:
        enabled: true
        menu: main_menu

Troubleshooting

FAQ

Q: How to test if a menu works properly?

A: Assign yourself the appropriate permission nodes, then use the /cursormenu run menu_name command to open the menu for testing.

Q: How many buttons can be added to a menu?

A: There is theoretically no limit, but it's recommended to keep a reasonable number for good user experience.

Q: How to implement complex interaction logic?

A: Complex interaction logic can be implemented by combining command execution, menu navigation, and permission control.