Skip to content

feat: make donation panel size and layout configurable #420

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tastybento merged 4 commits into from
May 3, 2026
Merged

feat: make donation panel size and layout configurable #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0a33f85
feat: make donation panel size and layout configurable
tastybento May 2, 2026
633f2a7
fix: render decorative template items, respect template title, fix fo…
Copilot May 2, 2026
ec950e8
fix: simplify donation_panel template load error message
tastybento May 3, 2026
fc56085
refactor: address SonarCloud findings on donation panel
tastybento May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/java/world/bentobox/level/Level.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ public void onLoad() {
this.saveResource("panels/top_panel.yml", false);
this.saveResource("panels/detail_panel.yml", false);
this.saveResource("panels/value_panel.yml", false);
this.saveResource("panels/donation_panel.yml", false);
}

private boolean loadSettings() {
Expand Down
117 changes: 65 additions & 52 deletions src/main/java/world/bentobox/level/panels/DonationPanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
package world.bentobox.level.panels;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.bukkit.Bukkit;
import org.bukkit.Material;
Expand All @@ -23,6 +26,8 @@
import net.kyori.adventure.text.format.TextDecoration;

import world.bentobox.bentobox.api.localization.TextVariables;
import world.bentobox.bentobox.api.panels.reader.PanelTemplateRecord;
import world.bentobox.bentobox.api.panels.reader.TemplateReader;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.objects.Island;
import world.bentobox.bentobox.util.Util;
Expand All @@ -37,78 +42,89 @@
*/
public class DonationPanel implements Listener {

private static final int SIZE = 36; // 4 rows
private static final String TITLE_REF = "island.donate.gui-title";
private static final String POINTS_PLACEHOLDER = "[points]";

// Slot layout
private static final int INFO_SLOT = 4;
private static final int CANCEL_SLOT = 28;
private static final int PREVIEW_SLOT = 31;
private static final int CONFIRM_SLOT = 34;

// Donation slots: rows 2 and 3, columns 2-8 (slots 10-16, 19-25)
private static final int[] DONATION_SLOTS = {
10, 11, 12, 13, 14, 15, 16,
19, 20, 21, 22, 23, 24, 25
};

// Border slots: everything else
private static final Material BORDER_MATERIAL = Material.BLACK_STAINED_GLASS_PANE;

private final Level addon;
private final World world;
private final User user;
private final Island island;
private final Inventory inventory;
private final DonationPanelLayout layout;
private final Set<Integer> donationSlotSet;
private boolean confirmed = false;

private DonationPanel(Level addon, World world, User user, Island island) {
this.addon = addon;
this.world = world;
this.user = user;
this.island = island;
this.layout = loadLayout(addon);
this.donationSlotSet = HashSet.newHashSet(layout.donationSlots.length);
for (int s : layout.donationSlots) {
donationSlotSet.add(s);
}

// Create the inventory
// Create the inventory — use the title from the template (falls back to the
// default translation key when no template title is set).
Component title = removeDefaultItalic(
Util.parseMiniMessageOrLegacy(user.getTranslation(TITLE_REF)));
this.inventory = Bukkit.createInventory(null, SIZE, title);

// Fill borders
ItemStack border = createNamedItem(BORDER_MATERIAL, " ");
for (int i = 0; i < SIZE; i++) {
inventory.setItem(i, border);
Util.parseMiniMessageOrLegacy(user.getTranslation(layout.panelTitle)));
this.inventory = Bukkit.createInventory(null, layout.size, title);

// Fill borders if a border material is configured
if (layout.borderMaterial != null && layout.borderMaterial != Material.AIR) {
ItemStack border = createNamedItem(layout.borderMaterial, " ");
for (int i = 0; i < layout.size; i++) {
if (!donationSlotSet.contains(i)
&& i != layout.infoSlot && i != layout.cancelSlot
&& i != layout.previewSlot && i != layout.confirmSlot
&& !layout.decorativeItems.containsKey(i)) {
inventory.setItem(i, border);
}
Comment thread
tastybento marked this conversation as resolved.
}
}

// Clear donation slots
for (int slot : DONATION_SLOTS) {
inventory.setItem(slot, null);
}
// Place decorative items from the template (non-button, non-border entries)
layout.decorativeItems.forEach(inventory::setItem);

// Info pane
long currentDonated = addon.getManager().getDonatedPoints(island);
ItemStack info = createNamedItem(Material.BOOK,
ItemStack info = createNamedItem(layout.infoMaterial,
user.getTranslation("island.donate.gui-info",
POINTS_PLACEHOLDER, Utils.formatNumber(user, currentDonated)));
inventory.setItem(INFO_SLOT, info);
inventory.setItem(layout.infoSlot, info);

// Cancel button
ItemStack cancel = createNamedItem(Material.RED_STAINED_GLASS_PANE,
user.getTranslation("island.donate.cancel"));
inventory.setItem(CANCEL_SLOT, cancel);
String cancelKey = layout.cancelTitleOverride != null
? layout.cancelTitleOverride : "island.donate.cancel";
ItemStack cancel = createNamedItem(layout.cancelMaterial,
user.getTranslation(cancelKey));
inventory.setItem(layout.cancelSlot, cancel);

// Preview pane (starts at 0)
updatePreview();

// Confirm button
ItemStack confirm = createNamedItem(Material.LIME_STAINED_GLASS_PANE,
user.getTranslation("island.donate.confirm"));
inventory.setItem(CONFIRM_SLOT, confirm);
String confirmKey = layout.confirmTitleOverride != null
? layout.confirmTitleOverride : "island.donate.confirm";
ItemStack confirm = createNamedItem(layout.confirmMaterial,
user.getTranslation(confirmKey));
inventory.setItem(layout.confirmSlot, confirm);

// Register listener
Bukkit.getPluginManager().registerEvents(this, addon.getPlugin());
}

private static DonationPanelLayout loadLayout(Level addon) {
try {
File panelFolder = new File(addon.getDataFolder(), "panels");
PanelTemplateRecord template = TemplateReader.readTemplatePanel("donation_panel", panelFolder);
return DonationPanelLayout.fromTemplate(template);
} catch (Exception e) {
addon.logError("Could not load donation_panel template, using default layout.");
return DonationPanelLayout.defaults();
}
}

private void build() {
user.getPlayer().openInventory(inventory);
}
Expand All @@ -118,7 +134,7 @@ private void build() {
*/
private long calculateDonationValue() {
long total = 0;
for (int slot : DONATION_SLOTS) {
for (int slot : layout.donationSlots) {
ItemStack item = inventory.getItem(slot);
if (item != null && !item.getType().isAir()) {
Integer value = addon.getBlockConfig().getValue(world, item.getType());
Expand All @@ -135,20 +151,17 @@ private long calculateDonationValue() {
*/
private void updatePreview() {
long points = calculateDonationValue();
ItemStack preview = createNamedItem(Material.EXPERIENCE_BOTTLE,
ItemStack preview = createNamedItem(layout.previewMaterial,
user.getTranslation("island.donate.preview",
POINTS_PLACEHOLDER, Utils.formatNumber(user, points)));
inventory.setItem(PREVIEW_SLOT, preview);
inventory.setItem(layout.previewSlot, preview);
}

/**
* Check if a slot is a donation slot.
*/
private boolean isDonationSlot(int slot) {
for (int s : DONATION_SLOTS) {
if (s == slot) return true;
}
return false;
return donationSlotSet.contains(slot);
}

/**
Expand All @@ -160,7 +173,7 @@ private void processDonation() {
long totalPoints = 0;
Player player = user.getPlayer();

for (int slot : DONATION_SLOTS) {
for (int slot : layout.donationSlots) {
ItemStack item = inventory.getItem(slot);
if (item != null && !item.getType().isAir()) {
Material mat = item.getType();
Expand Down Expand Up @@ -199,7 +212,7 @@ private void processDonation() {
*/
private void returnItems() {
Player player = user.getPlayer();
for (int slot : DONATION_SLOTS) {
for (int slot : layout.donationSlots) {
ItemStack item = inventory.getItem(slot);
if (item != null && !item.getType().isAir()) {
Map<Integer, ItemStack> overflow = player.getInventory().addItem(item);
Expand All @@ -224,15 +237,15 @@ public void onInventoryClick(InventoryClickEvent event) {

int slot = event.getRawSlot();

if (slot >= SIZE) {
if (slot >= layout.size) {
handlePlayerInventoryClick(event);
return;
}
if (slot == CANCEL_SLOT) {
if (slot == layout.cancelSlot) {
handleCancel(event, player);
return;
}
if (slot == CONFIRM_SLOT) {
if (slot == layout.confirmSlot) {
handleConfirm(event, player);
return;
}
Expand Down Expand Up @@ -268,8 +281,8 @@ private void handlePlayerInventoryClick(InventoryClickEvent event) {
*/
private ItemStack distributeIntoDonationSlots(ItemStack remaining) {
int idx = 0;
while (idx < DONATION_SLOTS.length && remaining.getAmount() > 0) {
int ds = DONATION_SLOTS[idx];
while (idx < layout.donationSlots.length && remaining.getAmount() > 0) {
int ds = layout.donationSlots[idx];
ItemStack existing = inventory.getItem(ds);
if (existing == null || existing.getType().isAir()) {
inventory.setItem(ds, remaining.clone());
Expand Down Expand Up @@ -336,7 +349,7 @@ public void onInventoryDrag(InventoryDragEvent event) {
if (!event.getInventory().equals(inventory)) return;
// Only allow drags into donation slots
for (int slot : event.getRawSlots()) {
if (slot < SIZE && !isDonationSlot(slot)) {
if (slot < layout.size && !isDonationSlot(slot)) {
event.setCancelled(true);
return;
}
Expand Down
Loading
Loading