Skip to content

Add parcel fees #144

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

Open
Jakubk15 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add parcel fees #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbe51ed
Add economy dependency
Jakubk15 Nov 15, 2025
32cd596
Add parcel fees
Jakubk15 Nov 15, 2025
d292262
Merge branch 'master' into parcel-fees
Jakubk15 Nov 23, 2025
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
26 changes: 20 additions & 6 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import net.minecrell.pluginyml.paper.PaperPluginDescription

plugins {
`java-library`
id("de.eldoria.plugin-yml.paper") version "0.8.0"
Expand All @@ -10,12 +12,13 @@ version = "0.0.2-SNAPSHOT"

repositories {
gradlePluginPortal()
maven { url = uri("https://maven-central.storage-download.googleapis.com/maven2/")}
maven("https://maven-central.storage-download.googleapis.com/maven2/") // maven central mirror
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability and to adhere to Gradle best practices, it's recommended to use the mavenCentral() method instead of a hardcoded URL for the Maven Central repository.

    mavenCentral()


maven { url = uri("https://repo.triumphteam.dev/snapshots/")}
maven { url = uri("https://repo.papermc.io/repository/maven-public/") }
maven { url = uri("https://repo.eternalcode.pl/releases") }
maven { url = uri("https://storehouse.okaeri.eu/repository/maven-public/") }
maven("https://repo.triumphteam.dev/snapshots/")
maven("https://jitpack.io")
maven("https://repo.papermc.io/repository/maven-public/")
maven("https://repo.eternalcode.pl/releases")
maven("https://storehouse.okaeri.eu/repository/maven-public/")
}

dependencies {
Expand Down Expand Up @@ -73,6 +76,9 @@ dependencies {
// caffeine
paperLibrary("com.github.ben-manes.caffeine:caffeine:3.2.3")

// vault
compileOnly("com.github.MilkBowl:VaultAPI:1.7.1")

testImplementation("org.junit.jupiter:junit-jupiter-api:6.0.1")
testImplementation("org.junit.jupiter:junit-jupiter-params:6.0.1")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:6.0.1")
Expand All @@ -98,6 +104,12 @@ paper {
loader = "com.eternalcode.parcellockers.ParcelLockersLibraryLoader"
generateLibrariesJson = true
foliaSupported = false
serverDependencies {
register("Vault") {
required = true
load = PaperPluginDescription.RelativeLoadOrder.BEFORE
}
}
}

tasks.withType<JavaCompile> {
Expand All @@ -110,7 +122,9 @@ tasks.withType<JavaCompile> {
tasks {
runServer {
minecraftVersion("1.21.10")
downloadPlugins.modrinth("luckperms", "v5.5.0-bukkit")
downloadPlugins.modrinth("luckperms", "v5.5.17-bukkit")
downloadPlugins.modrinth("vaultunlocked", "2.17.0")
// TODO add eternaleconomy
}

test {
Expand Down
21 changes: 21 additions & 0 deletions src/main/java/com/eternalcode/parcellockers/ParcelLockers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,19 @@
import java.util.ArrayList;
import java.util.stream.Stream;
import net.kyori.adventure.text.minimessage.MiniMessage;
import net.milkbowl.vault.economy.Economy;
import org.bstats.bukkit.Metrics;
import org.bukkit.Server;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.RegisteredServiceProvider;
import org.bukkit.plugin.java.JavaPlugin;

public final class ParcelLockers extends JavaPlugin {

private LiteCommands<CommandSender> liteCommands;
private SkullAPI skullAPI;
private DatabaseManager databaseManager;
private Economy economy;

@Override
public void onEnable() {
Expand All @@ -84,6 +87,12 @@ public void onEnable() {
NoticeService noticeService = new NoticeService(messageConfig, miniMessage);
Scheduler scheduler = new BukkitSchedulerImpl(this);

if (!this.setupEconomy()) {
this.getLogger().severe("No economy provider registered! Disabling...");
server.getPluginManager().disablePlugin(this);
return;
}
Comment on lines +90 to +94
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The instantiation of ParcelServiceImpl in ParcelLockers.java was not updated to match the new constructor signature. This will cause a compilation error. You need to pass the config and economy instances when creating ParcelService.

I am commenting here as this is the closest related change, but the actual fix is in ParcelLockers.java at line 123.


DatabaseManager databaseManager = new DatabaseManager(config, this.getLogger(), this.getDataFolder());
this.databaseManager = databaseManager;

Expand Down Expand Up @@ -207,6 +216,18 @@ public void onDisable() {
this.skullAPI.shutdown();
}
}

private boolean setupEconomy() {
if (this.getServer().getPluginManager().getPlugin("Vault") == null) {
return false;
}
RegisteredServiceProvider<Economy> rsp = this.getServer().getServicesManager().getRegistration(Economy.class);
if (rsp == null) {
return false;
}
this.economy = rsp.getProvider();
return this.economy != null;
}
}


8 changes: 8 additions & 0 deletions src/main/java/com/eternalcode/parcellockers/configuration/implementation/MessageConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ public static class ParcelMessages extends OkaeriConfig {
.chat("&2✔ &aParcel deleted successfully.")
.sound(Sound.ENTITY_ITEM_BREAK.key())
.build();
public Notice insufficientFunds = Notice.builder()
.chat("&4✘ &cYou do not have enough funds to send this parcel! Required: &6${AMOUNT}&c.")
.sound(Sound.ENTITY_VILLAGER_NO.key())
.build();
public Notice feeWithdrawn = Notice.builder()
.chat("&2✔ &a${AMOUNT} has been withdrawn from your account to cover the parcel sending fee.")
.sound(Sound.ENTITY_EXPERIENCE_ORB_PICKUP.key())
.build();

@Comment({"", "# The parcel info message." })
public Notice parcelInfoMessages = Notice.builder()
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/com/eternalcode/parcellockers/configuration/implementation/PluginConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ public static class Settings extends OkaeriConfig {

@Comment({"", "# Maximum number of parcels that can be stored in a single locker"})
public int maxParcelsPerLocker = 30;

@Comment({"", "# Small parcel fee in in-game currency"})
public double smallParcelFee = 10.0;

@Comment({"", "# Medium parcel fee in in-game currency"})
public double mediumParcelFee = 25.0;

@Comment({"", "# Large parcel fee in in-game currency"})
public double largeParcelFee = 50.0;
}

public static class GuiSettings extends OkaeriConfig {
Expand Down
36 changes: 35 additions & 1 deletion src/main/java/com/eternalcode/parcellockers/parcel/ParcelServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import com.eternalcode.commons.bukkit.ItemUtil;
import com.eternalcode.commons.scheduler.Scheduler;
import com.eternalcode.parcellockers.configuration.implementation.PluginConfig;
import com.eternalcode.parcellockers.content.ParcelContent;
import com.eternalcode.parcellockers.content.repository.ParcelContentRepository;
import com.eternalcode.parcellockers.notification.NoticeService;
Expand All @@ -19,16 +20,21 @@
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import net.milkbowl.vault.economy.Economy;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;

public class ParcelServiceImpl implements ParcelService {

private static final String PARCEL_FEE_BYPASS_PERMISSION = "parcellockers.fee.bypass";

private final NoticeService noticeService;
private final ParcelRepository parcelRepository;
private final ParcelContentRepository parcelContentRepository;
private final Scheduler scheduler;
private final PluginConfig config;
private final Economy economy;

private final Cache<UUID, Parcel> parcelsByUuid;
private final Cache<UUID, List<Parcel>> parcelsBySender;
Expand All @@ -38,12 +44,14 @@ public ParcelServiceImpl(
NoticeService noticeService,
ParcelRepository parcelRepository,
ParcelContentRepository parcelContentRepository,
Scheduler scheduler
Scheduler scheduler, PluginConfig config, Economy economy
) {
Comment on lines 44 to 48
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The constructor signature has been updated. This is a breaking change, and the call site in ParcelLockers.java where ParcelServiceImpl is instantiated has not been updated to reflect this. This will cause a compilation error. Please update the instantiation to pass the new config and economy arguments.

Example fix in ParcelLockers.java:

// ...
ParcelService parcelService = new ParcelServiceImpl(
    noticeService,
    parcelRepository,
    parcelContentRepository,
    scheduler,
    config, // add this
    this.economy // add this
);
// ...

this.noticeService = noticeService;
this.parcelRepository = parcelRepository;
this.parcelContentRepository = parcelContentRepository;
this.scheduler = scheduler;
this.config = config;
this.economy = economy;

this.parcelsByUuid = Caffeine.newBuilder()
.expireAfterAccess(3, TimeUnit.HOURS)
Expand All @@ -65,6 +73,32 @@ public ParcelServiceImpl(

@Override
public CompletableFuture<Void> send(Player sender, Parcel parcel, List<ItemStack> items) {
if (!sender.hasPermission(PARCEL_FEE_BYPASS_PERMISSION)) {
double fee = switch (parcel.size()) {
case SMALL -> this.config.settings.smallParcelFee;
case MEDIUM -> this.config.settings.mediumParcelFee;
case LARGE -> this.config.settings.largeParcelFee;
};

if (fee > 0) {
boolean success = this.economy.withdrawPlayer(sender, fee).transactionSuccess();
if (!success) {
this.noticeService.create()
.notice(messages -> messages.parcel.insufficientFunds)
.player(sender.getUniqueId())
.placeholder("{AMOUNT}", String.format("%.2f", fee))
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using String.format without a Locale can lead to incorrect formatting on systems with different locale settings (e.g., using a comma as a decimal separator instead of a period). This can cause issues with how the fee is displayed. It's safer to specify a fixed locale, like java.util.Locale.US, to ensure consistent formatting.

Suggested change
.placeholder("{AMOUNT}", String.format("%.2f", fee))
.placeholder("{AMOUNT}", String.format(java.util.Locale.US, "%.2f", fee))

.send();
return CompletableFuture.completedFuture(null);
}

this.noticeService.create()
.notice(messages -> messages.parcel.feeWithdrawn)
.player(sender.getUniqueId())
.placeholder("{AMOUNT}", String.format("%.2f", fee))
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using String.format without a Locale can lead to incorrect formatting on systems with different locale settings (e.g., using a comma as a decimal separator instead of a period). This can cause issues with how the fee is displayed. It's safer to specify a fixed locale, like java.util.Locale.US, to ensure consistent formatting.

Suggested change
.placeholder("{AMOUNT}", String.format("%.2f", fee))
.placeholder("{AMOUNT}", String.format(java.util.Locale.US, "%.2f", fee))

.send();
}
}

return this.parcelRepository.save(parcel).whenComplete((unused, throwable) -> {
if (throwable != null) {
this.noticeService.create()
Expand Down
Loading