Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tastybento merged 25 commits into from
Apr 3, 2026
Merged

Release 1.16.0 #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
4c15a1b
Update README.md
tastybento Dec 21, 2024
a96d9a3
Fast implementation for allowing to define icon as item stack.
BONNe Mar 7, 2025
5cd588a
Add ItemsAdder dependencies
K0bus Apr 21, 2025
1941ae6
Add ItemsAdder parser
K0bus Apr 21, 2025
50c2a82
Check icon only if set in config
K0bus Apr 21, 2025
d167ac2
Change raw string to config getter
K0bus Apr 21, 2025
de4c07b
Implement ItemsAdder parser
K0bus Apr 21, 2025
624a4cd
Remove javadoc return on void method
K0bus Apr 21, 2025
fadc4c5
Simplify if
K0bus Apr 21, 2025
947f0fe
Remove redundant aggregator
K0bus Apr 21, 2025
7122953
Make variable as final
K0bus Apr 21, 2025
da3d0cd
Add readIntArray allowing to parse String list to int array
K0bus Apr 21, 2025
8648a02
Add string to int array parse to allow multiple slot in config key li…
K0bus Apr 21, 2025
afafce5
Merge pull request #33 from K0bus/develop
tastybento Apr 21, 2025
9c451ee
Update pom.xml for Java 21 and dependency changes
tastybento Apr 2, 2026
d94d419
Upgrade GitHub Actions to use latest versions
tastybento Apr 2, 2026
d7a4baf
Add JUnit 5 test suite with 97 tests covering all classes
tastybento Apr 2, 2026
9b4efc5
Merge pull request #34 from BentoBoxWorld/add-junit5-tests
tastybento Apr 2, 2026
8bd395c
Initial plan
Copilot Apr 2, 2026
b968b07
Add right_click_command and shift_click_command support for panel but…
Copilot Apr 2, 2026
95e8474
Address code review: clarify click type documentation
Copilot Apr 2, 2026
00eb108
Update README.md to enhance documentation and feature descriptions
tastybento Apr 2, 2026
3705bb6
Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles
tastybento Apr 2, 2026
6888a41
Update README.md to clarify command click types and add support for r…
tastybento Apr 2, 2026
e0d0d10
Revise compatibility and documentation references
tastybento Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
name: Build and analyze
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: Set up JDK 17
uses: actions/setup-java@v3
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
java-version: 17
java-version: 21
distribution: 'zulu' # Alternative distribution options are available.
- name: Cache SonarCloud packages
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
restore-keys: ${{ runner.os }}-sonar
- name: Cache Maven packages
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.m2
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
62 changes: 62 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading

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

Skip to content
Release 1.16.0#36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tastybento
merged 25 commits into

from

Apr 3, 2026
 Merged


Release 1.16.0
#36
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
4c15a1b

Update README.md


tastybento Dec 21, 2024
a96d9a3

Fast implementation for allowing to define icon as item stack.


BONNe Mar 7, 2025
5cd588a

Add ItemsAdder dependencies


K0bus Apr 21, 2025
1941ae6

Add ItemsAdder parser


K0bus Apr 21, 2025
50c2a82

Check icon only if set in config


K0bus Apr 21, 2025
d167ac2

Change raw string to config getter


K0bus Apr 21, 2025
de4c07b

Implement ItemsAdder parser


K0bus Apr 21, 2025
624a4cd

Remove javadoc return on void method


K0bus Apr 21, 2025
fadc4c5

Simplify if


K0bus Apr 21, 2025
947f0fe

Remove redundant aggregator


K0bus Apr 21, 2025
7122953

Make variable as final


K0bus Apr 21, 2025
da3d0cd

Add readIntArray allowing to parse String list to int array


K0bus Apr 21, 2025
8648a02

Add string to int array parse to allow multiple slot in config key li…


K0bus Apr 21, 2025
afafce5

Merge pull request #33 from K0bus/develop


tastybento Apr 21, 2025
9c451ee

Update pom.xml for Java 21 and dependency changes


tastybento Apr 2, 2026
d94d419

Upgrade GitHub Actions to use latest versions


tastybento Apr 2, 2026
d7a4baf

Add JUnit 5 test suite with 97 tests covering all classes


tastybento Apr 2, 2026
9b4efc5

Merge pull request #34 from BentoBoxWorld/add-junit5-tests


tastybento Apr 2, 2026
8bd395c

Initial plan


Copilot Apr 2, 2026
b968b07

Add right_click_command and shift_click_command support for panel but…


Copilot Apr 2, 2026
95e8474

Address code review: clarify click type documentation


Copilot Apr 2, 2026
00eb108

Update README.md to enhance documentation and feature descriptions


tastybento Apr 2, 2026
3705bb6

Merge pull request #35 from BentoBoxWorld/copilot/add-new-command-styles


tastybento Apr 2, 2026
6888a41

Update README.md to clarify command click types and add support for r…


tastybento Apr 2, 2026
e0d0d10

Revise compatibility and documentation references


tastybento Apr 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ jobs:
 name: Build and analyze
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: actions/checkout@v4
 with:
 fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 - name: Set up JDK 17
 uses: actions/setup-java@v3
 - name: Set up JDK 21
 uses: actions/setup-java@v4
 with:
 java-version: 17
 java-version: 21
 distribution: 'zulu' # Alternative distribution options are available.
 - name: Cache SonarCloud packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.sonar/cache
 key: ${{ runner.os }}-sonar
 restore-keys: ${{ runner.os }}-sonar
 - name: Cache Maven packages
 uses: actions/cache@v3
 uses: actions/cache@v4
 with:
 path: ~/.m2
 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
Expand All@@ -34,4 +34,4 @@ jobs:
 env:
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
 SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel
 run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_ControlPanel

62 changes: 62 additions & 0 deletions
CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

ControlPanel is a BentoBox addon for Minecraft (Paper) that provides customizable GUI menus for players to execute common commands. It supports multiple gamemodes (AcidIsland, BSkyBlock, CaveBlock, SkyGrid, AOneBlock) and 13 localizations.

## Build Commands

```bash
# Build the project
mvn clean package

# Run tests
mvn clean test

# Run tests and SonarCloud analysis (as CI does)
mvn -B verify

# Run a single test class
mvn test -Dtest=UtilsTest

# Build without tests
mvn clean package -DskipTests
```

**Requires Java 21.** The output JAR is placed in `target/`.

## Testing

Tests use **JUnit 5 + Mockito 5 + MockBukkit**. All integration tests extend `CommonTestSetup` which provides pre-configured mocks for BentoBox, Bukkit, Player, World, Island, and other framework objects.

Key test infrastructure in `src/test/java/world/bentobox/controlpanel/`:
- `CommonTestSetup.java` — abstract base class with `@BeforeEach`/`@AfterEach` lifecycle, static mocks for `Bukkit` and `Util`
- `WhiteBox.java` — reflection utility for setting private static fields (e.g., BentoBox singleton)
- `TestWorldSettings.java` — stub `WorldSettings` implementation for tests

For tests requiring database access, mock `DatabaseSetup` statically and use `WhiteBox.setInternalState(Database.class, "databaseSetup", dbSetup)` to inject the mock handler.

## Architecture

This is a **BentoBox Addon** — it extends BentoBox's `Addon` class and follows its lifecycle (`onLoad` → `onEnable` → `onReload` → `onDisable`).

**Entry point:** `ControlPanelAddon.java` — registers commands, loads settings, initializes the manager.

**Key flow:**
1. `ControlPanelAddon` hooks `PlayerCommand` and `AdminCommand` into each registered BentoBox gamemode's command tree
2. `ControlPanelManager` loads/saves `ControlPanelObject` data from YAML files and caches them per-world
3. `ControlPanelGenerator` builds the GUI using BentoBox's `PanelBuilder` API, resolving button actions, permissions, and placeholders (`[player]`, `[server]`, `[label]`)

**Data model:** `ControlPanelObject` (implements `DataObject`) represents a single control panel with its button layout. The manager parses the YAML template (`controlPanelTemplate.yml`) into these objects.

**Configuration:** `Settings.java` uses BentoBox's `@StoreAt`/`@ConfigEntry` annotations for YAML-backed config. The `config.yml` controls which gamemodes the addon is disabled for.

**Localization:** 13 locale YAML files in `src/main/resources/locales/`. Translation key constants are centralized in `Constants.java`.

**Optional integration:** `ItemsAdderParse.java` provides soft-dependency support for the ItemsAdder plugin's custom items.

## CI

GitHub Actions on push to `develop` and PRs: builds with Maven + runs SonarCloud analysis (project: `BentoBoxWorld_ControlPanel`).
Loading
Loading