Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - BentoBoxWorld/ControlPanel: Clickable GUI menu · GitHub
Skip to content

Latest commit

History

96 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🎛️ ControlPanel Addon for BentoBox

DiscordBuild Status

Give your players a slick, clickable GUI menu to run their most-used island commands — no typing required. ControlPanel is a BentoBox addon that lets server admins build fully customizable control panels using a simple YAML file.


✨ Features

  • 🖱️ Click-to-run — left-click, right-click, and shift-click can each trigger a different command
  • 🗂️ Multiple panels — define as many panels as you want per gamemode; assign them to players via permissions
  • 🎨 Rich icons — use any vanilla material, BentoBox ItemParser format, or ItemsAdder custom items
  • 📋 Live placeholders — button descriptions support PlaceholderAPI, color codes, and [gamemode] substitution
  • 📦 Console commands — prefix a command with [server] to run it as the console
  • 🔢 Slot ranges — fill a row of slots with a single button definition using "0-8"
  • 🌍 13 localisations — cs, de, en-US, es, fr, id, ko, lv, pl, ru, zh-CN, zh-HK, zh-TW
  • 🔌 Works with AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock, etc.

📦 Installation

  1. Drop the ControlPanel JAR into plugins/BentoBox/addons/.
  2. Restart the server — ControlPanel creates a default controlPanelTemplate.yml in plugins/BentoBox/addons/ControlPanel/.
  3. Edit controlPanelTemplate.yml to build your panels (see below).
  4. Run the import command in-game to load your panels:
    /bsb cp import
    
    Supply a custom filename to import from a different file:
    /bsb cp import myCustomPanels
    

    ⚠️ Importing when panels already exist will ask for confirmation and replace them.


🎮 Commands

Player command

/is cp
/is controlpanel

Opens the player's assigned control panel. Players without a specific panel permission see the defaultPanel.

Admin command

/{admin} cp import [filename]
/{admin} cp import
CommandDescription
/{admin} cp importImport panels from controlPanelTemplate.yml (default)
/{admin} cp import myFileImport panels from myFile.yml in the addon data folder

Replace {admin} with your gamemode's admin command, e.g. bsb for BSkyBlock or oa for AOneBlock.


🔑 Permissions

PermissionDefaultDescription
[gamemode].controlpaneltrueOpen the control panel
[gamemode].controlpanel.adminopUse admin import command
[gamemode].controlpanel.panel.defaulttrueAccess the default panel
[gamemode].controlpanel.panel.<suffix>Access a custom panel named <suffix>

Replace [gamemode] with the gamemode name in lowercase, e.g. bskyblock, acidisland, aoneblock.


🛠️ Configuration File Reference

The template file lives at plugins/BentoBox/addons/ControlPanel/controlPanelTemplate.yml.

Top-level structure

panel-list:
<panel-key>:
defaultPanel: true|falsepanelName: '<title>'permission: '<suffix>'buttons:
<slot>:
name: '<display name>'material: MATERIAL_NAMEicon: 'namespace:item_id'itemsadder: 'namespace:item_id'description: |- line one line twocommand: '<left-click command>'right_click_command: '<right-click command>'shift_click_command: '<shift+left-click command>'

Panel fields

FieldDescription
defaultPaneltrue = shown to players with no specific panel permission
panelNameTitle of the inventory GUI. Supports & color codes.
permissionSuffix for [gamemode].controlpanel.panel.<suffix>. Players with that permission see this panel.

Button fields

FieldDescription
slotInventory slot (0–53). Also accepts a range like "0-8" to fill multiple slots.
nameButton display name. Supports & color codes and command placeholders.
materialVanilla Minecraft material (e.g. GRASS_BLOCK). Resolved with Material.match.
iconBentoBox ItemParser string (e.g. minecraft:diamond). Takes priority over material.
itemsadderItemsAdder custom item ID (e.g. iasurvival:ruby). Requires the ItemsAdder plugin.
descriptionLore lines shown under the button name. Supports & color codes, multi-line |, PlaceholderAPI %placeholders%, and [gamemode].
commandCommand run on left-click (and any click with no specific override). Supports placeholders.
right_click_commandCommand run on right-click or shift+right-click. Falls back to command if omitted.
shift_click_commandCommand run on shift+left-click. Falls back to command if omitted.

Click type summary

ClickCommand used
Left clickcommand
Right clickright_click_commandcommand
Shift + Right clickright_click_commandcommand
Shift + Left clickshift_click_commandcommand
Any other clickcommand

Command placeholders

PlaceholderReplaced with
[label]The gamemode's player command label (e.g. island, ob)
[player]The clicking player's username
[server]Runs the command as the server console instead of the player

Description placeholders

PlaceholderReplaced with
[gamemode]Lowercase gamemode name (e.g. bskyblock, aoneblock)
%PlaceholderAPI_placeholder%Any registered PlaceholderAPI placeholder

📄 Example Configuration

A complete, real-world example for an active BSkyBlock / AOneBlock server. It shows two panels — a default panel for all players and a VIP panel for donors — along with all button features.

panel-list:
# ── Default panel — shown to all players ──────────────────────────────────default:
defaultPanel: truepanelName: '&8&l⚙ &r&6&l Island Control Panel'permission: 'default'buttons:
# Row 0: decorative glass pane border"0-8":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── Navigation ────────────────────────────────────────────────────────9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Left-click: teleport to your island. &7 Right-click: go to your island nether. &7 Shift+click: set your home here. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'right_click_command: '[label] go nether'shift_click_command: '[label] sethome'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home &7 to your current location.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage &7 your island team.command: '[label] team'12:
name: '&d&l ✉ Invite'icon: minecraft:paperdescription: |- &7 Invite a player to &7 your island. &7 Usage: &f/[label] invite <player>command: '[label] invite'13:
name: '&6&l ⚙ Settings'icon: minecraft:anvildescription: |- &7 Configure your island &7 protection settings.command: '[label] settings'# ── Stats & Leaderboards ──────────────────────────────────────────────18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Calculate your island level. &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands &7 on this server.command: '[label] top'20:
name: '&a&l 🌿 Warps'icon: minecraft:ender_eyedescription: |- &7 Browse player warps.command: '[label] warps'21:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges &7 for great rewards!command: '[label] challenges'22:
name: '&b&l 🌊 Biomes'icon: minecraft:oak_saplingdescription: |- &7 Change the biome &7 on your island.command: '[label] biomes'# ── World / Utility ───────────────────────────────────────────────────27:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'28:
name: '&c&l 🛒 Shop'icon: minecraft:emeralddescription: |- &7 Open the server shop.command: 'shop'29:
name: '&e&l 💰 Balance'icon: minecraft:gold_nuggetdescription: |- &7 Check your current balance. &7 Balance: &6%vault_balance%command: 'balance'# Console command example — runs as server, not player35:
name: '&c&l 🔔 Report Bug'icon: minecraft:writable_bookdescription: |- &7 Report an issue to admins. &7 Opens a support ticket.command: '[server] ticket create [player] bug-report'# Row 5: decorative border"36-44":
name: ''material: BLACK_STAINED_GLASS_PANEdescription: ''command: ''# ── VIP panel — assigned via permission bskyblock.controlpanel.panel.vip ─vip:
defaultPanel: falsepanelName: '&8&l⚙ &r&d&l VIP Control Panel'permission: 'vip'buttons:
"0-8":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''9:
name: '&a&l 🏝 Go to Island'icon: minecraft:grass_blockdescription: |- &7 Teleport to your island. &7 Island level: &e%Level_[gamemode]_island_level%command: '[label] go'10:
name: '&e&l 🏠 Set Home'icon: minecraft:white_beddescription: |- &7 Set your island home.command: '[label] sethome'11:
name: '&b&l 👥 Team'icon: minecraft:player_headdescription: |- &7 View and manage your team.command: '[label] team'12:
name: '&5&l 🔮 Challenges'icon: minecraft:enchanting_tabledescription: |- &7 Complete challenges!command: '[label] challenges'# VIP exclusive — grants a kit via console13:
name: '&d&l 🎁 VIP Kit'icon: minecraft:chestdescription: |- &d VIP exclusive! &7 Claim your weekly VIP kit.command: '[server] kit vipweekly [player]'# VIP exclusive — ItemsAdder custom icon example14:
name: '&6&l ✨ VIP Perks'itemsadder: 'iasurvival:vip_star'description: |- &7 Browse all your VIP perks.command: 'vipperks'18:
name: '&e&l ⭐ Island Level'icon: minecraft:experience_bottledescription: |- &7 Current level: &e%Level_[gamemode]_island_level% &7 Current rank: &6%Level_[gamemode]_island_rank%command: '[label] level'19:
name: '&6&l 🏆 Top Islands'icon: minecraft:gold_blockdescription: |- &7 View the top 10 islands.command: '[label] top'20:
name: '&f&l 🌍 Spawn'icon: minecraft:bedrockdescription: |- &7 Teleport to world spawn.command: '[label] spawn'"36-44":
name: ''material: PURPLE_STAINED_GLASS_PANEdescription: ''command: ''

💡 Tips

  • Alternative clicks — add right_click_command and/or shift_click_command to a button to run different commands on right-click and shift+left-click. Omitting them falls back to command.
  • Slot layout — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
  • Slot ranges — use "0-8" (quoted) to place the same button across a range of slots. Great for border decorations.
  • Blank buttons — set command: '' and name: ' ' to create a visual spacer or border.
  • Console commands — prefix [server] to run a command silently as the console, e.g. for kits, economy rewards, or admin actions players wouldn't have permission to run directly.
  • Multiple panels — give a player the permission [gamemode].controlpanel.panel.<suffix> to show them a different panel. Handy for staff, donors, or ranked players.
  • ItemsAdder icons — use the itemsadder: key (instead of icon: or material:) to display a custom-textured item. Requires ItemsAdder to be installed; falls back gracefully if it isn't.
  • Reloading — after editing the YAML, run /{admin} cp import again to reload. Existing panels will be replaced after confirmation.

🌐 Information

More information can be found in the BentoBox Docs.

Need help? Join the BentoBox Discord.

About

Clickable GUI menu

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages