Skip to main content

Introduction

This documentation is your complete guide to creating, customising, and understanding CommandPanels, a powerful plugin for building custom GUI menus in Minecraft using YAML files.

CommandPanels enables you to:

  • Build interactive menus and panels using in-game items.
  • Create animations when using Inventory Panels.
  • Support Bedrock players with Floodgate Panels.
  • Use Minecraft Dialogs for menus with Dialog Panels.
  • Bind commands, animations, logic, and permissions.
  • Build advanced placeholder and data-driven interfaces.

Whether you're a server administrator or plugin developer, this documentation will help you get the most out of what CommandPanels has to offer.

What You'll Find​

  • Quick Start: Learn how to set up your first panel in minutes.
  • Panel Types: Understand the differences between Inventory, Dialog, and Floodgate panels.
  • Items and Slots: Define the behavior, logic, and animation of panel items.
  • Commands and Requirements: Master the use of command tags and custom logic for interactivity.
  • Placeholders and Data: Customize behavior dynamically using player data, conditions, and built-in variables.

Prerequisites​

Before diving in, make sure you have:

  • A Minecraft server running Paper, or a compatible fork.
  • The CommandPanels plugin installed.
  • Optional but recommended PlaceholderAPI if you want to use placeholders.
  • Coffee (or your preferred energy source)

Plugin Permissions​

CommandPanels uses standard permission nodes to control access to its features. Below is a list of permissions and their default access levels:

  • commandpanels.command: Allows access to the base /pa command. Default: true

  • commandpanels.command.reload: Allows reloading the plugin. Default: op

  • commandpanels.command.generate: Grants access to the panel generator command. Default: op

  • commandpanels.command.version: Allows checking the plugin version. Default: true

  • commandpanels.command.data: Gives access to configure panel data. Default: op

  • commandpanels.command.open: Allows opening panels with /pa open. Default: op

  • commandpanels.command.open.other: Lets you open panels for other players. Default: op

  • commandpanels.command.help: Allows access to /pa help. Default: true

You can manage these with any standard permissions plugin.

Start by heading to the Quick Start page to get your first panel running!