From 12f7aa2de5290e37ff417d29b7b95ba72c00d0d9 Mon Sep 17 00:00:00 2001 From: Carson Fleming Date: Mon, 30 Jun 2025 20:09:33 -0400 Subject: Initial project with repair, enchant, fireball, fly, and powertool --- .../java/net/cflems/mc/sandbox/CommandUtils.java | 14 ++++ .../cflems/mc/sandbox/PlayerTargetedCommand.java | 88 +++++++++++++++++++++ src/main/java/net/cflems/mc/sandbox/Sandbox.java | 25 ++++++ .../net/cflems/mc/sandbox/commands/Enchant.java | 55 +++++++++++++ .../net/cflems/mc/sandbox/commands/Fireball.java | 29 +++++++ .../java/net/cflems/mc/sandbox/commands/Fly.java | 32 ++++++++ .../net/cflems/mc/sandbox/commands/PowerTool.java | 63 +++++++++++++++ .../net/cflems/mc/sandbox/commands/Repair.java | 36 +++++++++ .../mc/sandbox/listeners/PowerToolListener.java | 42 ++++++++++ .../cflems/mc/sandbox/storage/NoMetaException.java | 3 + .../cflems/mc/sandbox/storage/PowerToolStore.java | 91 ++++++++++++++++++++++ 11 files changed, 478 insertions(+) create mode 100644 src/main/java/net/cflems/mc/sandbox/CommandUtils.java create mode 100644 src/main/java/net/cflems/mc/sandbox/PlayerTargetedCommand.java create mode 100644 src/main/java/net/cflems/mc/sandbox/Sandbox.java create mode 100644 src/main/java/net/cflems/mc/sandbox/commands/Enchant.java create mode 100644 src/main/java/net/cflems/mc/sandbox/commands/Fireball.java create mode 100644 src/main/java/net/cflems/mc/sandbox/commands/Fly.java create mode 100644 src/main/java/net/cflems/mc/sandbox/commands/PowerTool.java create mode 100644 src/main/java/net/cflems/mc/sandbox/commands/Repair.java create mode 100644 src/main/java/net/cflems/mc/sandbox/listeners/PowerToolListener.java create mode 100644 src/main/java/net/cflems/mc/sandbox/storage/NoMetaException.java create mode 100644 src/main/java/net/cflems/mc/sandbox/storage/PowerToolStore.java (limited to 'src/main/java/net') diff --git a/src/main/java/net/cflems/mc/sandbox/CommandUtils.java b/src/main/java/net/cflems/mc/sandbox/CommandUtils.java new file mode 100644 index 0000000..a954c5b --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/CommandUtils.java @@ -0,0 +1,14 @@ +package net.cflems.mc.sandbox; + +import org.bukkit.ChatColor; +import org.bukkit.command.CommandSender; + +public final class CommandUtils { + private static final String RESPONSE_PREFIX = ChatColor.GOLD + "[Sandbox] " + ChatColor.RESET; + + private CommandUtils() {} + + public static void respond(CommandSender sender, String message) { + sender.sendMessage(RESPONSE_PREFIX + message); + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/PlayerTargetedCommand.java b/src/main/java/net/cflems/mc/sandbox/PlayerTargetedCommand.java new file mode 100644 index 0000000..8a553bc --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/PlayerTargetedCommand.java @@ -0,0 +1,88 @@ +package net.cflems.mc.sandbox; + +import com.google.errorprone.annotations.CompileTimeConstant; +import java.util.Arrays; +import java.util.function.Consumer; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.Player; + +public abstract class PlayerTargetedCommand implements CommandExecutor { + private final int minArgs; + private final int maxArgs; + private final String permission; + private final String permissionMessage; + private final String othersPermission; + private final String othersPermissionMessage; + + protected PlayerTargetedCommand( + int minArgs, + int maxArgs, + @CompileTimeConstant String permission, + String permissionMessage, + String othersPermissionMessage) { + this( + minArgs, + maxArgs, + permission, + permission + ".others", + permissionMessage, + othersPermissionMessage); + } + + protected PlayerTargetedCommand( + int minArgs, + int maxArgs, + @CompileTimeConstant String permission, + @CompileTimeConstant String othersPermission, + String permissionMessage, + String othersPermissionMessage) { + this.minArgs = minArgs; + this.maxArgs = maxArgs + 1; + this.permission = permission; + this.othersPermission = othersPermission; + this.permissionMessage = permissionMessage; + this.othersPermissionMessage = othersPermissionMessage; + } + + @SuppressWarnings("NullableProblems") + @Override + public final boolean onCommand( + CommandSender sender, org.bukkit.command.Command _command, String label, String[] args) { + if (!sender.hasPermission(permission)) { + CommandUtils.respond(sender, permissionMessage); + return true; + } + int numArgs = args.length; + if (numArgs < minArgs || numArgs > maxArgs) return false; + + Player player; + if (sender instanceof Player sendingPlayer && numArgs < maxArgs) { + player = sendingPlayer; + } else if (numArgs == maxArgs) { + player = sender.getServer().getPlayer(args[--numArgs]); + if (player == null) { + CommandUtils.respond( + sender, "Specified player not found, make sure to refer to them by name."); + return true; + } + if (player != sender && !sender.hasPermission(othersPermission)) { + CommandUtils.respond(sender, othersPermissionMessage); + return true; + } + } else { + CommandUtils.respond( + sender, "When executed from the console, a player must be explicitly specified."); + return true; + } + + return execute( + player, + label, + args.length > numArgs ? Arrays.copyOfRange(args, 0, numArgs) : args, + msg -> CommandUtils.respond(sender, msg)); + } + + protected abstract boolean execute( + Player player, String label, String[] args, Consumer respond); +} diff --git a/src/main/java/net/cflems/mc/sandbox/Sandbox.java b/src/main/java/net/cflems/mc/sandbox/Sandbox.java new file mode 100644 index 0000000..34127f1 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/Sandbox.java @@ -0,0 +1,25 @@ +package net.cflems.mc.sandbox; + +import net.cflems.mc.sandbox.commands.Enchant; +import net.cflems.mc.sandbox.commands.Fireball; +import net.cflems.mc.sandbox.commands.Fly; +import net.cflems.mc.sandbox.commands.PowerTool; +import net.cflems.mc.sandbox.commands.Repair; +import net.cflems.mc.sandbox.listeners.PowerToolListener; +import net.cflems.mc.sandbox.storage.PowerToolStore; +import org.bukkit.plugin.java.JavaPlugin; + +public class Sandbox extends JavaPlugin { + public static final String PERMISSION_NAMESPACE = "sandbox"; + + @Override + public void onEnable() { + PowerToolStore powerToolStore = new PowerToolStore(getDataFolder()); + getServer().getPluginManager().registerEvents(new PowerToolListener(powerToolStore), this); + this.getCommand("enchant").setExecutor(new Enchant()); + this.getCommand("fly").setExecutor(new Fly()); + this.getCommand("repair").setExecutor(new Repair()); + this.getCommand("fireball").setExecutor(new Fireball()); + this.getCommand("powertool").setExecutor(new PowerTool(powerToolStore)); + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/commands/Enchant.java b/src/main/java/net/cflems/mc/sandbox/commands/Enchant.java new file mode 100644 index 0000000..66ea806 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/commands/Enchant.java @@ -0,0 +1,55 @@ +package net.cflems.mc.sandbox.commands; + +import java.util.Locale; +import java.util.function.Consumer; +import net.cflems.mc.sandbox.PlayerTargetedCommand; +import net.cflems.mc.sandbox.Sandbox; +import org.bukkit.NamespacedKey; +import org.bukkit.Registry; +import org.bukkit.enchantments.Enchantment; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; + +public final class Enchant extends PlayerTargetedCommand { + private static final int MIN_ARGS = 1; + private static final int MAX_ARGS = 2; + private static final String PERMISSION = Sandbox.PERMISSION_NAMESPACE + ".enchant"; + private static final String PERMISSION_MESSAGE = "You do not have permission to enchant items."; + private static final String OTHERS_PERMISSION_MESSAGE = + "You do not have permission to enchant other people's items."; + + public Enchant() { + super(MIN_ARGS, MAX_ARGS, PERMISSION, PERMISSION_MESSAGE, OTHERS_PERMISSION_MESSAGE); + } + + @Override + protected boolean execute(Player player, String _label, String[] args, Consumer respond) { + NamespacedKey enchantmentKey = NamespacedKey.fromString(args[0].toLowerCase(Locale.ROOT)); + Enchantment enchantment = + enchantmentKey != null ? Registry.ENCHANTMENT.get(enchantmentKey) : null; + if (enchantment == null) { + respond.accept("No such enchantment was found."); + return true; + } + + int level; + if (args.length < 2) level = 1; + else { + try { + level = Integer.parseInt(args[1]); + } catch (NumberFormatException _e) { + level = -1; + } + if (level < 0 || level > 255) { + respond.accept("Level must be a valid integer between 0 and 255."); + return true; + } + } + + ItemStack mhItem = player.getInventory().getItemInMainHand(); + if (level > 0) mhItem.addUnsafeEnchantment(enchantment, level); + else mhItem.removeEnchantment(enchantment); + respond.accept("Item enchanted successfully."); + return true; + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/commands/Fireball.java b/src/main/java/net/cflems/mc/sandbox/commands/Fireball.java new file mode 100644 index 0000000..47f5e0c --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/commands/Fireball.java @@ -0,0 +1,29 @@ +package net.cflems.mc.sandbox.commands; + +import net.cflems.mc.sandbox.CommandUtils; +import net.cflems.mc.sandbox.Sandbox; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.EntityType; +import org.bukkit.entity.Player; + +public final class Fireball implements CommandExecutor { + private static final String PERMISSION = Sandbox.PERMISSION_NAMESPACE + ".fireball"; + + @SuppressWarnings("NullableProblems") + @Override + public boolean onCommand( + CommandSender sender, org.bukkit.command.Command _command, String _label, String[] args) { + if (args.length > 0) return false; + if (!(sender instanceof Player player)) { + CommandUtils.respond(sender, "Only players can use fireballs."); + return true; + } + if (!sender.hasPermission(PERMISSION)) { + CommandUtils.respond(sender, "You do not have permission to use fireballs."); + return true; + } + player.getWorld().spawnEntity(player.getEyeLocation().subtract(0, 1, 0), EntityType.FIREBALL); + return true; + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/commands/Fly.java b/src/main/java/net/cflems/mc/sandbox/commands/Fly.java new file mode 100644 index 0000000..9e4a9bc --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/commands/Fly.java @@ -0,0 +1,32 @@ +package net.cflems.mc.sandbox.commands; + +import java.util.function.Consumer; +import net.cflems.mc.sandbox.PlayerTargetedCommand; +import net.cflems.mc.sandbox.Sandbox; +import org.bukkit.entity.Player; + +public final class Fly extends PlayerTargetedCommand { + private static final int MIN_ARGS = 0; + private static final int MAX_ARGS = 0; + private static final String PERMISSION = Sandbox.PERMISSION_NAMESPACE + ".fly"; + private static final String PERMISSION_MESSAGE = "You do not have permission to toggle flight."; + private static final String OTHERS_PERMISSION_MESSAGE = + "You do not have permission to toggle other people's flight."; + + public Fly() { + super(MIN_ARGS, MAX_ARGS, PERMISSION, PERMISSION_MESSAGE, OTHERS_PERMISSION_MESSAGE); + } + + @Override + protected boolean execute(Player player, String _label, String[] args, Consumer respond) { + boolean allow = !player.getAllowFlight(); + player.setAllowFlight(allow); + respond.accept( + "Flight is now " + + (allow ? "\u00a72ENABLED\u00a7r" : "\u00a74DISABLED\u00a7r") + + " for " + + player.getName() + + "."); + return true; + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/commands/PowerTool.java b/src/main/java/net/cflems/mc/sandbox/commands/PowerTool.java new file mode 100644 index 0000000..e4683f6 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/commands/PowerTool.java @@ -0,0 +1,63 @@ +package net.cflems.mc.sandbox.commands; + +import net.cflems.mc.sandbox.CommandUtils; +import net.cflems.mc.sandbox.Sandbox; +import net.cflems.mc.sandbox.storage.NoMetaException; +import net.cflems.mc.sandbox.storage.PowerToolStore; +import org.bukkit.command.Command; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; + +public final class PowerTool implements CommandExecutor { + private static final String PERMISSION = Sandbox.PERMISSION_NAMESPACE + ".powertool"; + private static final String RELOAD_PERMISSION = PERMISSION + ".reload"; + + private final PowerToolStore store; + + public PowerTool(PowerToolStore store) { + this.store = store; + } + + @SuppressWarnings("NullableProblems") + @Override + public boolean onCommand(CommandSender sender, Command _command, String _label, String[] args) { + if (args.length == 1 && args[0].equalsIgnoreCase("reload")) { + if (!sender.hasPermission(RELOAD_PERMISSION)) + CommandUtils.respond(sender, "You do not have permission to reload power tool bindings."); + else if (store.reload()) + CommandUtils.respond(sender, "Power tool bindings reloaded successfully."); + else + CommandUtils.respond( + sender, + "Failed to reload bindings, configuration file may be missing or malformatted."); + return true; + } + + if (!(sender instanceof Player player)) { + CommandUtils.respond(sender, "Only players can make power tools."); + return true; + } + if (!sender.hasPermission(PERMISSION)) { + CommandUtils.respond(sender, "You do not have permission to make power tools."); + return true; + } + + ItemStack mhItem = player.getInventory().getItemInMainHand(); + mhItem.getItemMeta(); + if (args.length > 0) { + String command = String.join(" ", args); + try { + store.add(mhItem, command); + CommandUtils.respond(sender, "Power tool created successfully."); + } catch (NoMetaException e) { + CommandUtils.respond(sender, "Power tools must be item types that can hold metadata."); + } + } else { + store.clear(mhItem); + CommandUtils.respond(sender, "Power tool bindings cleared for this item."); + } + return true; + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/commands/Repair.java b/src/main/java/net/cflems/mc/sandbox/commands/Repair.java new file mode 100644 index 0000000..f62a0da --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/commands/Repair.java @@ -0,0 +1,36 @@ +package net.cflems.mc.sandbox.commands; + +import java.util.function.Consumer; +import net.cflems.mc.sandbox.PlayerTargetedCommand; +import net.cflems.mc.sandbox.Sandbox; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.Damageable; +import org.bukkit.inventory.meta.ItemMeta; + +public final class Repair extends PlayerTargetedCommand { + private static final int MIN_ARGS = 0; + private static final int MAX_ARGS = 0; + private static final String PERMISSION = Sandbox.PERMISSION_NAMESPACE + ".repair"; + private static final String PERMISSION_MESSAGE = "You do not have permission to repair items."; + private static final String OTHERS_PERMISSION_MESSAGE = + "You do not have permission to repair other people's items."; + + public Repair() { + super(MIN_ARGS, MAX_ARGS, PERMISSION, PERMISSION_MESSAGE, OTHERS_PERMISSION_MESSAGE); + } + + @Override + protected boolean execute(Player player, String _label, String[] args, Consumer respond) { + ItemStack mhItem = player.getInventory().getItemInMainHand(); + ItemMeta mhItemMeta = player.getInventory().getItemInMainHand().getItemMeta(); + if (mhItemMeta instanceof Damageable damageMeta) { + damageMeta.setDamage(0); + mhItem.setItemMeta(damageMeta); + respond.accept("Item was successfully repaired."); + } else { + respond.accept("Item is not damageable so it can't be repaired."); + } + return true; + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/listeners/PowerToolListener.java b/src/main/java/net/cflems/mc/sandbox/listeners/PowerToolListener.java new file mode 100644 index 0000000..25949d2 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/listeners/PowerToolListener.java @@ -0,0 +1,42 @@ +package net.cflems.mc.sandbox.listeners; + +import java.util.List; +import net.cflems.mc.sandbox.CommandUtils; +import net.cflems.mc.sandbox.storage.PowerToolStore; +import org.bukkit.entity.Player; +import org.bukkit.event.Event; +import org.bukkit.event.EventHandler; +import org.bukkit.event.EventPriority; +import org.bukkit.event.Listener; +import org.bukkit.event.block.Action; +import org.bukkit.event.player.PlayerInteractEvent; + +public final class PowerToolListener implements Listener { + private static final String USE_PT_PERMISSION = "sandbox.powertool.use"; + + private final PowerToolStore store; + + public PowerToolListener(PowerToolStore store) { + this.store = store; + } + + @EventHandler(priority = EventPriority.NORMAL) + public void onPlayerInteract(PlayerInteractEvent event) { + if (!event.hasItem() + || event.useItemInHand().equals(Event.Result.DENY) + || (event.getAction() != Action.RIGHT_CLICK_AIR + && event.getAction() != Action.RIGHT_CLICK_BLOCK)) return; + + List commands = store.get(event.getItem()); + if (commands.isEmpty()) return; + + Player player = event.getPlayer(); + if (!player.hasPermission(USE_PT_PERMISSION)) { + CommandUtils.respond(player, "You do not have permission to use power tools."); + return; + } + + commands.forEach(player::performCommand); + event.setCancelled(true); + } +} diff --git a/src/main/java/net/cflems/mc/sandbox/storage/NoMetaException.java b/src/main/java/net/cflems/mc/sandbox/storage/NoMetaException.java new file mode 100644 index 0000000..3242216 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/storage/NoMetaException.java @@ -0,0 +1,3 @@ +package net.cflems.mc.sandbox.storage; + +public class NoMetaException extends RuntimeException {} diff --git a/src/main/java/net/cflems/mc/sandbox/storage/PowerToolStore.java b/src/main/java/net/cflems/mc/sandbox/storage/PowerToolStore.java new file mode 100644 index 0000000..bbbd2a5 --- /dev/null +++ b/src/main/java/net/cflems/mc/sandbox/storage/PowerToolStore.java @@ -0,0 +1,91 @@ +package net.cflems.mc.sandbox.storage; + +import com.google.common.base.Preconditions; +import java.io.File; +import java.io.IOException; +import java.util.List; +import java.util.Optional; +import java.util.UUID; +import javax.annotation.Nullable; +import javax.annotation.concurrent.GuardedBy; +import org.bukkit.Bukkit; +import org.bukkit.NamespacedKey; +import org.bukkit.configuration.file.FileConfiguration; +import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.persistence.PersistentDataType; + +public final class PowerToolStore { + private static final NamespacedKey ID_KEY = + Preconditions.checkNotNull(NamespacedKey.fromString("sandbox:tool-id")); + + @GuardedBy("this") + private final File configFile; + + @GuardedBy("this") + private final FileConfiguration config; + + public PowerToolStore(File dataFolder) { + this.configFile = new File(dataFolder, "power-tools.yml"); + this.config = YamlConfiguration.loadConfiguration(configFile); + } + + public synchronized List get(@Nullable ItemStack item) { + if (item == null) return List.of(); + return getId(item).map(id -> config.getStringList(id.toString())).orElseGet(List::of); + } + + public synchronized void add(ItemStack item, String command) { + String path = getId(item).orElseGet(() -> createId(item)).toString(); + List bindings = config.getStringList(path); + bindings.add(command); + config.set(path, bindings); + saveConfig(); + } + + public synchronized void clear(ItemStack item) { + Optional id = getId(item); + if (id.isEmpty()) return; + config.set(id.get().toString(), null); + saveConfig(); + } + + public synchronized boolean reload() { + try { + config.load(configFile); + return true; + } catch (Exception _e) { + return false; + } + } + + private Optional getId(ItemStack item) { + ItemMeta itemMeta = item.getItemMeta(); + if (itemMeta == null) return Optional.empty(); + String id = itemMeta.getPersistentDataContainer().get(ID_KEY, PersistentDataType.STRING); + try { + return Optional.ofNullable(id).map(UUID::fromString); + } catch (IllegalArgumentException _e) { + return Optional.empty(); + } + } + + private UUID createId(ItemStack item) throws NoMetaException { + UUID id = UUID.randomUUID(); + ItemMeta itemMeta = item.getItemMeta(); + if (itemMeta == null) throw new NoMetaException(); + itemMeta.getPersistentDataContainer().set(ID_KEY, PersistentDataType.STRING, id.toString()); + item.setItemMeta(itemMeta); + return id; + } + + private void saveConfig() { + try { + config.save(configFile); + } catch (IOException e) { + Bukkit.getLogger() + .severe("Unable to save power tool bindings to disk, data may be lost on restart."); + } + } +} -- cgit v1.2.3