CustomScreenMenu

Configuration Reference

This document details all configuration options for the CustomScreenMenu plugin, including the main configuration file (config.yml), text display configuration (text.yml), and command configuration (commands.yml). By properly configuring these files, you can fully customize the plugin's behavior and appearance.

version: "1.3.5" # Do not modify
Debug: false

# Whether to enable pumpkin overlay
use-pumpkin-overlay: false

# Whether to use the player's current location/direction as the menu camera coordinates
# true  -> Ignore camera-position in menu yml, use player's current position
# false -> Use hardcoded coordinates in menu yml (original logic)
use-player-location: false

# Whether to set a custom player exit menu orientation
exit-camera:
  yaw: 0.0
  pitch: 0.0

# Creature spawn restriction configuration
creature-spawn-limits:
  enabled: false  # Whether to enable creature spawn restrictions
  radius: 10      # Radius around menu where creature spawning is prohibited (blocks)

# Camera view block detection configuration
camera-block-check:
  enabled: true
  radius: 1  # Detection radius centered on player (blocks)

# Button access control configuration
button-access-control:
  # Configuration for buttons requiring login to click
  login-required:
    # Tag text included in button names
    name-tags:
      - "[需要登录]"
      - "[LOGIN_REQUIRED]"
    # Tag text included in button keys
    key-tags:
      - "login_required"
      - "需要登录"
  # Configuration for buttons preventing duplicate registration
  no-duplicate-registration:
    # Tag text included in button names
    name-tags:
      - "[防止重复注册]"
      - "[NO_DUPLICATE_REG]"
    # Tag text included in button keys
    key-tags:
      - "no_duplicate_reg"
      - "防止重复注册"

messages:
  prefix: '&f[&eCustomScreenMenu&f] '
  command_blocked: '&cCannot use commands in fixed view!'

sound:
  name: 'music.menu'
  volume: 1
  pitch: 1
  # Loop sound effect
  loop:
    # Whether to enable
    enabled: true
    # Play interval in seconds
    duration: 30

# Execute menu on join
join-run:
  enabled: false
  # Delay in seconds before execution
  delay: 3
  # Menu to execute
  menu: 'test'
  commands:
    - "[console] say Welcome player %player% to the game!"
    - "[player] msg %player% Welcome to the server!"
    - "[op] gamemode survival %player%"

cursor-item:
  material: 'ARROW'
  custom-model-data: 0
  scale: 0.5
  # Custom cursor size
  size:
    x: 1.0
    y: 1.0
    z: 1.0
  # Maximum 3 on X-axis, already the maximum horizontally accommodated
  max-x: 2
  # Maximum 1.5 on Y-axis, already the maximum vertically accommodated
  max-y: 3
  x: 0.0       # X-axis offset
  y: 0.0       # Y-axis offset
  z-offset: 0.0  # Cursor Z-axis offset
  # Cursor movement range limitation
  movement-range:
    # Enable custom cursor movement range limitation
    enabled: false
    # Minimum and maximum cursor positions on X-axis
    x:
      min: -2.0
      max: 2.0
    # Minimum and maximum cursor positions on Y-axis
    y:
      min: -3.0
      max: 3.0
  # Cursor default position
  default-position:
    # Enable custom cursor default position
    enabled: false
    # Default X and Y coordinates of cursor
    x: 0.0
    y: 0.0
                    

version: "1.2.3"
text-displays:
  welcome-message:
    menus:
      - "lobby"
      - "main"
    content: "&aWelcome to the server!"
    scale: 1.5
    position:
      x: 0
      y: 3
      z: -5
    tilt:
      x: 0
      y: 0
      z: 0
    animation:
      type: "rotate"  # rotate, up-down, left-right
      speed: 2.0
      spacing: 0.5
    duration: 100  # Duration (seconds)
    alignment: "center"  # left, center, right

  rules:
    menus:
      - "lobby"
    content:
      - "&eServer Rules:"
      - "&71. No cheating"
      - "&72. Respect others"
    scale: 1.2
    position:
      x: 2
      y: 1
      z: -3
    animation:
      type: "up-down"
      speed: 1.5
      spacing: 0.3
    duration: 60
    alignment: "left"
                    

# Commands allowed in camera mode (no slash needed)
allowed-commands:
  - "help"
  - "spawn"
  - "warp"
  - "cmenu stop"
  - "cursormenu stop"
                    

Detailed Configuration Explanation

Main Configuration (config.yml)

Text Display Configuration (text.yml)

Command Configuration (commands.yml)