commit af480fc8643c625307fad80270f749192ba1cb0d Author: BradBot_1 Date: Tue Oct 10 01:47:26 2023 +0100 init diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..998e938 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 BradBot_1 + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d439bf2 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Colored Anvils + +A Minecraft plugin for giving items name's color in an anvil + +> *Reload ready! This plugin has no adverse effects when /reload is executed: commands will be disabled and added according to the changes to the configuration* + +## Configuration + +All used items and their colors can be configured: + +It is a simple [Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html) -> HexColor map + +```yml +WHITE_DYE: FFFFFF +ORANGE_DYE: FFAA00 +MAGENTA_DYE: FF00FF +LIGHT_BLUE_DYE: 5555FF +YELLOW_DYE: FFFF55 +LIME_DYE: 55FF55 +PINK_DYE: FF55FF +GRAY_DYE: "555555" +LIGHT_GRAY_DYE: AAAAAA +CYAN_DYE: 55FFFF +PURPLE_DYE: AA00AA +BLUE_DYE: 0000AA +BROWN_DYE: "834333" +GREEN_DYE: 00AA00 +RED_DYE: FF5555 +BLACK_DYE: "000000" +``` + +To add new items simply append the config.yml file with the material name and the hex color to use + +## Permissions + +The permission `anvil.color` is checked before changing the color, this is provided to all players by default. \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..ed76025 --- /dev/null +++ b/pom.xml @@ -0,0 +1,61 @@ + + 4.0.0 + fun.bb1.spigot + coloredanvils + 1.0.0 + Colored Anvils + Color item text in a vanilla way + jar + https://git.bb1.fun/Spigot/ShortCut + + + 17 + UTF-8 + + + + clean package + ColoredAnvils + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + 17 + 17 + + + + + + + + jitpack.io + https://jitpack.io + + + repo + https://repo.bb1.fun/releases + + + placeholderapi + https://repo.extendedclip.com/content/repositories/placeholderapi/ + + + + + + org.jetbrains + annotations + 23.0.0 + provided + + + org.spigotmc + spigot-api + 1.20.1-R0.1-SNAPSHOT + provided + + + \ No newline at end of file diff --git a/src/main/java/fun/bb1/spigot/coloredanvils/AnvilListener.java b/src/main/java/fun/bb1/spigot/coloredanvils/AnvilListener.java new file mode 100644 index 0000000..00c938e --- /dev/null +++ b/src/main/java/fun/bb1/spigot/coloredanvils/AnvilListener.java @@ -0,0 +1,72 @@ +package fun.bb1.spigot.coloredanvils; + +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.inventory.PrepareAnvilEvent; +import org.bukkit.inventory.AnvilInventory; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.plugin.java.JavaPlugin; +import org.jetbrains.annotations.ApiStatus.Internal; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import fun.bb1.spigot.coloredanvils.config.Config; +import net.md_5.bungee.api.ChatColor; + +/** + * Copyright 2023 BradBot_1 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +@Internal +final class AnvilListener implements Listener { + + private @NotNull final JavaPlugin plugin; + private @NotNull final Config config; + + @Internal + AnvilListener(@NotNull final JavaPlugin plugin, final @NotNull Config config) { + this.plugin = plugin; + this.config = config; + Bukkit.getPluginManager().registerEvents(this, this.plugin); + } + + @EventHandler + public final void onAnvil(@NotNull final PrepareAnvilEvent event) { + if (!event.getView().getPlayer().hasPermission("anvil.color")) return; + final AnvilInventory inv = event.getInventory(); + if (inv.getItem(0) == null || inv.getItem(0).getType() == Material.AIR) return; + if (inv.getItem(1) == null || inv.getItem(1).getType() == Material.AIR) return; + final String color = this.config.getColorFor(inv.getItem(1)); + if (color == null) return; + final ItemStack itemStack = inv.getItem(0).clone(); + final ItemMeta itemMeta = itemStack.getItemMeta(); + itemMeta.setDisplayName(color + ChatColor.stripColor(itemMeta.getDisplayName())); + itemStack.setItemMeta(itemMeta); + SetAnvilRunnable.run(this.plugin, inv, itemStack); + } + + private final @NotNull ItemStack convert(@NotNull final ItemStack itemStack, @NotNull final String name, @Nullable final ItemStack secondary) { + if (secondary == null || secondary.getType() == Material.AIR) return itemStack; + final String color = this.config.getColorFor(secondary); + if (color == null) return itemStack; + final ItemMeta itemMeta = itemStack.getItemMeta(); + itemMeta.setDisplayName(color + name); + itemStack.setItemMeta(itemMeta); + return itemStack; + } + +} diff --git a/src/main/java/fun/bb1/spigot/coloredanvils/EntryPoint.java b/src/main/java/fun/bb1/spigot/coloredanvils/EntryPoint.java new file mode 100644 index 0000000..6d95247 --- /dev/null +++ b/src/main/java/fun/bb1/spigot/coloredanvils/EntryPoint.java @@ -0,0 +1,42 @@ +package fun.bb1.spigot.coloredanvils; + +import org.bukkit.event.inventory.PrepareAnvilEvent; +import org.bukkit.plugin.java.JavaPlugin; + +import fun.bb1.spigot.coloredanvils.config.Config; + +/** + * Copyright 2023 BradBot_1 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +public final class EntryPoint extends JavaPlugin { + + @Override + public void onLoad() { + this.saveDefaultConfig(); + super.onLoad(); + } + + @Override + public void onEnable() { + this.getLogger().info("Thank you for using Colored Anvils!"); + new AnvilListener(this, new Config(this)); + } + + @Override + public void onDisable() { + PrepareAnvilEvent.getHandlerList().unregister(this); + } + +} diff --git a/src/main/java/fun/bb1/spigot/coloredanvils/SetAnvilRunnable.java b/src/main/java/fun/bb1/spigot/coloredanvils/SetAnvilRunnable.java new file mode 100644 index 0000000..bec512f --- /dev/null +++ b/src/main/java/fun/bb1/spigot/coloredanvils/SetAnvilRunnable.java @@ -0,0 +1,49 @@ +package fun.bb1.spigot.coloredanvils; + +import org.bukkit.inventory.AnvilInventory; +import org.bukkit.inventory.ItemStack; +import org.bukkit.plugin.java.JavaPlugin; +import org.bukkit.scheduler.BukkitRunnable; +import org.jetbrains.annotations.ApiStatus.Internal; +import org.jetbrains.annotations.NotNull; + +/** + * Copyright 2023 BradBot_1 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +@Internal +final class SetAnvilRunnable extends BukkitRunnable { + + @Internal + static final void run(@NotNull final JavaPlugin plugin, @NotNull final AnvilInventory inv, @NotNull final ItemStack newItemStack) { + new SetAnvilRunnable(inv, newItemStack).runTaskLater(plugin, 0); + } + + private @NotNull final AnvilInventory inv; + private @NotNull final ItemStack newItemStack; + + @Internal + SetAnvilRunnable(@NotNull final AnvilInventory inv, @NotNull final ItemStack newItemStack) { + this.inv = inv; + this.newItemStack = newItemStack; + } + + @Override + public final void run() { + this.inv.setItem(2, this.newItemStack); + this.inv.setRepairCostAmount(1); + this.inv.setRepairCost(1); + } + +} diff --git a/src/main/java/fun/bb1/spigot/coloredanvils/config/Config.java b/src/main/java/fun/bb1/spigot/coloredanvils/config/Config.java new file mode 100644 index 0000000..f40c636 --- /dev/null +++ b/src/main/java/fun/bb1/spigot/coloredanvils/config/Config.java @@ -0,0 +1,47 @@ +package fun.bb1.spigot.coloredanvils.config; + +import org.bukkit.inventory.ItemStack; +import org.bukkit.plugin.java.JavaPlugin; +import org.jetbrains.annotations.ApiStatus.Internal; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import net.md_5.bungee.api.ChatColor; + +/** + * Copyright 2023 BradBot_1 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +@Internal +public final class Config { + + private @NotNull final JavaPlugin plugin; + + @Internal + public Config(@NotNull final JavaPlugin plugin) { + this.plugin = plugin; + } + + public final @Nullable String getColorFor(@NotNull final ItemStack itemStack) { + final String key = itemStack.getType().name(); + final String hexStr = this.plugin.getConfig().getString(key); + if (hexStr == null) return null; + if (hexStr.length() != 6) { + this.plugin.getLogger().warning("Invalid hex code provided for key: " + key); + return null; + } + return ChatColor.of("#" + hexStr).toString(); + } + +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..92ee514 --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,24 @@ +# +# Thank you for using ShortCut! +# Make sure you have the most upto date version from modrinth: +# https://modrinth.com/mod/coloredanvils +# +# Placeholders are supported! +# + +WHITE_DYE: FFFFFF +ORANGE_DYE: FFAA00 +MAGENTA_DYE: FF00FF +LIGHT_BLUE_DYE: 5555FF +YELLOW_DYE: FFFF55 +LIME_DYE: 55FF55 +PINK_DYE: FF55FF +GRAY_DYE: "555555" +LIGHT_GRAY_DYE: AAAAAA +CYAN_DYE: 55FFFF +PURPLE_DYE: AA00AA +BLUE_DYE: 0000AA +BROWN_DYE: "834333" +GREEN_DYE: 00AA00 +RED_DYE: FF5555 +BLACK_DYE: "000000" \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..7dc249b --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,13 @@ +main: fun.bb1.spigot.coloredanvils.EntryPoint +name: ColoredAnvils +version: '1.0.0' +description: 'Rename items with color' +api-version: '1.20' +api: '1.20' +authors: [ BradBot_1#2042 ] +prefix: CAnvils +website: https://modrinth.com/mod/coloredanvils +load: POSTWORLD +permissions: + anvil.color: + default: true \ No newline at end of file