Version bump (2.1.2)

add dyeing support for potions and maps

build.gradle.kts

@@ -2,14 +2,13 @@ import net.minecrell.pluginyml.bukkit.BukkitPluginDescription
 
 plugins {
     id("java")
-    id("maven-publish")
     id("com.github.johnrengelman.shadow") version "7.1.2"
     id("xyz.jpenilla.run-paper") version "2.0.0"
     id("net.minecrell.plugin-yml.bukkit") version "0.5.2"
 }
 
 group = "com.hibiscusmc"
-version = "2.1.0"
+version = "2.1.2"
 
 allprojects {
     apply(plugin = "java")
@@ -228,17 +227,4 @@ bukkit {
 java {
     toolchain.languageVersion.set(JavaLanguageVersion.of(17
     ))
-}
-
-
-publishing {
-    publications {
-        create<MavenPublication>("maven") {
-            groupId = "${project.group}"
-            artifactId = "${project.name}"
-            version = "${project.version}"
-
-            from(components["java"])
-        }
-    }
 }

common/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id("java")
+    id("maven-publish")
 }
 
 dependencies {
@@ -31,3 +32,69 @@ java {
     toolchain.languageVersion.set(JavaLanguageVersion.of(17
     ))
 }
+
+publishing {
+    val publishData = PublishData(project)
+    publications {
+        create<MavenPublication>("maven") {
+            groupId = "${rootProject.group}"
+            artifactId = "${rootProject.name}"
+            version = "${rootProject.version}"
+
+            from(components["java"])
+        }
+    }
+
+    repositories {
+        maven {
+            authentication {
+                credentials(PasswordCredentials::class) {
+                    username = System.getenv("REPO_USERNAME")
+                    password = System.getenv("REPO_PASSWORD")
+                }
+            }
+
+            name = "HibiscusMCRepository"
+            url = uri(publishData.getRepository())
+        }
+    }
+}
+
+class PublishData(private val project: Project) {
+    var type: Type = getReleaseType()
+    var hashLength: Int = 7
+
+    private fun getReleaseType(): Type {
+        val branch = getCheckedOutBranch()
+        return when {
+            branch.contentEquals("master") || branch.contentEquals("local") -> Type.RELEASE
+            branch.startsWith("dev") -> Type.DEV
+            else -> Type.SNAPSHOT
+        }
+    }
+
+    private fun getCheckedOutGitCommitHash(): String =
+        System.getenv("GITHUB_SHA")?.substring(0, hashLength) ?: "local"
+
+    private fun getCheckedOutBranch(): String =
+        System.getenv("GITHUB_REF")?.replace("refs/heads/", "") ?: "local"
+
+    fun getVersion(): String = getVersion(false)
+
+    fun getVersion(appendCommit: Boolean): String =
+        type.append(getVersionString(), appendCommit, getCheckedOutGitCommitHash())
+
+    private fun getVersionString(): String =
+        (rootProject.version as String).replace("-SNAPSHOT", "").replace("-DEV", "")
+
+    fun getRepository(): String = type.repo
+
+    enum class Type(private val append: String, val repo: String, private val addCommit: Boolean) {
+        RELEASE("", "https://repo.hibiscusmc.com/releases/", false),
+        DEV("-DEV", "https://repo.hibiscusmc.com/development/", true),
+        SNAPSHOT("-SNAPSHOT", "https://repo.hibiscusmc.com/snapshots/", true);
+
+        fun append(name: String, appendCommit: Boolean, commitHash: String): String =
+            name.plus(append).plus(if (appendCommit && addCommit) "-".plus(commitHash) else "")
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/HMCCosmeticsPlugin.java

@@ -26,6 +26,7 @@ import com.jeff_media.updatechecker.UpdateChecker;
 import org.bstats.bukkit.Metrics;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
+import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.permissions.Permission;
@@ -45,6 +46,9 @@ public final class HMCCosmeticsPlugin extends JavaPlugin {
     private static boolean disable = false;
     private static YamlConfigurationLoader configLoader;
     private static final int pluginId = 13873;
+    private static boolean hasModelEngine = false;
+    private static boolean onLatestVersion = true;
+    private static String latestVersion = "";
 
     @Override
     public void onEnable() {
@@ -61,11 +65,24 @@ public final class HMCCosmeticsPlugin extends JavaPlugin {
         }
 
         // Update Checker
-        new UpdateChecker(this, UpdateCheckSource.POLYMART, "1879")
-                .setDownloadLink("https://polymart.org/resource/1879")
+        UpdateChecker checker = new UpdateChecker(this, UpdateCheckSource.POLYMART, "1879")
+                .onSuccess((commandSenders, latestVersion) -> {
+                    this.latestVersion = (String) latestVersion;
+                    if (!this.latestVersion.equalsIgnoreCase(getDescription().getVersion())) {
+                        getLogger().info("+++++++++++++++++++++++++++++++++++");
+                        getLogger().info("There is a new update for HMCCosmetics!");
+                        getLogger().info("Please download it as soon as possible for possible fixes and new features.");
+                        getLogger().info("Current Version " + getDescription().getVersion() + " | Latest Version " + latestVersion);
+                        getLogger().info("Spigot: https://www.spigotmc.org/resources/100107/");
+                        getLogger().info("Polymart: https://polymart.org/resource/1879");
+                        getLogger().info("+++++++++++++++++++++++++++++++++++");
+                    }
+                })
+                .setNotifyRequesters(false)
+                .setNotifyOpsOnJoin(false)
                 .checkEveryXHours(24)
                 .checkNow();
-
+        onLatestVersion = checker.isUsingLatestVersion();
         // File setup
         if (!getDataFolder().exists()) {
             saveDefaultConfig();
@@ -92,6 +109,13 @@ public final class HMCCosmeticsPlugin extends JavaPlugin {
         if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) {
             new PAPIHook().register();
         }
+
+        // ModelEngine
+        if (Bukkit.getPluginManager().getPlugin("ModelEngine") != null) {
+            hasModelEngine = true;
+        }
+
+        // WorldGuard
         if (Bukkit.getPluginManager().getPlugin("WorldGuard") != null) {
             getServer().getPluginManager().registerEvents(new WGListener(), this);
         }
@@ -229,4 +253,14 @@ public final class HMCCosmeticsPlugin extends JavaPlugin {
             throw new RuntimeException(e);
         }
     }
+
+    public static boolean hasModelEngine() {
+        return hasModelEngine;
+    }
+    public static boolean isOnLatestVersion() {
+        return onLatestVersion;
+    }
+    public static String getLatestVersion() {
+        return latestVersion;
+    }
 }

common/src/main/java/com/hibiscusmc/hmccosmetics/command/CosmeticCommand.java

@@ -33,6 +33,8 @@ public class CosmeticCommand implements CommandExecutor {
 
     @Override
     public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
+        boolean silent = false;
+
         if (args.length == 0) {
             if (!(sender instanceof Player)) {
                 // Console
@@ -62,49 +64,61 @@ public class CosmeticCommand implements CommandExecutor {
         Player player = sender instanceof Player ? (Player) sender : null;
 
         String firstArgs = args[0].toLowerCase();
+
+        if (sender.hasPermission("HMCCosmetics.cmd.silent") || sender.isOp()) {
+            for (String singleArg : args) {
+                if (singleArg.equalsIgnoreCase("-s")) silent = true;
+            }
+        }
+
         switch (firstArgs) {
             case ("reload") -> {
                 if (!sender.hasPermission("HMCCosmetics.cmd.reload") || !sender.isOp()) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 HMCCosmeticsPlugin.setup();
-                MessagesUtil.sendMessage(sender, "reloaded");
+                if (!silent) MessagesUtil.sendMessage(sender, "reloaded");
                 return true;
             }
             case ("apply") -> {
                 if (!sender.hasPermission("hmccosmetics.cmd.apply")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 Cosmetic cosmetic;
+                Color color = Color.WHITE;
 
                 if (sender instanceof Player) player = ((Player) sender).getPlayer();
                 if (sender.hasPermission("hmccosmetics.cmd.apply.other")) {
                     if (args.length >= 3) player = Bukkit.getPlayer(args[2]);
                 }
 
+                if (sender.hasPermission("hmccosmetics.cmd.apply.color")) {
+                    if (args.length >= 4) color = ServerUtils.hex2Rgb(args[3]);
+                }
+
                 if (args.length == 1) {
-                    MessagesUtil.sendMessage(player, "not-enough-args");
+                    if (!silent) MessagesUtil.sendMessage(player, "not-enough-args");
                     return true;
                 }
 
                 cosmetic = Cosmetics.getCosmetic(args[1]);
 
                 if (cosmetic == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-cosmetic");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-cosmetic");
                     return true;
                 }
 
                 if (player == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
                 CosmeticUser user = CosmeticUsers.getUser(player);
 
                 if (!user.canEquipCosmetic(cosmetic)) {
-                    MessagesUtil.sendMessage(player, "no-cosmetic-permission");
+                    if (!silent) MessagesUtil.sendMessage(player, "no-cosmetic-permission");
                     return true;
                 }
 
@@ -113,19 +127,19 @@ public class CosmeticCommand implements CommandExecutor {
                                 TagResolver.resolver(Placeholder.parsed("player", player.getName())),
                                 TagResolver.resolver(Placeholder.parsed("cosmeticslot", cosmetic.getSlot().name())));
 
-                MessagesUtil.sendMessage(player, "equip-cosmetic", placeholders);
+                if (!silent) MessagesUtil.sendMessage(player, "equip-cosmetic", placeholders);
 
-                user.addPlayerCosmetic(cosmetic);
+                user.addPlayerCosmetic(cosmetic, color);
                 user.updateCosmetic(cosmetic.getSlot());
                 return true;
             }
             case ("unapply") -> {
                 if (!sender.hasPermission("hmccosmetics.cmd.unapply")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 if (args.length == 1) {
-                    MessagesUtil.sendMessage(player, "not-enough-args");
+                    if (!silent) MessagesUtil.sendMessage(player, "not-enough-args");
                     return true;
                 }
 
@@ -137,20 +151,20 @@ public class CosmeticCommand implements CommandExecutor {
                 }
 
                 if (!EnumUtils.isValidEnum(CosmeticSlot.class, args[1].toUpperCase())) {
-                    MessagesUtil.sendMessage(sender, "invalid-slot");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-slot");
                     return true;
                 }
                 cosmeticSlot = CosmeticSlot.valueOf(args[1].toUpperCase());
 
                 if (player == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
                 CosmeticUser user = CosmeticUsers.getUser(player);
 
                 if (user.getCosmetic(cosmeticSlot) == null) {
-                    MessagesUtil.sendMessage(sender, "no-cosmetic-slot");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-cosmetic-slot");
                     return true;
                 }
 
@@ -159,7 +173,7 @@ public class CosmeticCommand implements CommandExecutor {
                                 TagResolver.resolver(Placeholder.parsed("player", player.getName())),
                                 TagResolver.resolver(Placeholder.parsed("cosmeticslot", cosmeticSlot.name())));
 
-                MessagesUtil.sendMessage(player, "unequip-cosmetic", placeholders);
+                if (!silent) MessagesUtil.sendMessage(player, "unequip-cosmetic", placeholders);
 
                 user.removeCosmeticSlot(cosmeticSlot);
                 user.updateCosmetic(cosmeticSlot);
@@ -172,12 +186,12 @@ public class CosmeticCommand implements CommandExecutor {
                 }
 
                 if (!sender.hasPermission("hmccosmetics.cmd.wardrobe")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (player == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
@@ -190,7 +204,7 @@ public class CosmeticCommand implements CommandExecutor {
             case ("menu") -> {
                 if (args.length == 1) return true;
                 if (!sender.hasPermission("hmccosmetics.cmd.menu")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 Menu menu = Menus.getMenu(args[1]);
@@ -202,12 +216,12 @@ public class CosmeticCommand implements CommandExecutor {
                 CosmeticUser user = CosmeticUsers.getUser(player);
 
                 if (user == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
                 if (menu == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-menu");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-menu");
                     return true;
                 }
 
@@ -219,7 +233,7 @@ public class CosmeticCommand implements CommandExecutor {
                 OfflinePlayer selectedPlayer = Bukkit.getOfflinePlayer(args[1]);
                 if (selectedPlayer == null) return true;
                 if (!sender.hasPermission("hmccosmetics.cmd.dataclear") && !sender.isOp()) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 Database.clearData(selectedPlayer.getUniqueId());
@@ -231,30 +245,30 @@ public class CosmeticCommand implements CommandExecutor {
                 CosmeticUser user = CosmeticUsers.getUser(player);
                 if (user == null) return true;
                 if (!sender.hasPermission("hmccosmetics.cmd.dye") && !sender.isOp()) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (args.length == 1) {
-                    MessagesUtil.sendMessage(player, "not-enough-args");
+                    if (!silent) MessagesUtil.sendMessage(player, "not-enough-args");
                     return true;
                 }
 
                 if (!EnumUtils.isValidEnum(CosmeticSlot.class, args[1])) {
-                    MessagesUtil.sendMessage(player, "invalid-slot");
+                    if (!silent) MessagesUtil.sendMessage(player, "invalid-slot");
                     return true;
                 }
                 CosmeticSlot slot = CosmeticSlot.valueOf(args[1]);
                 Cosmetic cosmetic = user.getCosmetic(slot);
 
                 if (args.length >= 3) {
-                    if (!args[2].contains("#") || args[2].isEmpty()) {
-                        MessagesUtil.sendMessage(player, "invalid-color");
+                    if (args[2].isEmpty()) {
+                        if (!silent) MessagesUtil.sendMessage(player, "invalid-color");
                         return true;
                     }
                     Color color = ServerUtils.hex2Rgb(args[2]);
                     if (color == null) {
-                        MessagesUtil.sendMessage(player, "invalid-color");
+                        if (!silent) MessagesUtil.sendMessage(player, "invalid-color");
                         return true;
                     }
                     user.addPlayerCosmetic(cosmetic, color); // #FFFFFF
@@ -264,32 +278,32 @@ public class CosmeticCommand implements CommandExecutor {
             }
             case ("setlocation") -> {
                 if (!sender.hasPermission("hmccosmetics.cmd.setlocation")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (player == null) return true;
 
                 if (args.length < 2) {
-                    MessagesUtil.sendMessage(player, "not-enough-args");
+                    if (!silent) MessagesUtil.sendMessage(player, "not-enough-args");
                     return true;
                 }
 
                 if (args[1].equalsIgnoreCase("wardrobelocation")) {
                     WardrobeSettings.setWardrobeLocation(player.getLocation());
-                    MessagesUtil.sendMessage(player, "set-wardrobe-location");
+                    if (!silent) MessagesUtil.sendMessage(player, "set-wardrobe-location");
                     return true;
                 }
 
                 if (args[1].equalsIgnoreCase("viewerlocation")) {
                     WardrobeSettings.setViewerLocation(player.getLocation());
-                    MessagesUtil.sendMessage(player, "set-wardrobe-viewing");
+                    if (!silent) MessagesUtil.sendMessage(player, "set-wardrobe-viewing");
                     return true;
                 }
 
                 if (args[1].equalsIgnoreCase("leavelocation")) {
                     WardrobeSettings.setLeaveLocation(player.getLocation());
-                    MessagesUtil.sendMessage(player, "set-wardrobe-leaving");
+                    if (!silent) MessagesUtil.sendMessage(player, "set-wardrobe-leaving");
                     return true;
                 }
             }
@@ -298,7 +312,7 @@ public class CosmeticCommand implements CommandExecutor {
                 CosmeticUser user = CosmeticUsers.getUser(player);
                 if (user == null) return true;
                 if (!sender.hasPermission("HMCCosmetic.cmd.dump") && !sender.isOp()) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
                 player.sendMessage("Passengers -> " + player.getPassengers());
@@ -316,18 +330,18 @@ public class CosmeticCommand implements CommandExecutor {
                 }
 
                 if (!sender.hasPermission("hmccosmetics.cmd.hide")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (player == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
                 CosmeticUser user = CosmeticUsers.getUser(player);
-                MessagesUtil.sendMessage(sender, "hide-cosmetic");
-                user.hideCosmetics(CosmeticUser.HiddenReason.PLUGIN);
+                if (!silent) MessagesUtil.sendMessage(sender, "hide-cosmetic");
+                user.hideCosmetics(CosmeticUser.HiddenReason.COMMAND);
                 return true;
             }
             case ("show") -> {
@@ -337,33 +351,33 @@ public class CosmeticCommand implements CommandExecutor {
                 }
 
                 if (!sender.hasPermission("hmccosmetics.cmd.show")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (player == null) {
-                    MessagesUtil.sendMessage(sender, "invalid-player");
+                    if (!silent) MessagesUtil.sendMessage(sender, "invalid-player");
                     return true;
                 }
 
                 CosmeticUser user = CosmeticUsers.getUser(player);
 
-                MessagesUtil.sendMessage(sender, "show-cosmetic");
+                if (!silent) MessagesUtil.sendMessage(sender, "show-cosmetic");
                 user.showCosmetics();
                 return true;
             }
             case ("debug") -> {
                 if (!sender.hasPermission("hmccosmetics.cmd.debug")) {
-                    MessagesUtil.sendMessage(sender, "no-permission");
+                    if (!silent) MessagesUtil.sendMessage(sender, "no-permission");
                     return true;
                 }
 
                 if (Settings.getDebugMode()) {
                     Settings.setDebugMode(false);
-                    MessagesUtil.sendMessage(sender, "debug-disabled");
+                    if (!silent) MessagesUtil.sendMessage(sender, "debug-disabled");
                 } else {
                     Settings.setDebugMode(true);
-                    MessagesUtil.sendMessage(sender, "debug-enabled");
+                    if (!silent) MessagesUtil.sendMessage(sender, "debug-enabled");
                 }
             }
 

common/src/main/java/com/hibiscusmc/hmccosmetics/command/CosmeticCommandTabComplete.java

@@ -91,11 +91,20 @@ public class CosmeticCommandTabComplete implements TabCompleter {
                         completions.add(player.getName());
                     }
                 }
-
             }
             StringUtil.copyPartialMatches(args[2], completions, finalCompletitons);
         }
 
+        if (args.length == 4) {
+            String subcommand = args[0].toLowerCase();
+            switch (subcommand) {
+                case "apply" -> {
+                    completions.add("#FFFFFF");
+                }
+            }
+            StringUtil.copyPartialMatches(args[3], completions, finalCompletitons);
+        }
+
         Collections.sort(finalCompletitons);
         return finalCompletitons;
     }

common/src/main/java/com/hibiscusmc/hmccosmetics/config/serializer/ItemSerializer.java

@@ -2,6 +2,7 @@ package com.hibiscusmc.hmccosmetics.config.serializer;
 
 import com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin;
 import com.hibiscusmc.hmccosmetics.hooks.items.ItemHooks;
+import com.hibiscusmc.hmccosmetics.util.ServerUtils;
 import com.hibiscusmc.hmccosmetics.util.builder.ColorBuilder;
 import com.hibiscusmc.hmccosmetics.util.misc.StringUtils;
 import com.hibiscusmc.hmccosmetics.util.misc.Utils;
@@ -126,7 +127,11 @@ public class ItemSerializer implements TypeSerializer<ItemStack> {
 
         if (!colorNode.virtual()) {
             if (ColorBuilder.canBeColored(item.getType())) {
-                itemMeta = ColorBuilder.color(itemMeta, Color.fromRGB(redNode.getInt(0), greenNode.getInt(0), blueNode.getInt(0)));
+                if (!redNode.virtual()) {
+                    itemMeta = ColorBuilder.color(itemMeta, Color.fromRGB(redNode.getInt(0), greenNode.getInt(0), blueNode.getInt(0)));
+                } else {
+                    itemMeta = ColorBuilder.color(itemMeta, ServerUtils.hex2Rgb(colorNode.getString("#FFFFFF")));
+                }
             }
         }
 

common/src/main/java/com/hibiscusmc/hmccosmetics/database/types/Data.java

@@ -1,10 +1,13 @@
 package com.hibiscusmc.hmccosmetics.database.types;
 
+import com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetic;
 import com.hibiscusmc.hmccosmetics.cosmetic.CosmeticSlot;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetics;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
 import com.hibiscusmc.hmccosmetics.util.MessagesUtil;
+import org.apache.commons.lang3.EnumUtils;
+import org.bukkit.Bukkit;
 import org.bukkit.Color;
 import org.jetbrains.annotations.Nullable;
 
@@ -34,6 +37,9 @@ public class Data {
     // BACKPACK=colorfulbackpack&RRGGBB,HELMET=niftyhat,BALLOON=colorfulballoon,CHESTPLATE=niftychestplate
     public String steralizeData(CosmeticUser user) {
         String data = "";
+        if (user.getHidden()) {
+            data = "HIDDEN=" + user.getHiddenReason();
+        }
         for (Cosmetic cosmetic : user.getCosmetic()) {
             Color color = user.getCosmeticColor(cosmetic.getSlot());
             String input = cosmetic.getSlot() + "=" + cosmetic.getId();
@@ -47,7 +53,7 @@ public class Data {
         return data;
     }
 
-    public Map<CosmeticSlot, Map<Cosmetic, Color>> desteralizedata(String raw) {
+    public Map<CosmeticSlot, Map<Cosmetic, Color>> desteralizedata(CosmeticUser user, String raw) {
         Map<CosmeticSlot, Map<Cosmetic, Color>> cosmetics = new HashMap<>();
 
         String[] rawData = raw.split(",");
@@ -57,8 +63,15 @@ public class Data {
             CosmeticSlot slot = null;
             Cosmetic cosmetic = null;
             MessagesUtil.sendDebugMessages("First split (suppose slot) " + splitData[0]);
+            if (splitData[0].equalsIgnoreCase("HIDDEN")) {
+                if (EnumUtils.isValidEnum(CosmeticUser.HiddenReason.class, splitData[1])) {
+                    Bukkit.getScheduler().runTask(HMCCosmeticsPlugin.getInstance(), () -> {
+                        user.hideCosmetics(CosmeticUser.HiddenReason.valueOf(splitData[1]));
+                    });
+                }
+                continue;
+            }
             if (CosmeticSlot.valueOf(splitData[0]) != null) slot = CosmeticSlot.valueOf(splitData[0]);
-
             if (splitData[1].contains("&")) {
                 String[] colorSplitData = splitData[1].split("&");
                 if (Cosmetics.hasCosmetic(colorSplitData[0])) cosmetic = Cosmetics.getCosmetic(colorSplitData[0]);

common/src/main/java/com/hibiscusmc/hmccosmetics/database/types/InternalData.java

@@ -38,7 +38,7 @@ public class InternalData extends Data {
         if (!player.getPersistentDataContainer().has(key, PersistentDataType.STRING)) return user;
         String rawData = player.getPersistentDataContainer().get(key, PersistentDataType.STRING);
 
-        Map<CosmeticSlot, Map<Cosmetic, Color>> a = desteralizedata(rawData);
+        Map<CosmeticSlot, Map<Cosmetic, Color>> a = desteralizedata(user, rawData);
         for (Map<Cosmetic, Color> cosmeticColors : a.values()) {
             for (Cosmetic cosmetic : cosmeticColors.keySet()) {
                 Bukkit.getScheduler().runTask(HMCCosmeticsPlugin.getInstance(), () -> {

common/src/main/java/com/hibiscusmc/hmccosmetics/database/types/MySQLData.java

@@ -82,7 +82,7 @@ public class MySQLData extends Data {
                 ResultSet rs = preparedStatement.executeQuery();
                 if (rs.next()) {
                     String rawData = rs.getString("COSMETICS");
-                    Map<CosmeticSlot, Map<Cosmetic, Color>> cosmetics = desteralizedata(rawData);
+                    Map<CosmeticSlot, Map<Cosmetic, Color>> cosmetics = desteralizedata(user, rawData);
                     for (Map<Cosmetic, Color> cosmeticColors : cosmetics.values()) {
                         for (Cosmetic cosmetic : cosmeticColors.keySet()) {
                             Bukkit.getScheduler().runTask(HMCCosmeticsPlugin.getInstance(), () -> {

common/src/main/java/com/hibiscusmc/hmccosmetics/database/types/SQLiteData.java

@@ -76,7 +76,7 @@ public class SQLiteData extends Data {
                 ResultSet rs = preparedStatement.executeQuery();
                 if (rs.next()) {
                     String rawData = rs.getString("COSMETICS");
-                    Map<CosmeticSlot, Map<Cosmetic, Color>> cosmetics = desteralizedata(rawData);
+                    Map<CosmeticSlot, Map<Cosmetic, Color>> cosmetics = desteralizedata(user, rawData);
                     for (Map<Cosmetic, Color> cosmeticColors : cosmetics.values()) {
                         for (Cosmetic cosmetic : cosmeticColors.keySet()) {
                             Bukkit.getScheduler().runTask(HMCCosmeticsPlugin.getInstance(), () -> {

common/src/main/java/com/hibiscusmc/hmccosmetics/entities/BalloonEntity.java

@@ -1,5 +1,6 @@
 package com.hibiscusmc.hmccosmetics.entities;
 
+import com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin;
 import com.hibiscusmc.hmccosmetics.config.Settings;
 import com.hibiscusmc.hmccosmetics.cosmetic.types.CosmeticBalloonType;
 import com.hibiscusmc.hmccosmetics.nms.NMSHandlers;
@@ -33,7 +34,7 @@ public class BalloonEntity {
 
     public void spawnModel(CosmeticBalloonType cosmeticBalloonType, Color color) {
         // redo this
-        if (cosmeticBalloonType.getModelName() != null) {
+        if (cosmeticBalloonType.getModelName() != null && HMCCosmeticsPlugin.hasModelEngine()) {
             balloonType = BalloonType.MODELENGINE;
         } else {
             if (cosmeticBalloonType.getItem() != null) {

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/action/Actions.java

@@ -22,6 +22,9 @@ public class Actions {
     private static ActionEquip ACTION_EQUIP = new ActionEquip();
     private static ActionUnequip ACTION_UNEQUIP = new ActionUnequip();
     private static ActionParticle ACTION_PARTICLE = new ActionParticle();
+    private static ActionCosmeticShow ACTION_SHOW = new ActionCosmeticShow();
+    private static ActionCosmeticHide ACTION_HIDE = new ActionCosmeticHide();
+    private static ActionCosmeticToggle ACTION_TOGGLE = new ActionCosmeticToggle();
 
 
     public static Action getAction(String id) {
@@ -40,7 +43,7 @@ public class Actions {
         for (String a : raw) {
             String id = StringUtils.substringBetween(a, "[", "]").toUpperCase();
             String message = StringUtils.substringAfter(a, "] ");
-            MessagesUtil.sendDebugMessages("ID is " + id + " // Message is " + message);
+            MessagesUtil.sendDebugMessages("ID is " + id + " // Raw Data is " + message);
             if (isAction(id)) {
                 getAction(id).run(user, message);
             } else {

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/action/actions/ActionCosmeticHide.java

@@ -0,0 +1,19 @@
+package com.hibiscusmc.hmccosmetics.gui.action.actions;
+
+import com.hibiscusmc.hmccosmetics.gui.action.Action;
+import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
+
+public class ActionCosmeticHide extends Action {
+
+    public ActionCosmeticHide() {
+        super("hide");
+    }
+
+    @Override
+    public void run(CosmeticUser user, String raw) {
+        if (!user.getHidden()) {
+            user.hideCosmetics(CosmeticUser.HiddenReason.ACTION);
+            return;
+        }
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/action/actions/ActionCosmeticShow.java

@@ -0,0 +1,19 @@
+package com.hibiscusmc.hmccosmetics.gui.action.actions;
+
+import com.hibiscusmc.hmccosmetics.gui.action.Action;
+import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
+
+public class ActionCosmeticShow extends Action {
+
+    public ActionCosmeticShow() {
+        super("show");
+    }
+
+    @Override
+    public void run(CosmeticUser user, String raw) {
+        if (user.getHidden()) {
+            if (user.getHiddenReason() != CosmeticUser.HiddenReason.ACTION && user.getHiddenReason() != CosmeticUser.HiddenReason.COMMAND) return; // Do not hide if its already off for WG
+            user.showCosmetics();
+        }
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/action/actions/ActionCosmeticToggle.java

@@ -0,0 +1,22 @@
+package com.hibiscusmc.hmccosmetics.gui.action.actions;
+
+import com.hibiscusmc.hmccosmetics.gui.action.Action;
+import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
+
+public class ActionCosmeticToggle extends Action {
+
+    public ActionCosmeticToggle() {
+        super("toggle");
+    }
+
+    @Override
+    public void run(CosmeticUser user, String raw) {
+        if (user.getHidden()) {
+            if (user.getHiddenReason() != CosmeticUser.HiddenReason.ACTION && user.getHiddenReason() != CosmeticUser.HiddenReason.COMMAND) return;
+            user.showCosmetics();
+            return;
+        }
+        user.hideCosmetics(CosmeticUser.HiddenReason.ACTION);
+        return;
+    }
+}

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/action/actions/ActionMenu.java

@@ -14,11 +14,20 @@ public class ActionMenu extends Action {
 
     @Override
     public void run(CosmeticUser user, String raw) {
+        boolean ignorePermission = false;
+
+        raw = raw.replaceAll(" ", ""); // Removes all spaces
+
+        if (raw.contains("-o")) {
+            raw = raw.replaceAll("-o", "");
+            ignorePermission = true;
+        }
         if (!Menus.hasMenu(raw)) {
             HMCCosmeticsPlugin.getInstance().getLogger().info("Invalid Action Menu -> " + raw);
             return;
         }
         Menu menu = Menus.getMenu(raw);
-        menu.openMenu(user, true);
+        HMCCosmeticsPlugin.getInstance().getLogger().info(raw + " | " + ignorePermission);
+        menu.openMenu(user, ignorePermission);
     }
 }

common/src/main/java/com/hibiscusmc/hmccosmetics/gui/special/DyeMenu.java

@@ -15,6 +15,7 @@ import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.inventory.meta.LeatherArmorMeta;
+import org.bukkit.inventory.meta.MapMeta;
 import org.bukkit.inventory.meta.PotionMeta;
 
 public class DyeMenu {
@@ -36,9 +37,12 @@ public class DyeMenu {
                 if (item == null) return;
                 ItemMeta meta = item.getItemMeta();
                 if (meta == null) return;
-                Color color = meta instanceof LeatherArmorMeta ? ((LeatherArmorMeta) meta).getColor() :
-                        meta instanceof PotionMeta ? ((PotionMeta) meta).getColor() : null;
+
+                Color color = meta instanceof LeatherArmorMeta leatherMeta ? leatherMeta.getColor() :
+                        meta instanceof PotionMeta potionMeta ? potionMeta.getColor() :
+                                meta instanceof MapMeta mapMeta ? mapMeta.getColor() : null;
                 if (color == null) return;
+
                 //user.removeCosmeticSlot(cosmetic);
                 user.addPlayerCosmetic(cosmetic, color);
                 player.setItemOnCursor(new ItemStack(Material.AIR));

common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/ItemAdderHook.java

@@ -31,6 +31,7 @@ public class ItemAdderHook extends ItemHook implements Listener {
 
     @EventHandler
     public void onItemAdderDataLoad(ItemsAdderLoadDataEvent event) {
+        if (enabled) return; // Only run on the first event fired; ignore all rest
         this.enabled = true;
         HMCCosmeticsPlugin.setup();
     }

common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/worldguard/WGListener.java

@@ -24,9 +24,10 @@ public class WGListener implements Listener {
         RegionContainer region = WorldGuard.getInstance().getPlatform().getRegionContainer();
         RegionQuery query = region.createQuery();
         ApplicableRegionSet set = query.getApplicableRegions(loc);
-        // TODO: Add more cosmetics
-        if (set.getRegions().size() == 0) {
-            user.showCosmetics();
+        if (user.getHidden()) {
+            if (user.getHiddenReason() == CosmeticUser.HiddenReason.WORLDGUARD && set.getRegions().size() == 0) {
+                user.showCosmetics();
+            }
         }
         for (ProtectedRegion protectedRegion : set.getRegions()) {
             if (protectedRegion.getFlags().containsKey(WGHook.getCosmeticEnableFlag())) {

common/src/main/java/com/hibiscusmc/hmccosmetics/listener/PlayerConnectionListener.java

@@ -18,6 +18,18 @@ public class PlayerConnectionListener implements Listener {
 
     @EventHandler
     public void onPlayerJoin(PlayerJoinEvent event) {
+        if (event.getPlayer().isOp() || event.getPlayer().hasPermission("hmccosmetics.notifyupdate")) {
+            if (!HMCCosmeticsPlugin.getLatestVersion().equalsIgnoreCase(HMCCosmeticsPlugin.getInstance().getDescription().getVersion()) && HMCCosmeticsPlugin.getLatestVersion() != null)
+                MessagesUtil.sendMessageNoKey(
+                        event.getPlayer(),
+                        "<br>" +
+                                "<GRAY>There is a new version of <light_purple><Bold>HMCCosmetics<reset><gray> available!<br>" +
+                                "<GRAY>Current version: <red>" + HMCCosmeticsPlugin.getInstance().getDescription().getVersion() + " <GRAY>| Latest version: <light_purple>" + HMCCosmeticsPlugin.getLatestVersion() + "<br>" +
+                                "<GRAY>Download it on <gold><click:OPEN_URL:'https://www.spigotmc.org/resources/100107/'>Spigot<reset> <gray>or <gold><click:OPEN_URL:'https://polymart.org/resource/1879'>Polymart<reset><gray>!" +
+                                "<br>"
+                );
+        }
+
         Runnable run = () -> {
             CosmeticUser user = Database.get(event.getPlayer().getUniqueId());
             CosmeticUsers.addUser(user);

common/src/main/java/com/hibiscusmc/hmccosmetics/listener/PlayerGameListener.java

@@ -13,6 +13,8 @@ import com.hibiscusmc.hmccosmetics.config.Settings;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetic;
 import com.hibiscusmc.hmccosmetics.cosmetic.CosmeticSlot;
 import com.hibiscusmc.hmccosmetics.cosmetic.types.CosmeticArmorType;
+import com.hibiscusmc.hmccosmetics.cosmetic.types.CosmeticBackpackType;
+import com.hibiscusmc.hmccosmetics.cosmetic.types.CosmeticBalloonType;
 import com.hibiscusmc.hmccosmetics.gui.Menu;
 import com.hibiscusmc.hmccosmetics.gui.Menus;
 import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
@@ -109,8 +111,10 @@ public class PlayerGameListener implements Listener {
         if (event.getCause().equals(PlayerTeleportEvent.TeleportCause.NETHER_PORTAL) || event.getCause().equals(PlayerTeleportEvent.TeleportCause.END_PORTAL)) return;
 
         if (user.hasCosmeticInSlot(CosmeticSlot.BALLOON)) {
+            final CosmeticBalloonType cosmeticBalloonType = (CosmeticBalloonType) user.getCosmetic(CosmeticSlot.BALLOON);
+            user.despawnBalloon();
             Bukkit.getScheduler().runTaskLater(HMCCosmeticsPlugin.getInstance(), () -> {
-                user.updateCosmetic(CosmeticSlot.BALLOON);
+                user.spawnBalloon(cosmeticBalloonType);
             }, 2);
         }
     }
@@ -206,8 +210,9 @@ public class PlayerGameListener implements Listener {
         if (!event.getEntityType().equals(EntityType.PLAYER)) return;
         Player player = (Player) event.getEntity();
         CosmeticUser user = CosmeticUsers.getUser(player);
+        if (user == null) return;
         if (event.getAction().equals(EntityPotionEffectEvent.Action.ADDED)) {
-            user.hideCosmetics(CosmeticUser.HiddenReason.PLUGIN);
+            user.hideCosmetics(CosmeticUser.HiddenReason.POTION);
             return;
         }
         if (event.getAction().equals(EntityPotionEffectEvent.Action.CLEARED) || event.getAction().equals(EntityPotionEffectEvent.Action.REMOVED)) {

common/src/main/java/com/hibiscusmc/hmccosmetics/nms/NMSHandlers.java

@@ -34,7 +34,7 @@ public class NMSHandlers {
             if (!selectedVersion.contains(packageVersion)) {
                 continue;
             }
-            MessagesUtil.sendDebugMessages(packageVersion + " has been detected.", Level.SEVERE);
+            MessagesUtil.sendDebugMessages(packageVersion + " has been detected.", Level.INFO);
             version = packageVersion;
             try {
                 //Class.forName("org.bukkit.craftbukkit." + version + ".block.CraftBlock").getName();

common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUser.java

@@ -23,8 +23,7 @@ import org.bukkit.entity.ArmorStand;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
-import org.bukkit.inventory.meta.ItemMeta;
-import org.bukkit.inventory.meta.LeatherArmorMeta;
+import org.bukkit.inventory.meta.*;
 import org.bukkit.scheduler.BukkitTask;
 
 import java.util.*;
@@ -192,6 +191,7 @@ public class CosmeticUser {
     public ItemStack getUserCosmeticItem(Cosmetic cosmetic) {
         ItemStack item = null;
         if (hideCosmetics) {
+            if (cosmetic instanceof CosmeticBackpackType || cosmetic instanceof CosmeticBalloonType) return new ItemStack(Material.AIR);
             return getPlayer().getInventory().getItem(InventoryUtils.getEquipmentSlot(cosmetic.getSlot()));
         }
         if (cosmetic instanceof CosmeticArmorType || cosmetic instanceof CosmeticMainhandType || cosmetic instanceof CosmeticBackpackType) {
@@ -210,9 +210,14 @@ public class CosmeticUser {
         }
         if (item.hasItemMeta()) {
             ItemMeta itemMeta = item.getItemMeta();
-            if (itemMeta instanceof LeatherArmorMeta) {
-                if (colors.containsKey(cosmetic.getSlot())) {
-                    ((LeatherArmorMeta) itemMeta).setColor(colors.get(cosmetic.getSlot()));
+            if (colors.containsKey(cosmetic.getSlot())) {
+                Color color = colors.get(cosmetic.getSlot());
+                if (itemMeta instanceof LeatherArmorMeta leatherMeta) {
+                    leatherMeta.setColor(color);
+                } else if (itemMeta instanceof PotionMeta potionMeta) {
+                    potionMeta.setColor(color);
+                } else if (itemMeta instanceof MapMeta mapMeta) {
+                    mapMeta.setColor(color);
                 }
             }
             item.setItemMeta(itemMeta);
@@ -460,6 +465,9 @@ public class CosmeticUser {
     public enum HiddenReason {
         NONE,
         WORLDGUARD,
-        PLUGIN
+        PLUGIN,
+        POTION,
+        ACTION,
+        COMMAND
     }
 }

common/src/main/java/com/hibiscusmc/hmccosmetics/util/ServerUtils.java

@@ -37,6 +37,16 @@ public class ServerUtils {
     }
 
     public static Color hex2Rgb(String colorStr) {
+        if (colorStr.startsWith("#")) return Color.fromRGB(Integer.valueOf(colorStr.substring(1), 16));
+        if (colorStr.startsWith("0x")) return Color.fromRGB(Integer.valueOf(colorStr.substring(2), 16));
+        if (colorStr.contains(",")) {
+            String[] colorString = colorStr.replace(" ", "").split(",");
+            for (String color : colorString) if (Integer.valueOf(color) == null) return Color.WHITE;
+            Color.fromRGB(Integer.valueOf(colorString[0]), Integer.valueOf(colorString[1]), Integer.valueOf(colorString[2]));
+        }
+
+        return Color.WHITE;
+        /* Old method
         try {
             return Color.fromRGB(
                     Integer.valueOf(colorStr.substring(1, 3), 16),
@@ -45,6 +55,7 @@ public class ServerUtils {
         } catch (StringIndexOutOfBoundsException e) {
             return null;
         }
+         */
     }
 
     // particle amount offsetxyz

common/src/main/resources/config.yml

@@ -32,6 +32,8 @@ cosmetic-settings:
     y: 3
     z: 0.5
 dye-menu:
+  # If you use ItemsAdder, set this to "§f:offset_-8::cosmetics_gui:"
+  # If you use Oraxen, set this to "<glyph:neg_shift_8><glyph:dye_menu>"
   title: "§f"
 wardrobe:
   # spawn static wardrobe if in this radius of wardrobe-location

common/src/main/resources/cosmetics/defaultcosmetics.yml

@@ -87,7 +87,7 @@ boots:
 kite:
   slot: BALLOON
   permission: "hmccosmetics.kite"
-  model: kite
+  model: kite # This is the ModelEngine model it will use. If you do not have ModelEngine installed, it will default to the item.
   item:
     material: PAPER
     model-data: 7

license.md

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.