Release 1.16.1

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+# ControlPanel — .github/workflows/publish.yml
+# Publishes the jar attached to a GitHub release to CurseForge via the
+# shared BentoBoxWorld/.github reusable workflow. Downloads the release asset instead of
+# rebuilding from source. The reusable workflow is pinned to a commit SHA (Sonar
+# githubactions:S7637). workflow_dispatch lets you (re)publish a given version.
+
+name: Publish release to CurseForge
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ version:
+ description: "Version to publish (e.g. 1.2.3)"
+ required: true
+ type: string
+
+jobs:
+ publish:
+ uses: bentoboxworld/.github/.github/workflows/publish-platforms.yml@1f91a0edf72e8c86d671b3b8fdd3121ac6fb88e1 # master
+ with:
+ use_release_asset: "true" # publish the jar attached to the release; do not rebuild
+ hangar_slug: "" # blank = skip Hangar
+ curseforge_id: "1514827"
+ game_versions: "26.2,26.1.2,26.1.1,26.1,1.21.11,1.21.10,1.21.9,1.21.8,1.21.7,1.21.6,1.21.5"
+ version: ${{ inputs.version }} # empty on release events -> falls back to the release tag
+ secrets:
+ HANGAR_API_KEY: ${{ secrets.HANGAR_API_KEY }}
+ CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}

pom.xml

@@ -63,7 +63,7 @@
  <!-- Revision variable removes warning about dynamic version -->
  <revision>${build.version}-SNAPSHOT</revision>
  <!-- This allows to change between versions and snapshots. -->
- <build.version>1.16.0</build.version>
+ <build.version>1.16.1</build.version>
  <build.number>-LOCAL</build.number>
  <!-- Sonar Cloud -->
  <sonar.projectKey>BentoBoxWorld_ControlPanel</sonar.projectKey>
@@ -140,9 +140,9 @@
  <!-- Your addon must contain Paper and BentoBox APIs dependencies. -->
  <dependencies>
  <dependency>
- <groupId>com.github.MockBukkit</groupId>
- <artifactId>MockBukkit</artifactId>
- <version>v1.21-SNAPSHOT</version>
+ <groupId>org.mockbukkit.mockbukkit</groupId>
+ <artifactId>mockbukkit-v1.21</artifactId>
+ <version>4.110.0</version>
  <scope>test</scope>
  </dependency>
  <dependency>

src/main/java/world/bentobox/controlpanel/ControlPanelAddon.java

@@ -138,7 +138,19 @@ public void onReload()
  }
  else
  {
+ // Reload the database into cache first so wipe/re-import operate on a
+ // consistent view of what is currently stored.
  this.manager.reload();
+
+ // Re-import each active game mode's panels from controlPanelTemplate.yml so
+ // that admin edits to the template take effect on reload. Without this the
+ // panels stay pinned to whatever was first seeded into the database.
+ this.getPlugin().getAddonsManager().getGameModeAddons().forEach(gameModeAddon -> {
+ if (!this.settings.getDisabledGameModes().contains(gameModeAddon.getDescription().getName()))
+ {
+ this.manager.reimportControlPanels(gameModeAddon);
+ }
+ });
  }
 	}
 

src/main/java/world/bentobox/controlpanel/commands/admin/AdminCommand.java

@@ -127,9 +127,10 @@ public void setup()
  @Override
  public boolean execute(User user, String label, List<String> args)
  {
- ControlPanelManager manager = this.<ControlPanelAddon>getAddon().getAddonManager();
+ ControlPanelAddon addon = this.getAddon();
+ ControlPanelManager manager = addon.getAddonManager();
 
- String fileName = args.size() == 1 ? args.get(0) : "controlPanelTemplate.yml";
+ String fileName = args.size() == 1 ? args.get(0) : addon.getSettings().getTemplateFile();
 
  if (manager.hasAnyControlPanel(this.getWorld()))
  {

src/main/java/world/bentobox/controlpanel/config/Settings.java

@@ -52,6 +52,28 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	}
 
 
+	/**
+ * This method returns the templateFile value.
+ *
+ * @return the value of templateFile.
+ */
+	public String getTemplateFile()
+	{
+ return templateFile;
+	}
+
+
+	/**
+ * This method sets the templateFile value.
+ *
+ * @param templateFile the templateFile new value.
+ */
+	public void setTemplateFile(String templateFile)
+	{
+ this.templateFile = templateFile;
+	}
+
+
 // ---------------------------------------------------------------------
 // Section: Variables
 // ---------------------------------------------------------------------
@@ -64,4 +86,12 @@ public void setDisabledGameModes(Set<String> disabledGameModes)
 	@ConfigComment(" - BSkyBlock")
 	@ConfigEntry(path = "disabled-gamemodes")
 	private Set<String> disabledGameModes = new HashSet<>();
+
+	@ConfigComment("")
+	@ConfigComment("The template file that control panels are imported from.")
+	@ConfigComment("This file is read when panels are first seeded and re-read on every reload,")
+	@ConfigComment("so editing it and running 'bbox reload' will apply your changes.")
+	@ConfigComment("It must exist in the addon folder (addons/ControlPanel).")
+	@ConfigEntry(path = "template-file")
+	private String templateFile = "controlPanelTemplate.yml";
 }

src/main/java/world/bentobox/controlpanel/managers/ControlPanelManager.java

@@ -55,7 +55,8 @@ public ControlPanelManager(ControlPanelAddon addon)
  {
  this.addon = addon;
 
- // save template file into directory.
+ // Save the default template file into the directory. The configured template file
+ // may point elsewhere, but the packaged default is always named controlPanelTemplate.yml.
  if (!new File(this.addon.getDataFolder(), "controlPanelTemplate.yml").exists())
  {
  this.addon.saveResource("controlPanelTemplate.yml", false);
@@ -128,6 +129,26 @@ public void reload()
  }
 
 
+ /**
+ * This method re-imports the control panels for the given game mode from the
+ * template file configured via {@code template-file} in config.yml (defaults to
+ * {@code controlPanelTemplate.yml}), replacing whatever is currently stored in the
+ * database and cache.
+ * <p>
+ * This is what makes edits to the template file take effect on {@code bbox reload}:
+ * without it, {@link #reload()} only re-reads the database and template changes are
+ * silently ignored.
+ *
+ * @param gameModeAddon Game mode whose panels must be re-imported from the template.
+ */
+ public void reimportControlPanels(@NotNull GameModeAddon gameModeAddon)
+ {
+ // Clear existing data so removed/renamed panels do not linger, then re-read the template.
+ this.wipeData(gameModeAddon, null);
+ this.importControlPanels(null, gameModeAddon);
+ }
+
+
  // ---------------------------------------------------------------------
  // Section: Save methods
  // ---------------------------------------------------------------------
@@ -226,7 +247,7 @@ public void importControlPanels(@Nullable User user, @NotNull World world, @NotN
  */
  public void importControlPanels(@Nullable User user, @NotNull GameModeAddon addon)
  {
- this.importControlPanels(user, addon, "controlPanelTemplate");
+ this.importControlPanels(user, addon, this.addon.getSettings().getTemplateFile());
  }
 
 

src/main/resources/addon.yml

@@ -12,7 +12,7 @@ repository: 'BentoBoxWorld/ControlPanel'
 # Must use Material.values() with uppercase.
 icon: 'COMMAND_BLOCK'
 # Minimum BentoBox API version
-api-version: 3.10.0
+api-version: 2.7.1
 
 # List of addon authors.
 authors:

src/main/resources/config.yml

@@ -5,3 +5,9 @@
 # disabled-gamemodes:
 # - BSkyBlock
 disabled-gamemodes: []
+#
+# The template file that control panels are imported from.
+# This file is read when panels are first seeded and re-read on every reload,
+# so editing it and running 'bbox reload' will apply your changes.
+# It must exist in the addon folder (addons/ControlPanel).
+template-file: controlPanelTemplate.yml

src/main/resources/locales/zh-TW.yml

@@ -1,23 +1,21 @@
----
 controlpanel:
  messages:
- import-count: 導入 [number] 控制面板
- control-panels-wiped: "&2 所有為 [gamemode] 模式的控制面板已移除"
+ import-count: 已匯入 [number] 個控制面板。
+ control-panels-wiped: '&2已移除 [gamemode] 的所有控制面板。'
  errors:
- no-load: "&4 無法讀取 [file] 原因: [message]"
- no-file: "&4 遺失 [file] 檔案"
-no-valid-panels: "&4 未發現任何可用的控制面板"
- no-valid-panels-op: "&4 未發現任何可用的控制面板. 你應該試著去導入他 請使用 /[admin] cp import"
-not-a-gamemode-world: "&4 未發現任何有效的模式"
+ no-load: '&4無法載入檔案 [file]：[message]'
+ no-file: '&4找不到檔案 [file]。'
+not-a-gamemode-world: '&4找不到有效的遊戲模式。'
+ no-valid-panels: '&4找不到任何有效的控制面板。'
+no-valid-panels-op: '&4找不到任何有效的控制面板。請嘗試使用 /[admin] cp import 匯入。'
  commands:
  admin:
  help:
- description: '顯示管理員幫助指令
-
-'
+ description: 顯示管理員說明指令。
  import:
- parameters: "[file-name] - 要導入的檔案的名子. 檔案為空 所以我們將創建 一般面板."
- description: 導入控制面板從 [file]
- confirmation: 請確認您要從 [gamemode] 中刪除現有控制面板，並從 [file] 中導入控制面板
+ parameters: '[file-name] - 要匯入的檔案名稱。留空則匯入預設範本。'
+ description: 從 [file] 匯入控制面板。
+ confirmation: 請確認是否要移除 [gamemode] 目前的控制面板，並從 [file] 匯入新的控制面板。
  help:
- description: 開啟控制面板
+ parameters: ''
+ description: 開啟控制面板。

src/test/java/world/bentobox/controlpanel/config/SettingsTest.java

@@ -35,4 +35,15 @@ void testSetDisabledGameModes() {
  assertTrue(settings.getDisabledGameModes().contains("BSkyBlock"));
  assertTrue(settings.getDisabledGameModes().contains("AcidIsland"));
  }
+
+ @Test
+ void testDefaultTemplateFile() {
+ assertEquals("controlPanelTemplate.yml", settings.getTemplateFile());
+ }
+
+ @Test
+ void testSetTemplateFile() {
+ settings.setTemplateFile("myPanels.yml");
+ assertEquals("myPanels.yml", settings.getTemplateFile());
+ }
 }

src/test/java/world/bentobox/controlpanel/managers/ControlPanelManagerTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
 
  when(addon.getPlugin()).thenReturn(plugin);
  when(addon.getLogger()).thenReturn(Logger.getAnonymousLogger());
+ when(addon.getSettings()).thenReturn(new world.bentobox.controlpanel.config.Settings());
 
  File dataFolder = new File("addons/ControlPanel");
  dataFolder.mkdirs();
@@ -260,6 +261,96 @@ void testReload() {
  manager.reload();
  }
 
+ @Test
+ void testReimportControlPanelsReadsTemplateFile() throws Exception {
+ // Make import's trailing getAddonManager().save() call resolve to this manager.
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Write a template file that reimport should read from disk.
+ writeTemplate("""
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Template'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ // Template panel is now in the cache.
+ assertTrue(manager.hasAnyControlPanel(world));
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Template", panel.getPanelName());
+ }
+
+ @Test
+ void testReimportControlPanelsRemovesDeletedPanels() throws Exception {
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // Seed the cache with an existing panel, as if previously stored in the database.
+ when(handler.loadObjects()).thenReturn(Collections.singletonList(createDefaultPanel()));
+ manager.reload();
+ assertTrue(manager.hasAnyControlPanel(world));
+
+ // A template with no panel-list entries should wipe the stored panel on reimport.
+ writeTemplate("panel-list: {}\n");
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ assertFalse(manager.hasAnyControlPanel(world));
+ }
+
+ @Test
+ void testReimportControlPanelsUsesConfiguredTemplateFile() throws Exception {
+ // Point the config at a custom template file name.
+ world.bentobox.controlpanel.config.Settings settings =
+ new world.bentobox.controlpanel.config.Settings();
+ settings.setTemplateFile("customPanels.yml");
+ when(addon.getSettings()).thenReturn(settings);
+ when(addon.getAddonManager()).thenReturn(manager);
+
+ // The default template exists but is empty; only the custom file has a panel.
+ writeTemplate("panel-list: {}\n");
+ writeNamedTemplate("customPanels.yml", """
+ panel-list:
+ default:
+ defaultPanel: true
+ panelName: 'From Custom File'
+ permission: 'default'
+ buttons:
+ 0:
+ name: 'Island'
+ material: GRASS_BLOCK
+ description: 'Go to your island'
+ command: '[label] go'
+ """);
+
+ GameModeAddon gameModeAddon = mock(GameModeAddon.class);
+ manager.reimportControlPanels(gameModeAddon);
+
+ ControlPanelObject panel = manager.getUserControlPanel(User.getInstance(mockPlayer), world, "bskyblock.");
+ assertNotNull(panel);
+ assertEquals("From Custom File", panel.getPanelName());
+ }
+
+ private void writeTemplate(String content) throws Exception {
+ writeNamedTemplate("controlPanelTemplate.yml", content);
+ }
+
+ private void writeNamedTemplate(String name, String content) throws Exception {
+ File templateFile = new File(new File("addons/ControlPanel"), name);
+ java.nio.file.Files.writeString(templateFile.toPath(), content);
+ }
+
  private ControlPanelObject createDefaultPanel() {
  ControlPanelObject cpo = new ControlPanelObject();
  cpo.setUniqueId("BSkyBlock_default");