\n * This record holds a weak reference to a Bukkit plugin to prevent memory leaks\n * and checks if the plugin is enabled.\n *
\n *\n * @param name the name of the plugin\n * @param pluginRef a weak reference to the plugin instance\n * @since 2.0.0\n */\npublic record BukkitEventApplication(@NotNull String name, @NotNull WeakReference pluginRef) implements ModelEventApplication {\n\n /**\n * Creates a new BukkitEventApplication for the given plugin.\n *\n * @param plugin the Bukkit plugin\n * @return the event application wrapper\n * @since 2.0.0\n */\n public static @NotNull BukkitEventApplication of(@NotNull Plugin plugin) {\n return new BukkitEventApplication(plugin.getName(), new WeakReference<>(plugin));\n }\n\n @Override\n public boolean isEnabled() {\n var get = pluginRef().get();\n return get != null && get.isEnabled();\n }\n\n @Override\n public boolean equals(Object o) {\n if (!(o instanceof BukkitEventApplication that)) return false;\n return name.equals(that.name);\n }\n\n @Override\n public int hashCode() {\n return name.hashCode();\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitAdapter.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.bukkit.BetterModelBukkit;\nimport kr.toxicity.model.api.platform.*;\nimport org.bukkit.*;\nimport org.bukkit.entity.Entity;\nimport org.bukkit.entity.LivingEntity;\nimport org.bukkit.entity.Player;\nimport org.bukkit.inventory.ItemStack;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.UUID;\n\n/**\n * Provides an adapter for converting Bukkit objects to BetterModel platform objects.\n * \n * This class implements {@link PlatformAdapter} and offers static utility methods for adapting\n * entities, players, items, locations, and worlds.\n *
\n *\n * @since 2.0.0\n */\npublic final class BukkitAdapter implements PlatformAdapter {\n\n /**\n * Adapts a Bukkit entity to a {@link PlatformEntity}.\n *\n * @param entity the Bukkit entity\n * @return the platform entity\n * @since 2.0.0\n */\n public static @NotNull PlatformEntity adapt(@NotNull Entity entity) {\n return new BukkitEntity(entity);\n }\n\n /**\n * Adapts a Bukkit living entity to a {@link PlatformLivingEntity}.\n *\n * @param livingEntity the Bukkit living entity\n * @return the platform living entity\n * @since 2.0.0\n */\n public static @NotNull PlatformLivingEntity adapt(@NotNull LivingEntity livingEntity) {\n return new BukkitLivingEntity(livingEntity);\n }\n\n /**\n * Adapts a Bukkit offline player to a {@link PlatformOfflinePlayer}.\n *\n * @param player the Bukkit offline player\n * @return the platform offline player\n * @since 2.0.0\n */\n public static @NotNull PlatformOfflinePlayer adapt(@NotNull OfflinePlayer player) {\n return new BukkitOfflinePlayer(player);\n }\n\n /**\n * Adapts a Bukkit player to a {@link PlatformPlayer}.\n *\n * @param player the Bukkit player\n * @return the platform player\n * @since 2.0.0\n */\n public static @NotNull PlatformPlayer adapt(@NotNull Player player) {\n return new BukkitPlayer(player);\n }\n\n /**\n * Adapts a Bukkit item stack to a {@link PlatformItemStack}.\n *\n * @param itemStack the Bukkit item stack\n * @return the platform item stack\n * @since 2.0.0\n */\n public static @NotNull PlatformItemStack adapt(@NotNull ItemStack itemStack) {\n return new BukkitItemStack(itemStack);\n }\n\n /**\n * Adapts a Bukkit location to a {@link PlatformLocation}.\n *\n * @param location the Bukkit location\n * @return the platform location\n * @since 2.0.0\n */\n public static @NotNull PlatformLocation adapt(@NotNull Location location) {\n return new BukkitLocation(location);\n }\n\n /**\n * Adapts a Bukkit world to a {@link PlatformWorld}.\n *\n * @param world the Bukkit world\n * @return the platform world\n * @since 2.0.0\n */\n public static @NotNull PlatformWorld adapt(@NotNull World world) {\n return new BukkitWorld(world);\n }\n\n @Override\n public @Nullable PlatformPlayer player(@NotNull UUID uuid) {\n var bukkit = Bukkit.getPlayer(uuid);\n return bukkit != null ? adapt(bukkit) : null;\n }\n\n @Override\n public @NotNull PlatformOfflinePlayer offlinePlayer(@NotNull UUID uuid) {\n return adapt(Bukkit.getOfflinePlayer(uuid));\n }\n\n @Override\n public int serverViewDistance() {\n return Bukkit.getViewDistance();\n }\n\n @Override\n public boolean isTickThread() {\n return Bukkit.isPrimaryThread();\n }\n\n @Override\n public boolean isRegionSafe() {\n return !BetterModelBukkit.IS_FOLIA || isTickThread();\n }\n\n @Override\n public @NotNull PlatformItemStack air() {\n return adapt(new ItemStack(Material.AIR));\n }\n\n @Override\n public @NotNull PlatformLocation zero() {\n return adapt(new Location(null, 0, 0, 0));\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitEntity.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformEntity;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport lombok.EqualsAndHashCode;\nimport lombok.ToString;\nimport org.bukkit.entity.Entity;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.UUID;\n\n/**\n * Represents a Bukkit entity wrapped as a {@link PlatformEntity}.\n *\n * @since 2.0.0\n */\n@ToString\n@EqualsAndHashCode\npublic class BukkitEntity implements PlatformEntity {\n\n private final Entity source;\n\n /**\n * Creates a new BukkitEntity wrapper.\n *\n * @param source the source Bukkit entity\n * @since 2.0.0\n */\n public BukkitEntity(@NotNull Entity source) {\n this.source = source;\n }\n\n /**\n * Returns the underlying Bukkit entity.\n *\n * @return the source entity\n * @since 2.0.0\n */\n public Entity source() {\n return source;\n }\n\n @Override\n public @NotNull UUID uuid() {\n return source.getUniqueId();\n }\n\n @Override\n public @NotNull PlatformLocation location() {\n return BukkitAdapter.adapt(source.getLocation());\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitItemStack.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformItemStack;\nimport kr.toxicity.model.api.platform.PlatformNamespace;\nimport org.bukkit.NamespacedKey;\nimport org.bukkit.inventory.ItemStack;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a Bukkit item stack wrapped as a {@link PlatformItemStack}.\n *\n * @param source the source Bukkit item stack\n * @since 2.0.0\n */\npublic record BukkitItemStack(@NotNull ItemStack source) implements PlatformItemStack {\n @Override\n public boolean isAir() {\n return source.getType().isAir() || source.getAmount() <= 0;\n }\n\n @Override\n public @NotNull PlatformItemStack enchant(boolean enchant) {\n var meta = source.getItemMeta();\n if (meta == null) return this;\n meta.setEnchantmentGlintOverride(enchant);\n source.setItemMeta(meta);\n return this;\n }\n\n @SuppressWarnings(\"deprecation\")\n @Override\n public @NotNull PlatformItemStack modelData(int customModelData, @Nullable PlatformNamespace namespace) {\n var meta = source.getItemMeta();\n if (meta == null) return this;\n meta.setCustomModelData(customModelData);\n meta.setItemModel(namespace == null ? null : new NamespacedKey(namespace.namespace(), namespace.path()));\n source.setItemMeta(meta);\n return this;\n }\n\n @Override\n public @NotNull PlatformItemStack clone() {\n return BukkitAdapter.adapt(source.clone());\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitLivingEntity.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformLivingEntity;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport org.bukkit.entity.LivingEntity;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a Bukkit living entity wrapped as a {@link PlatformLivingEntity}.\n *\n * @since 2.0.0\n */\npublic class BukkitLivingEntity extends BukkitEntity implements PlatformLivingEntity {\n\n /**\n * Creates a new BukkitLivingEntity wrapper.\n *\n * @param source the source Bukkit living entity\n * @since 2.0.0\n */\n public BukkitLivingEntity(@NotNull LivingEntity source) {\n super(source);\n }\n\n /**\n * Returns the underlying Bukkit living entity.\n *\n * @return the source living entity\n * @since 2.0.0\n */\n @Override\n public LivingEntity source() {\n return (LivingEntity) super.source();\n }\n\n @Override\n public @NotNull PlatformLocation eyeLocation() {\n return BukkitAdapter.adapt(source().getEyeLocation());\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitLocation.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.bukkit.BetterModelBukkit;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport kr.toxicity.model.api.platform.PlatformWorld;\nimport kr.toxicity.model.api.scheduler.ModelTask;\nimport org.bukkit.Location;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a Bukkit location wrapped as a {@link PlatformLocation}.\n *\n * @param source the source Bukkit location\n * @since 2.0.0\n */\npublic record BukkitLocation(@NotNull Location source) implements PlatformLocation {\n\n @Override\n public @NotNull PlatformWorld world() {\n return BukkitAdapter.adapt(source.getWorld());\n }\n\n @Override\n public double x() {\n return source.getX();\n }\n\n @Override\n public double y() {\n return source.getY();\n }\n\n @Override\n public double z() {\n return source.getZ();\n }\n\n @Override\n public float pitch() {\n return source.getPitch();\n }\n\n @Override\n public float yaw() {\n return source.getYaw();\n }\n\n @Override\n public @NotNull PlatformLocation add(double x, double y, double z) {\n return BukkitAdapter.adapt(source.clone().add(x, y, z));\n }\n\n @Override\n public @Nullable ModelTask task(@NotNull Runnable runnable) {\n return BetterModelBukkit.platform().scheduler().task(source, runnable);\n }\n\n @Override\n public @Nullable ModelTask taskLater(long delay, @NotNull Runnable runnable) {\n return BetterModelBukkit.platform().scheduler().taskLater(source, delay, runnable);\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitOfflinePlayer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformOfflinePlayer;\nimport org.bukkit.OfflinePlayer;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.UUID;\n\n/**\n * Represents a Bukkit offline player wrapped as a {@link PlatformOfflinePlayer}.\n *\n * @param source the source Bukkit offline player\n * @since 2.0.0\n */\npublic record BukkitOfflinePlayer(@NotNull OfflinePlayer source) implements PlatformOfflinePlayer {\n @Override\n public @NotNull UUID uuid() {\n return source.getUniqueId();\n }\n\n @Override\n public @Nullable String name() {\n return source.getName();\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitPlayer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport org.bukkit.entity.Player;\nimport org.jetbrains.annotations.NotNull;\n\n\n/**\n * Represents a Bukkit player wrapped as a {@link PlatformPlayer}.\n *\n * @since 2.0.0\n */\npublic final class BukkitPlayer extends BukkitLivingEntity implements PlatformPlayer {\n\n /**\n * Creates a new BukkitPlayer wrapper.\n *\n * @param source the source Bukkit player\n * @since 2.0.0\n */\n public BukkitPlayer(@NotNull Player source) {\n super(source);\n }\n\n /**\n * Returns the underlying Bukkit player.\n *\n * @return the source player\n * @since 2.0.0\n */\n public @NotNull Player source() {\n return (Player) super.source();\n }\n\n @Override\n public @NotNull String name() {\n return source().getName();\n }\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/platform/BukkitWorld.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.platform;\n\nimport kr.toxicity.model.api.platform.PlatformWorld;\nimport org.bukkit.World;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a Bukkit world wrapped as a {@link PlatformWorld}.\n *\n * @param source the source Bukkit world\n * @since 2.0.0\n */\npublic record BukkitWorld(@NotNull World source) implements PlatformWorld {\n}\n"
},
{
"path": "api/bukkit-api/src/main/java/kr/toxicity/model/api/bukkit/scheduler/BukkitModelScheduler.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bukkit.scheduler;\n\nimport kr.toxicity.model.api.scheduler.ModelScheduler;\nimport kr.toxicity.model.api.scheduler.ModelTask;\nimport org.bukkit.Location;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a Bukkit-specific scheduler for model tasks.\n * \n * This interface extends {@link ModelScheduler} to provide methods for scheduling tasks\n * that are synchronized with specific locations (e.g., for Folia compatibility).\n *
\n *\n * @since 2.0.0\n */\npublic interface BukkitModelScheduler extends ModelScheduler {\n\n /**\n * Schedules a task to run on the next tick, synchronized with the given location.\n *\n * @param location the location to synchronize with\n * @param runnable the task to run\n * @return the scheduled task, or null if scheduling failed\n * @since 2.0.0\n */\n @Nullable ModelTask task(@NotNull Location location, @NotNull Runnable runnable);\n\n /**\n * Schedules a task to run after a delay, synchronized with the given location.\n *\n * @param location the location to synchronize with\n * @param delay the delay in ticks\n * @param runnable the task to run\n * @return the scheduled task, or null if scheduling failed\n * @since 2.0.0\n */\n @Nullable ModelTask taskLater(@NotNull Location location, long delay, @NotNull Runnable runnable);\n}\n"
},
{
"path": "api/mod-api/build.gradle.kts",
"content": "plugins {\n alias(libs.plugins.convention.publish)\n id(\"net.neoforged.moddev\")\n}\n\ndependencies {\n api(project(\":bettermodel-api\"))\n}\n\nneoForge {\n enable {\n neoFormVersion = libs.versions.neoform.get()\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/BetterModelMod.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod;\n\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.BetterModelPlatform;\nimport kr.toxicity.model.api.mod.scheduler.ModModelScheduler;\nimport net.minecraft.server.MinecraftServer;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents the Mod-specific platform interface for BetterModel.\n * \n * This interface extends {@link BetterModelPlatform} to provide access to the underlying\n * Minecraft server instance and region holder for thread-safe operations.\n *
\n *\n * @since 2.0.0\n */\npublic interface BetterModelMod extends BetterModelPlatform {\n\n /**\n * Returns the current {@link BetterModelMod} instance.\n *\n * @return the current platform instance\n * @since 2.0.0\n */\n static @NotNull BetterModelMod platform() {\n return (BetterModelMod) BetterModel.platform();\n }\n\n /**\n * Returns the underlying Minecraft server instance.\n *\n * @return the Minecraft server\n * @since 2.0.0\n */\n @NotNull MinecraftServer server();\n\n /**\n * Returns the Mod-specific scheduler.\n *\n * @return the scheduler\n * @since 2.0.0\n */\n @Override\n @NotNull ModModelScheduler scheduler();\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/entity/BaseModEntity.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.entity;\n\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport net.minecraft.world.entity.Entity;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a Mod-specific entity adapter.\n * \n * This interface extends {@link BaseEntity} to provide access to the underlying NMS entity.\n *
\n *\n * @since 2.0.0\n */\npublic interface BaseModEntity extends BaseEntity {\n\n /**\n * Returns the underlying NMS entity.\n *\n * @return the NMS entity\n * @since 2.0.0\n */\n default @NotNull Entity entity() {\n return (Entity) handle();\n }\n\n /**\n * Sets the underlying NMS entity.\n *\n * @param entity the NMS entity\n * @since 2.0.0\n */\n void entity(@NotNull Entity entity);\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/entity/BaseModPlayer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.entity;\n\nimport kr.toxicity.model.api.entity.BasePlayer;\nimport net.minecraft.server.level.ServerPlayer;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a Mod-specific player adapter.\n * \n * This interface extends {@link BaseModEntity} and {@link BasePlayer} to provide\n * access to the underlying NMS server player.\n *
\n *\n * @since 2.0.0\n */\npublic interface BaseModPlayer extends BaseModEntity, BasePlayer {\n\n /**\n * Returns the underlying NMS server player.\n *\n * @return the server player\n * @since 2.0.0\n */\n @Override\n default @NotNull ServerPlayer entity() {\n return (ServerPlayer) handle();\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModAdapter.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport com.mojang.authlib.GameProfile;\nimport kr.toxicity.model.api.mod.BetterModelMod;\nimport kr.toxicity.model.api.platform.*;\nimport net.minecraft.server.MinecraftServer;\nimport net.minecraft.server.level.ServerPlayer;\nimport net.minecraft.server.network.ServerPlayerConnection;\nimport net.minecraft.world.entity.Entity;\nimport net.minecraft.world.entity.LivingEntity;\nimport net.minecraft.world.item.ItemStack;\nimport net.minecraft.world.level.Level;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.UUID;\n\n/**\n * Provides an adapter for converting Mod/NMS objects to BetterModel platform objects.\n * \n * This class implements {@link PlatformAdapter} and offers static utility methods for adapting\n * entities, players, items, and worlds.\n *
\n *\n * @since 2.0.0\n */\npublic final class ModAdapter implements PlatformAdapter {\n\n /**\n * Adapts an NMS entity to a {@link PlatformEntity}.\n *\n * @param entity the NMS entity\n * @return the platform entity\n * @since 2.0.0\n */\n public static @NotNull PlatformEntity adapt(@NotNull Entity entity) {\n return ModEntity.of(entity);\n }\n\n /**\n * Adapts an NMS living entity to a {@link PlatformLivingEntity}.\n *\n * @param livingEntity the NMS living entity\n * @return the platform living entity\n * @since 2.0.0\n */\n public static @NotNull PlatformLivingEntity adapt(@NotNull LivingEntity livingEntity) {\n return ModLivingEntity.of(livingEntity);\n }\n\n /**\n * Adapts an NMS player connection to a {@link PlatformPlayer}.\n *\n * @param connection the NMS player connection\n * @return the platform player\n * @since 2.0.0\n */\n public static @NotNull PlatformPlayer adapt(@NotNull ServerPlayerConnection connection) {\n return ModPlayer.of(connection);\n }\n\n /**\n * Adapts an NMS server player to a {@link PlatformPlayer}.\n *\n * @param player the NMS server player\n * @return the platform player\n * @since 2.0.0\n */\n public static @NotNull PlatformPlayer adapt(@NotNull ServerPlayer player) {\n return adapt(player.connection);\n }\n\n /**\n * Adapts a UUID to a {@link PlatformOfflinePlayer}.\n *\n * @param uuid the player UUID\n * @return the platform offline player\n * @since 2.0.0\n */\n public static @NotNull PlatformOfflinePlayer adapt(@NotNull UUID uuid) {\n return ModOfflinePlayer.of(uuid, null);\n }\n\n /**\n * Adapts a GameProfile to a {@link PlatformOfflinePlayer}.\n *\n * @param profile the game profile\n * @return the platform offline player\n * @since 2.0.0\n */\n public static @NotNull PlatformOfflinePlayer adapt(@NotNull GameProfile profile) {\n return ModOfflinePlayer.of(profile.id(), profile.name());\n }\n\n /**\n * Adapts an NMS item stack to a {@link PlatformItemStack}.\n *\n * @param itemStack the NMS item stack\n * @return the platform item stack\n * @since 2.0.0\n */\n public static @NotNull PlatformItemStack adapt(@NotNull ItemStack itemStack) {\n return ModItemStack.of(itemStack);\n }\n\n /**\n * Adapts an NMS level to a {@link PlatformWorld}.\n *\n * @param world the NMS level\n * @return the platform world\n * @since 2.0.0\n */\n public static @NotNull PlatformWorld adapt(@NotNull Level world) {\n return ModWorld.of(world);\n }\n\n @Override\n public int serverViewDistance() {\n return server().getPlayerList().getViewDistance();\n }\n\n @Override\n public boolean isTickThread() {\n return server().isSameThread();\n }\n\n @Override\n public boolean isRegionSafe() {\n return true;\n }\n\n @Override\n public @Nullable PlatformPlayer player(@NotNull UUID uuid) {\n var player = server().getPlayerList().getPlayer(uuid);\n return player == null ? null : adapt(player);\n }\n\n @Override\n public @NotNull PlatformOfflinePlayer offlinePlayer(@NotNull UUID uuid) {\n var profile = server().services().profileResolver().fetchById(uuid).orElse(null);\n return profile == null ? adapt(uuid) : adapt(profile);\n }\n\n @Override\n public @NotNull PlatformItemStack air() {\n return adapt(ItemStack.EMPTY);\n }\n\n @Override\n public @NotNull PlatformLocation zero() {\n return ModLocation.of(null, 0, 0, 0);\n }\n\n private @NotNull MinecraftServer server() {\n return BetterModelMod.platform().server();\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModEntity.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformEntity;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport net.minecraft.world.entity.Entity;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.UUID;\n\n/**\n * Represents a Mod entity wrapped as a {@link PlatformEntity}.\n *\n * @param source the source NMS entity\n * @since 2.0.0\n */\npublic record ModEntity(@NotNull Entity source) implements PlatformEntity {\n @ApiStatus.Internal\n public ModEntity {\n }\n\n /**\n * Creates a ModEntity from the source.\n *\n * @param source the source entity\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModEntity of(@NotNull Entity source) {\n return new ModEntity(source);\n }\n\n @Override\n public @NotNull UUID uuid() {\n return source.getUUID();\n }\n\n @Override\n public @NotNull PlatformLocation location() {\n return ModLocation.of(source);\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModItemStack.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformItemStack;\nimport kr.toxicity.model.api.platform.PlatformNamespace;\nimport net.minecraft.core.component.DataComponents;\nimport net.minecraft.resources.Identifier;\nimport net.minecraft.world.item.ItemStack;\nimport net.minecraft.world.item.component.CustomModelData;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.List;\n\n/**\n * Represents a Mod item stack wrapped as a {@link PlatformItemStack}.\n *\n * @param source the source NMS item stack\n * @since 2.0.0\n */\npublic record ModItemStack(@NotNull ItemStack source) implements PlatformItemStack {\n @ApiStatus.Internal\n public ModItemStack {\n }\n\n /**\n * Creates a ModItemStack from the source.\n *\n * @param source the source item stack\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModItemStack of(@NotNull ItemStack source) {\n return new ModItemStack(source);\n }\n\n @Override\n public boolean isAir() {\n return source.isEmpty();\n }\n\n @Override\n public @NotNull PlatformItemStack enchant(boolean enchant) {\n source.set(DataComponents.ENCHANTMENT_GLINT_OVERRIDE, enchant);\n return this;\n }\n\n @Override\n public @NotNull PlatformItemStack modelData(int customModelData, @Nullable PlatformNamespace namespace) {\n source.set(\n DataComponents.CUSTOM_MODEL_DATA,\n new CustomModelData(List.of((float) customModelData), List.of(), List.of(), List.of())\n );\n source.set(\n DataComponents.ITEM_MODEL,\n namespace == null ? null : Identifier.fromNamespaceAndPath(namespace.namespace(), namespace.path())\n );\n return this;\n }\n\n @Override\n public @NotNull PlatformItemStack clone() {\n return ModAdapter.adapt(source.copy());\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModLivingEntity.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformLivingEntity;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport net.minecraft.world.entity.LivingEntity;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.UUID;\n\n/**\n * Represents a Mod living entity wrapped as a {@link PlatformLivingEntity}.\n *\n * @param source the source NMS living entity\n * @since 2.0.0\n */\npublic record ModLivingEntity(@NotNull LivingEntity source) implements PlatformLivingEntity {\n @ApiStatus.Internal\n public ModLivingEntity {\n }\n\n /**\n * Creates a ModLivingEntity from the source.\n *\n * @param source the source living entity\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModLivingEntity of(@NotNull LivingEntity source) {\n return new ModLivingEntity(source);\n }\n\n @Override\n public @NotNull UUID uuid() {\n return source.getUUID();\n }\n\n @Override\n public @NotNull PlatformLocation location() {\n return ModLocation.of(source);\n }\n\n @Override\n public @NotNull PlatformLocation eyeLocation() {\n return ModLocation.ofEye(source);\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModLocation.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.mod.BetterModelMod;\nimport kr.toxicity.model.api.mod.scheduler.ModModelScheduler;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport kr.toxicity.model.api.platform.PlatformWorld;\nimport kr.toxicity.model.api.scheduler.ModelTask;\nimport net.minecraft.world.entity.Entity;\nimport net.minecraft.world.level.Level;\nimport net.minecraft.world.phys.Vec3;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a Mod location wrapped as a {@link PlatformLocation}.\n *\n * @param level the NMS level\n * @param x the x coordinate\n * @param y the y coordinate\n * @param z the z coordinate\n * @param pitch the pitch\n * @param yaw the yaw\n * @since 2.0.0\n */\npublic record ModLocation(@Nullable Level level, double x, double y, double z, float pitch, float yaw) implements PlatformLocation {\n @ApiStatus.Internal\n public ModLocation {\n }\n\n /**\n * Creates a ModLocation from the coordinates.\n *\n * @param level the NMS level\n * @param x the x coordinate\n * @param y the y coordinate\n * @param z the z coordinate\n * @param pitch the pitch\n * @param yaw the yaw\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModLocation of(@Nullable Level level, double x, double y, double z, float pitch, float yaw) {\n return new ModLocation(\n level,\n x,\n y,\n z,\n pitch,\n yaw\n );\n }\n\n /**\n * Creates a ModLocation from the coordinates with zero pitch and yaw.\n *\n * @param level the NMS level\n * @param x the x coordinate\n * @param y the y coordinate\n * @param z the z coordinate\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModLocation of(@Nullable Level level, double x, double y, double z) {\n return new ModLocation(\n level,\n x,\n y,\n z,\n 0.0f,\n 0.0f\n );\n }\n\n /**\n * Creates a ModLocation from the position vector.\n *\n * @param level the NMS level\n * @param position the position vector\n * @param pitch the pitch\n * @param yaw the yaw\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModLocation of(@Nullable Level level, Vec3 position, float pitch, float yaw) {\n return new ModLocation(\n level,\n position.x,\n position.y,\n position.z,\n pitch,\n yaw\n );\n }\n\n /**\n * Creates a ModLocation from the position vector with zero pitch and yaw.\n *\n * @param level the NMS level\n * @param position the position vector\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModLocation of(@Nullable Level level, Vec3 position) {\n return new ModLocation(\n level,\n position.x,\n position.y,\n position.z,\n 0.0f,\n 0.0f\n );\n }\n\n /**\n * Creates a ModLocation from an entity's position.\n *\n * @param entity the entity\n * @return the location\n * @since 2.0.0\n */\n public static @NotNull ModLocation of(@NotNull Entity entity) {\n return new ModLocation(\n entity.level(),\n entity.getX(),\n entity.getY(),\n entity.getZ(),\n entity.getXRot(),\n entity.getYRot()\n );\n }\n\n /**\n * Creates a ModLocation from an entity's eye position.\n *\n * @param entity the entity\n * @return the eye location\n * @since 2.0.0\n */\n public static @NotNull ModLocation ofEye(@NotNull Entity entity) {\n return new ModLocation(\n entity.level(),\n entity.getX(),\n entity.getEyeY(),\n entity.getZ(),\n entity.getXRot(),\n entity.getYRot()\n );\n }\n\n @Override\n public @NotNull PlatformWorld world() {\n if (level == null) {\n throw new IllegalStateException(\"level is not set\");\n }\n\n return ModAdapter.adapt(level);\n }\n\n @Override\n public @NotNull PlatformLocation add(double x, double y, double z) {\n return new ModLocation(\n this.level,\n this.x + x,\n this.y + y,\n this.z + z,\n this.pitch,\n this.yaw\n );\n }\n\n @Override\n public @Nullable ModelTask task(@NotNull Runnable runnable) {\n return scheduler().task(runnable);\n }\n\n @Override\n public @Nullable ModelTask taskLater(long delay, @NotNull Runnable runnable) {\n return scheduler().taskLater(delay, runnable);\n }\n\n private @NotNull ModModelScheduler scheduler() {\n return BetterModelMod.platform().scheduler();\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModOfflinePlayer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformOfflinePlayer;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.UUID;\n\n/**\n * Represents a Mod offline player wrapped as a {@link PlatformOfflinePlayer}.\n *\n * @param uuid the player UUID\n * @param name the player name, or null if unknown\n * @since 2.0.0\n */\npublic record ModOfflinePlayer(@NotNull UUID uuid, @Nullable String name) implements PlatformOfflinePlayer {\n @ApiStatus.Internal\n public ModOfflinePlayer {\n }\n\n /**\n * Creates a ModOfflinePlayer from the UUID and name.\n *\n * @param uuid the player uuid\n * @param name the player name\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModOfflinePlayer of(@NotNull UUID uuid, @Nullable String name) {\n return new ModOfflinePlayer(uuid, name);\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModPlayer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport net.minecraft.server.network.ServerPlayerConnection;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.UUID;\n\n/**\n * Represents a Mod player wrapped as a {@link PlatformPlayer}.\n *\n * @param source the source NMS player connection\n * @since 2.0.0\n */\npublic record ModPlayer(@NotNull ServerPlayerConnection source) implements PlatformPlayer {\n @ApiStatus.Internal\n public ModPlayer {\n }\n\n /**\n * Creates a ModPlayer from the source.\n *\n * @param source the source player connection\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModPlayer of(@NotNull ServerPlayerConnection source) {\n return new ModPlayer(source);\n }\n\n @Override\n public @NotNull UUID uuid() {\n return source.getPlayer().getUUID();\n }\n\n @Override\n public @NotNull PlatformLocation location() {\n return ModLocation.of(source.getPlayer());\n }\n\n @Override\n public @NotNull PlatformLocation eyeLocation() {\n return ModLocation.ofEye(source.getPlayer());\n }\n\n @Override\n public @NotNull String name() {\n return source.getPlayer().getPlainTextName();\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModRegionHolder.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformRegionHolder;\n\n/**\n * Represents a Mod-specific region holder for managing thread-safe operations.\n * \n * This interface extends {@link PlatformRegionHolder} to provide Mod-specific functionality\n * for scheduling tasks within specific regions or contexts.\n *
\n *\n * @since 2.0.0\n */\npublic interface ModRegionHolder extends PlatformRegionHolder {\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/platform/ModWorld.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.platform;\n\nimport kr.toxicity.model.api.platform.PlatformWorld;\nimport net.minecraft.world.level.Level;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a Fabric world wrapped as a {@link PlatformWorld}.\n *\n * @param level the source NMS level\n * @since 2.0.0\n */\npublic record ModWorld(@NotNull Level level) implements PlatformWorld {\n @ApiStatus.Internal\n public ModWorld {\n }\n\n /**\n * Creates a FabricWorld from the level.\n *\n * @param level the source level\n * @return the instance\n * @since 2.0.0\n */\n public static @NotNull ModWorld of(@NotNull Level level) {\n return new ModWorld(level);\n }\n}\n"
},
{
"path": "api/mod-api/src/main/java/kr/toxicity/model/api/mod/scheduler/ModModelScheduler.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.mod.scheduler;\n\nimport kr.toxicity.model.api.scheduler.ModelScheduler;\nimport kr.toxicity.model.api.scheduler.ModelTask;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a Mod-specific scheduler for model tasks.\n * \n * This interface extends {@link ModelScheduler} to provide methods for scheduling tasks\n * within the Mod environment.\n *
\n *\n * @since 2.0.0\n */\npublic interface ModModelScheduler extends ModelScheduler {\n\n /**\n * Schedules a task to run on the next tick.\n *\n * @param runnable the task to run\n * @return the scheduled task, or null if scheduling failed\n * @since 2.0.0\n */\n @Nullable ModelTask task(@NotNull Runnable runnable);\n\n /**\n * Schedules a task to run after a delay.\n *\n * @param delay the delay in ticks\n * @param runnable the task to run\n * @return the scheduled task, or null if scheduling failed\n * @since 2.0.0\n */\n @Nullable ModelTask taskLater(long delay, @NotNull Runnable runnable);\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModel.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport kr.toxicity.model.api.data.renderer.ModelRenderer;\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport kr.toxicity.model.api.nms.NMS;\nimport kr.toxicity.model.api.nms.PlayerChannelHandler;\nimport kr.toxicity.model.api.platform.PlatformEntity;\nimport kr.toxicity.model.api.tracker.EntityTrackerRegistry;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.*;\n\n/**\n * The main entry point for the BetterModel API.\n * \n * This class provides static access to the platform instance, configuration, model managers,\n * NMS handlers, and entity registries. It serves as a service provider for interacting with the BetterModel engine.\n *
\n *\n * @since 1.15.2\n */\npublic final class BetterModel {\n\n /**\n * Private initializer to prevent instantiation.\n */\n private BetterModel() {\n throw new RuntimeException();\n }\n\n /**\n * The singleton platform instance.\n */\n private static BetterModelPlatform instance;\n\n /**\n * Returns the platform configuration manager.\n *\n * @return the configuration manager\n * @since 1.15.2\n */\n public static @NotNull BetterModelConfig config() {\n return platform().config();\n }\n\n /**\n * Retrieves a model renderer by its name, wrapped in an Optional.\n *\n * @param name the name of the model\n * @return an optional containing the renderer if found\n * @since 1.15.2\n */\n public static @NotNull Optional model(@NotNull String name) {\n return Optional.ofNullable(modelOrNull(name));\n }\n\n /**\n * Retrieves a model renderer by its name, or null if not found.\n *\n * @param name the name of the model\n * @return the renderer, or null\n * @since 1.15.2\n */\n public static @Nullable ModelRenderer modelOrNull(@NotNull String name) {\n return platform().modelManager().model(name);\n }\n\n /**\n * Retrieves a player limb renderer by its name, wrapped in an Optional.\n *\n * @param name the name of the limb model\n * @return an optional containing the renderer if found\n * @since 1.15.2\n */\n public static @NotNull Optional limb(@NotNull String name) {\n return Optional.ofNullable(limbOrNull(name));\n }\n\n /**\n * Retrieves a player limb renderer by its name, or null if not found.\n *\n * @param name the name of the limb model\n * @return the renderer, or null\n * @since 1.15.2\n */\n public static @Nullable ModelRenderer limbOrNull(@NotNull String name) {\n return platform().modelManager().limb(name);\n }\n\n /**\n * Retrieves a player channel handler by the player's UUID.\n *\n * @param uuid the player's UUID\n * @return an optional containing the channel handler if found\n * @since 1.15.2\n */\n public static @NotNull Optional player(@NotNull UUID uuid) {\n return Optional.ofNullable(platform().playerManager().player(uuid));\n }\n\n /**\n * Retrieves an entity tracker registry by the entity's UUID.\n *\n * @param uuid the entity's UUID\n * @return an optional containing the registry if found\n * @since 1.15.2\n */\n public static @NotNull Optional registry(@NotNull UUID uuid) {\n return Optional.ofNullable(registryOrNull(uuid));\n }\n\n /**\n * Retrieves an entity tracker registry for a Bukkit entity.\n *\n * @param entity the Bukkit entity\n * @return an optional containing the registry if found\n * @since 1.15.2\n */\n public static @NotNull Optional registry(@NotNull PlatformEntity entity) {\n return Optional.ofNullable(registryOrNull(entity));\n }\n\n /**\n * Retrieves an entity tracker registry for a base entity.\n *\n * @param entity the base entity\n * @return an optional containing the registry if found\n * @since 1.15.2\n */\n public static @NotNull Optional registry(@NotNull BaseEntity entity) {\n return Optional.ofNullable(registryOrNull(entity));\n }\n\n /**\n * Retrieves an entity tracker registry by the entity's UUID, or null if not found.\n *\n * @param uuid the entity's UUID\n * @return the registry, or null\n * @since 1.15.2\n */\n public static @Nullable EntityTrackerRegistry registryOrNull(@NotNull UUID uuid) {\n return EntityTrackerRegistry.registry(uuid);\n }\n\n /**\n * Retrieves an entity tracker registry for a Bukkit entity, or null if not found.\n *\n * @param entity the Bukkit entity\n * @return the registry, or null\n * @since 1.15.2\n */\n public static @Nullable EntityTrackerRegistry registryOrNull(@NotNull PlatformEntity entity) {\n return registryOrNull(nms().adapt(entity));\n }\n\n /**\n * Retrieves an entity tracker registry for a base entity, or null if not found.\n *\n * @param entity the base entity\n * @return the registry, or null\n * @since 1.15.2\n */\n public static @Nullable EntityTrackerRegistry registryOrNull(@NotNull BaseEntity entity) {\n return EntityTrackerRegistry.registry(entity);\n }\n\n /**\n * Returns a collection of all loaded model renderers.\n *\n * @return an unmodifiable collection of models\n * @since 1.15.2\n */\n public static @NotNull @Unmodifiable Collection models() {\n return platform().modelManager().models();\n }\n\n /**\n * Returns a collection of all loaded player limb renderers.\n *\n * @return an unmodifiable collection of limb models\n * @since 1.15.2\n */\n public static @NotNull @Unmodifiable Collection limbs() {\n return platform().modelManager().limbs();\n }\n\n /**\n * Returns a set of all loaded model names.\n *\n * @return an unmodifiable set of model keys\n * @since 1.15.2\n */\n public static @NotNull @Unmodifiable Set modelKeys() {\n return platform().modelManager().modelKeys();\n }\n\n /**\n * Returns a set of all loaded player limb model names.\n *\n * @return an unmodifiable set of limb keys\n * @since 1.15.2\n */\n public static @NotNull @Unmodifiable Set limbKeys() {\n return platform().modelManager().limbKeys();\n }\n\n /**\n * Returns the singleton instance of the BetterModel platform.\n *\n * @return the platform instance\n * @throws NullPointerException if the platform has not been initialized\n * @since 2.0.0\n */\n public static @NotNull BetterModelPlatform platform() {\n return Objects.requireNonNull(instance, \"BetterModel hasn't been initialized yet!\");\n }\n\n /**\n * Returns the NMS handler instance.\n *\n * @return the NMS handler\n * @since 1.15.2\n */\n public static @NotNull NMS nms() {\n return platform().nms();\n }\n\n /**\n * Returns the event bus.\n *\n * @return the event bus\n * @since 2.0.0\n */\n public static @NotNull BetterModelEventBus eventBus() {\n return platform().eventBus();\n }\n\n /**\n * Registers the platform instance.\n * \n * This method is intended for internal use only during platform initialization.\n *
\n *\n * @param instance the platform instance\n * @throws RuntimeException if an instance is already registered\n * @since 1.15.2\n */\n @ApiStatus.Internal\n public static void register(@NotNull BetterModelPlatform instance) {\n Objects.requireNonNull(instance, \"instance cannot be null.\");\n if (BetterModel.instance == instance) throw new RuntimeException(\"Duplicated instance.\");\n BetterModel.instance = instance;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModelConfig.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport kr.toxicity.model.api.config.DebugConfig;\nimport kr.toxicity.model.api.config.IndicatorConfig;\nimport kr.toxicity.model.api.config.ModuleConfig;\nimport kr.toxicity.model.api.config.PackConfig;\nimport kr.toxicity.model.api.mount.MountController;\nimport kr.toxicity.model.api.platform.PlatformItemStack;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.Supplier;\n\n/**\n * Represents the main configuration interface for BetterModel.\n * \n * This interface provides access to various configuration settings, including debug options,\n * pack generation settings, module toggles, and runtime behaviors.\n *
\n *\n * @since 1.15.2\n */\npublic interface BetterModelConfig {\n\n /**\n * Returns the debug configuration.\n *\n * @return the debug config\n * @since 1.15.2\n */\n @NotNull DebugConfig debug();\n\n /**\n * Returns the indicator configuration.\n *\n * @return the indicator config\n * @since 1.15.2\n */\n @NotNull IndicatorConfig indicator();\n\n /**\n * Returns the module configuration.\n *\n * @return the module config\n * @since 1.15.2\n */\n @NotNull ModuleConfig module();\n\n /**\n * Returns the resource pack configuration.\n *\n * @return the pack config\n * @since 1.15.2\n */\n @NotNull PackConfig pack();\n\n /**\n * Checks if metrics collection is enabled.\n *\n * @return true if enabled, false otherwise\n * @since 1.15.2\n */\n boolean metrics();\n\n /**\n * Checks if sight tracing (visibility checking) is enabled.\n *\n * @return true if enabled, false otherwise\n * @since 1.15.2\n */\n boolean sightTrace();\n\n /**\n * Checks if BetterModel should attempt to merge its resource pack with external plugins/mods.\n *\n * @return true to merge, false otherwise\n * @since 1.15.2\n */\n boolean mergeWithExternalResources();\n\n /**\n * Returns a supplier for the platform item stack used as the base for model items.\n *\n * @return a supplier providing the target item stack\n * @since 2.0.0\n */\n @NotNull Supplier item();\n\n /**\n * Returns the item model string identifier used for the resource pack target item.\n *\n * @return the item model string\n * @since 2.0.0\n */\n @NotNull String itemModel();\n\n /**\n * Returns the namespace used for the target item.\n *\n * @return the item namespace\n * @since 1.15.2\n */\n @NotNull String itemNamespace();\n\n /**\n * Returns the maximum range for sight tracing.\n *\n * @return the max range\n * @since 1.15.2\n */\n double maxSight();\n\n /**\n * Returns the minimum range for sight tracing.\n *\n * @return the min range\n * @since 1.15.2\n */\n double minSight();\n\n /**\n * Returns the namespace used for the generated resource pack.\n *\n * @return the namespace\n * @since 1.15.2\n */\n @NotNull String namespace();\n\n /**\n * Returns the type of resource pack generation (Folder, Zip, or None).\n *\n * @return the pack type\n * @since 1.15.2\n */\n @NotNull PackType packType();\n\n /**\n * Returns the location of the build folder for resource packs.\n *\n * @return the build folder path\n * @since 1.15.2\n */\n @NotNull String buildFolderLocation();\n\n /**\n * Checks if model trackers should follow the source entity's invisibility status.\n *\n * @return true to follow invisibility, false otherwise\n * @since 1.15.2\n */\n boolean followMobInvisibility();\n\n /**\n * Checks if Purpur's AFK API should be used.\n *\n * @return true to use Purpur AFK, false otherwise\n * @since 1.15.2\n */\n boolean usePurpurAfk();\n\n /**\n * Checks if version update notifications should be sent to OPs on join.\n *\n * @return true to send notifications, false otherwise\n * @since 1.15.2\n */\n boolean versionCheck();\n\n /**\n * Returns the default mount controller used for entities.\n *\n * @return the default mount controller\n * @see kr.toxicity.model.api.mount.MountControllers\n * @since 1.15.2\n */\n @NotNull MountController defaultMountController();\n\n /**\n * Returns the interpolation frame time (lerp) in milliseconds.\n *\n * @return the lerp frame time\n * @since 1.15.2\n */\n int lerpFrameTime();\n\n /**\n * Checks if inventory swap packets should be cancelled for players with active models.\n *\n * @return true to cancel, false otherwise\n * @since 1.15.2\n */\n boolean cancelPlayerModelInventory();\n\n /**\n * Returns the delay in ticks before hiding a player's model after they become invisible.\n *\n * @return the hide delay\n * @since 1.15.2\n */\n long playerHideDelay();\n\n /**\n * Returns the threshold size for packet bundling.\n *\n * @return the packet bundling size\n * @since 1.15.2\n */\n int packetBundlingSize();\n\n /**\n * Checks if strict loading mode is enabled.\n * \n * Strict loading causes the platform to fail fast on model loading errors.\n *
\n *\n * @return true if strict loading is enabled, false otherwise\n * @since 1.15.2\n */\n boolean enableStrictLoading();\n\n /**\n * Enumerates the types of resource pack generation.\n *\n * @since 1.15.2\n */\n enum PackType {\n /**\n * Generate the resource pack as a folder structure.\n * @since 1.15.2\n */\n FOLDER,\n /**\n * Generate the resource pack as a ZIP archive.\n * @since 1.15.2\n */\n ZIP,\n /**\n * Do not generate a resource pack.\n * @since 1.15.2\n */\n NONE\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModelEvaluator.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport kr.toxicity.model.api.util.function.Float2FloatFunction;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Evaluator\n */\npublic interface BetterModelEvaluator {\n /**\n * Compiles molang expression\n * @param expression expression\n * @return compiled function\n */\n @NotNull Float2FloatFunction compile(@NotNull String expression);\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModelEventBus.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport kr.toxicity.model.api.event.ModelEvent;\nimport kr.toxicity.model.api.event.ModelEventApplication;\nimport kr.toxicity.model.api.event.ModelEventListener;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.Consumer;\nimport java.util.function.Supplier;\n\n/**\n * A central event bus for handling model-related events.\n * \n * This interface allows subscribing to and publishing {@link ModelEvent}s.\n * It serves as a decoupling mechanism between different parts of the engine.\n *
\n *\n * @since 2.0.0\n */\npublic interface BetterModelEventBus {\n\n /**\n * Subscribes a consumer to a specific event type.\n *\n * @param application the application that subscribes to the event\n * @param eventClass the class of the event to subscribe to\n * @param consumer the consumer to handle the event\n * @param the type of the event\n * @return a listener handle that can be used to unregister the subscription\n * @since 2.0.0\n */\n @NotNull\n ModelEventListener subscribe(@NotNull ModelEventApplication application, @NotNull Class eventClass, @NotNull Consumer consumer);\n\n /**\n * Publishes an event to all registered subscribers.\n * \n * The event is created lazily using the provided supplier if there are subscribers.\n *
\n *\n * @param eventClass the class of the event\n * @param eventSupplier a supplier that creates the event\n * @param the type of the event\n * @return the result of the event call\n * @since 2.0.0\n */\n @NotNull Result call(@NotNull Class eventClass, @NotNull Supplier eventSupplier);\n\n /**\n * Publishes an event to all registered subscribers.\n *\n * @param event the event to publish\n * @return the result of the event call\n * @since 2.0.0\n */\n default @NotNull Result call(@NotNull ModelEvent event) {\n return call(event.getClass(), () -> event);\n }\n\n /**\n * Represents the outcome of an event publication.\n *\n * @since 2.0.0\n */\n @RequiredArgsConstructor\n enum Result {\n /**\n * The event was successfully processed by at least one subscriber.\n * @since 2.0.0\n */\n SUCCESS(true),\n /**\n * The event processing failed or was canceled.\n * @since 2.0.0\n */\n FAIL(false),\n /**\n * No handlers were registered for this event type.\n * @since 2.0.0\n */\n NO_EVENT_HANDLER(true)\n ;\n\n private final boolean triggered;\n\n /**\n * Checks if the event was considered \"triggered\" (i.e., not canceled or failed).\n * \n * Note that {@link #NO_EVENT_HANDLER} is considered triggered as the operation wasn't blocked.\n *
\n *\n * @return true if triggered, false otherwise\n * @since 2.0.0\n */\n public boolean triggered() {\n return triggered;\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModelLogger.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport net.kyori.adventure.text.Component;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * BetterModel's logger\n */\npublic interface BetterModelLogger {\n /**\n * Infos messages\n * @param message message\n */\n void info(@NotNull Component... message);\n\n /**\n * Warns message\n * @param message message\n */\n void warn(@NotNull Component... message);\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/BetterModelPlatform.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api;\n\nimport kr.toxicity.model.api.event.ModelEventApplication;\nimport kr.toxicity.model.api.manager.*;\nimport kr.toxicity.model.api.nms.NMS;\nimport kr.toxicity.model.api.pack.PackResult;\nimport kr.toxicity.model.api.pack.PackZipper;\nimport kr.toxicity.model.api.platform.PlatformAdapter;\nimport kr.toxicity.model.api.scheduler.ModelScheduler;\nimport kr.toxicity.model.api.version.MinecraftVersion;\nimport lombok.RequiredArgsConstructor;\nimport net.kyori.adventure.audience.Audience;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.semver4j.Semver;\n\nimport java.io.File;\nimport java.io.InputStream;\nimport java.util.function.Consumer;\n\n/**\n * Represents the main platform interface for BetterModel.\n *\n * @see BetterModel\n * @since 1.15.2\n */\npublic interface BetterModelPlatform extends ModelEventApplication {\n\n /**\n * Returns the data folder for the BetterModel plugin.\n * This is where configuration files, data files, and other plugin-specific resources are stored.\n *\n * @return the data folder as a {@link File} object.\n * @since 2.0.0\n */\n @NotNull File dataFolder();\n\n /**\n * Returns the type of JAR file this platform is running on (e.g., SPIGOT, PAPER, FABRIC).\n *\n * @return the {@link JarType} enum representing the platform's JAR type.\n * @since 2.0.0\n */\n @NotNull JarType jarType();\n\n /**\n * Reloads the platform with default settings (console sender).\n *\n * @return the result of the reload operation\n * @since 2.0.0\n */\n default @NotNull ReloadResult reload() {\n return reload(ReloadInfo.DEFAULT);\n }\n\n /**\n * Reloads the platform, specifying the command sender who initiated it.\n *\n * @param sender the command sender\n * @return the result of the reload operation\n * @since 1.15.2\n */\n default @NotNull ReloadResult reload(@NotNull Audience sender) {\n return reload(ReloadInfo.builder().sender(sender).build());\n }\n\n /**\n * Reloads the platform with specific reload information.\n *\n * @param info the reload configuration\n * @return the result of the reload operation\n * @since 1.15.2\n */\n @NotNull ReloadResult reload(@NotNull ReloadInfo info);\n\n\n /**\n * Checks if the running version of BetterModel is a snapshot build.\n *\n * @return true if snapshot, false otherwise\n * @since 1.15.2\n */\n boolean isSnapshot();\n\n /**\n * Returns the platform's configuration manager.\n *\n * @return the configuration\n * @since 1.15.2\n */\n @NotNull BetterModelConfig config();\n\n /**\n * Returns the Minecraft version of the running server.\n *\n * @return the Minecraft version\n * @since 1.15.2\n */\n @NotNull MinecraftVersion version();\n\n /**\n * Returns the semantic version of the platform.\n *\n * @return the semantic version\n * @since 1.15.2\n */\n @NotNull Semver semver();\n\n /**\n * Returns the NMS (Net.Minecraft.Server) handler for version-specific operations.\n *\n * @return the NMS handler\n * @since 1.15.2\n */\n @NotNull NMS nms();\n\n /**\n * Returns the model manager.\n *\n * @return the model manager\n * @since 1.15.2\n */\n @NotNull ModelManager modelManager();\n\n /**\n * Returns the player manager.\n *\n * @return the player manager\n * @since 1.15.2\n */\n @NotNull PlayerManager playerManager();\n\n /**\n * Returns the script manager.\n *\n * @return the script manager\n * @since 1.15.2\n */\n @NotNull ScriptManager scriptManager();\n\n /**\n * Returns the skin manager.\n *\n * @return the skin manager\n * @since 1.15.2\n */\n @NotNull SkinManager skinManager();\n /**\n * Returns the profile manager.\n *\n * @return the profile manager\n * @since 1.15.2\n */\n @NotNull ProfileManager profileManager();\n\n /**\n * Returns the platform's scheduler.\n *\n * @return the scheduler\n * @since 1.15.2\n */\n @NotNull ModelScheduler scheduler();\n\n /**\n * Return the platform's adapter\n * @return the adapter\n */\n @NotNull PlatformAdapter adapter();\n\n /**\n * Registers a handler to be executed when a reload starts.\n *\n * @param consumer the handler, receiving the {@link PackZipper}\n * @since 1.15.2\n */\n void addReloadStartHandler(@NotNull Consumer consumer);\n\n /**\n * Registers a handler to be executed when a reload ends.\n *\n * @param consumer the handler, receiving the {@link ReloadResult}\n * @since 1.15.2\n */\n void addReloadEndHandler(@NotNull Consumer consumer);\n\n /**\n * Returns the platform's logger.\n *\n * @return the logger\n * @since 1.15.2\n */\n @NotNull BetterModelLogger logger();\n\n /**\n * Returns the expression evaluator.\n *\n * @return the evaluator\n * @since 1.15.2\n */\n @NotNull BetterModelEvaluator evaluator();\n\n /**\n * Returns the event bus.\n *\n * @return the event bus\n * @since 2.0.0\n */\n @NotNull BetterModelEventBus eventBus();\n\n /**\n * Retrieves a resource from the platform's JAR file.\n *\n * @param path the path to the resource\n * @return an input stream for the resource, or null if not found\n * @since 1.15.2\n */\n @Nullable InputStream getResource(@NotNull String path);\n\n /**\n * Represents the outcome of a platform reload operation.\n *\n * @since 1.15.2\n */\n sealed interface ReloadResult {\n\n /**\n * Indicates a successful reload.\n *\n * @param firstLoad true if this is the first load (startup), false otherwise\n * @param assetsTime the time taken to reload assets in milliseconds\n * @param packResult the result of the resource pack generation\n * @since 1.15.2\n */\n record Success(boolean firstLoad, long assetsTime, @NotNull PackResult packResult) implements ReloadResult {\n\n /**\n * Returns the time taken to generate the resource pack.\n *\n * @return the packing time in milliseconds\n * @since 1.15.2\n */\n public long packingTime() {\n return packResult().time();\n }\n\n /**\n * Returns the total time taken for the reload operation.\n *\n * @return the total time in milliseconds\n * @since 1.15.2\n */\n public long totalTime() {\n return assetsTime + packingTime();\n }\n\n /**\n * Returns the size of the generated resource pack.\n *\n * @return the size in bytes\n * @since 1.15.2\n */\n public long length() {\n var dir = packResult.directory();\n return dir != null && dir.isFile() ? dir.length() : packResult.stream().mapToLong(b -> b.bytes().length).sum();\n }\n }\n\n /**\n * Indicates that a reload is currently in progress.\n * @since 1.15.2\n */\n enum OnReload implements ReloadResult {\n /**\n * Singleton instance.\n * @since 1.15.2\n */\n INSTANCE\n }\n\n /**\n * Indicates a failed reload.\n *\n * @param throwable the exception that caused the failure\n * @since 1.15.2\n */\n record Failure(@NotNull Throwable throwable) implements ReloadResult {\n }\n }\n\n /**\n * Represents the type of JAR file the platform is running on.\n * This enum helps identify the specific server implementation (e.g., Spigot, Paper, Fabric).\n *\n * @since 2.0.0\n */\n @RequiredArgsConstructor\n enum JarType {\n /**\n * Indicates a Spigot-based server.\n * @since 2.0.0\n */\n SPIGOT(\"spigot\"),\n /**\n * Indicates a Paper-based server.\n * @since 2.0.0\n */\n PAPER(\"paper\"),\n /**\n * Indicates a Fabric-based server.\n * @since 2.0.0\n */\n FABRIC(\"fabric\");\n\n private final String raw;\n\n /**\n * Returns the raw string representation of the JAR type.\n *\n * @return the raw string (e.g., \"spigot\", \"paper\", \"fabric\")\n * @since 2.0.0\n */\n public String raw() {\n return raw;\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationIterator.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport com.google.gson.annotations.SerializedName;\nimport lombok.AccessLevel;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.Iterator;\n\n/**\n * An iterator for traversing animation keyframes.\n * \n * This interface supports different looping modes (play once, loop, hold on last)\n * and allows resetting the iteration state.\n *
\n *\n * @param the type of keyframe (must implement {@link Timed})\n * @since 1.15.2\n */\npublic sealed interface AnimationIterator extends Iterator {\n\n /**\n * Resets the iterator to its initial state.\n * @since 1.15.2\n */\n void clear();\n\n /**\n * Returns the type of this animation iterator.\n *\n * @return the animation type\n * @since 1.15.2\n */\n @NotNull Type type();\n\n /**\n * Defines the behavior of the animation iterator.\n * @since 1.15.2\n */\n @RequiredArgsConstructor\n enum Type {\n /**\n * Plays the animation once and then stops.\n * @since 1.15.2\n */\n @SerializedName(\"once\")\n PLAY_ONCE {\n @Override\n public @NotNull AnimationIterator create(@NotNull TimedStorage keyframes) {\n return new PlayOnce<>(keyframes);\n }\n },\n /**\n * Loops the animation continuously.\n * @since 1.15.2\n */\n @SerializedName(\"loop\")\n LOOP {\n @Override\n public @NotNull AnimationIterator create(@NotNull TimedStorage keyframes) {\n return new Loop<>(keyframes);\n }\n },\n /**\n * Plays the animation once and holds the last frame.\n * @since 1.15.2\n */\n @SerializedName(\"hold\")\n HOLD_ON_LAST {\n @Override\n public @NotNull AnimationIterator create(@NotNull TimedStorage keyframes) {\n return new HoldOnLast<>(keyframes);\n }\n }\n ;\n\n /**\n * Creates a new iterator for the given keyframes based on this type.\n *\n * @param keyframes the keyframes to iterate over\n * @param the type of keyframe\n * @return a new animation iterator\n * @since 1.15.2\n */\n public abstract @NotNull AnimationIterator create(@NotNull TimedStorage keyframes);\n }\n\n /**\n * Implementation for {@link Type#PLAY_ONCE}.\n *\n * @param the type of keyframe\n * @since 1.15.2\n */\n @RequiredArgsConstructor(access = AccessLevel.PRIVATE)\n final class PlayOnce implements AnimationIterator {\n private final TimedStorage keyframe;\n private int index = 0;\n\n @Override\n public void clear() {\n index = Integer.MAX_VALUE;\n }\n\n @Override\n public boolean hasNext() {\n return index < keyframe.size();\n }\n\n @Override\n @NotNull\n public T next() {\n return keyframe.get(index++);\n }\n\n @NotNull\n @Override\n public Type type() {\n return Type.PLAY_ONCE;\n }\n }\n\n /**\n * Implementation for {@link Type#HOLD_ON_LAST}.\n *\n * @param the type of keyframe\n * @since 1.15.2\n */\n @RequiredArgsConstructor(access = AccessLevel.PRIVATE)\n final class HoldOnLast implements AnimationIterator {\n private final TimedStorage keyframe;\n private int index = 0;\n\n @Override\n public void clear() {\n index = 0;\n }\n\n @Override\n public boolean hasNext() {\n return true;\n }\n\n @Override\n @NotNull\n public T next() {\n if (index >= keyframe.size()) return keyframe.getLast();\n return keyframe.get(index++);\n }\n\n @NotNull\n @Override\n public Type type() {\n return Type.HOLD_ON_LAST;\n }\n }\n\n /**\n * Implementation for {@link Type#LOOP}.\n *\n * @param the type of keyframe\n * @since 1.15.2\n */\n @RequiredArgsConstructor(access = AccessLevel.PRIVATE)\n final class Loop implements AnimationIterator {\n private final TimedStorage keyframe;\n private int index = 0;\n\n @Override\n public void clear() {\n index = 0;\n }\n\n @Override\n public boolean hasNext() {\n return true;\n }\n\n @Override\n @NotNull\n public T next() {\n if (index >= keyframe.size()) index = 0;\n return keyframe.get(index++);\n }\n\n @NotNull\n @Override\n public Type type() {\n return Type.LOOP;\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationKeyframe.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.bone.BoneMovement;\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Vector3f;\n\nimport java.util.Arrays;\n\nimport static kr.toxicity.model.api.util.MathUtil.isNotZero;\n\n/**\n * Represents a collection of animation keyframes, optimized for efficient storage and access.\n * \n * This record stores an array of {@link AnimationProgress} objects, which define the state of a bone\n * at specific time intervals. It implements {@link TimedStorage} for indexed access.\n *
\n *\n * @param progresses the array of animation progresses\n * @since 2.0.0\n */\npublic record AnimationKeyframe(\n @NotNull AnimationProgress[] progresses\n) implements TimedStorage {\n\n /**\n * Creates a new builder for constructing an AnimationKeyframe.\n *\n * @param size the number of keyframes\n * @param rotateGlobal whether rotation should be applied globally\n * @return a new builder instance\n * @since 2.0.0\n */\n public static @NotNull Builder builder(int size, boolean rotateGlobal) {\n return new Builder(size, rotateGlobal);\n }\n\n private record AnimationArray(\n boolean rotateGlobal,\n boolean[] skipInterpolation,\n float[] times,\n float[] position,\n float[] scale,\n float[] rotation\n ) {\n AnimationArray(int size, boolean rotateGlobal) {\n this(\n rotateGlobal,\n new boolean[size],\n new float[size],\n new float[size * 3],\n new float[size * 3],\n new float[size * 3]\n );\n }\n }\n\n /**\n * Builder for {@link AnimationKeyframe}.\n * \n * This builder allows for efficient population of keyframe data using primitive arrays.\n *
\n *\n * @since 2.0.0\n */\n public static final class Builder {\n private final AnimationArray set;\n private final AnimationProgress[] progresses;\n\n private int index = 0;\n\n private Builder(int size, boolean rotateGlobal) {\n set = new AnimationArray(size, rotateGlobal);\n progresses = new AnimationProgress[size];\n }\n\n /**\n * Writes a keyframe data point.\n *\n * @param time the time of the keyframe\n * @param position the position vector\n * @param scale the scale vector\n * @param rotation the rotation vector\n * @param skipInterpolation whether to skip interpolation for this keyframe\n * @since 2.0.0\n */\n public void write(\n float time,\n @NotNull Vector3f position,\n @NotNull Vector3f scale,\n @NotNull Vector3f rotation,\n boolean skipInterpolation\n ) {\n var i = index++;\n\n var x = i * 3;\n var y = x + 1;\n var z = x + 2;\n\n set.times[i] = time;\n set.position[x] = position.x;\n set.position[y] = position.y;\n set.position[z] = position.z;\n set.scale[x] = scale.x + 1;\n set.scale[y] = scale.y + 1;\n set.scale[z] = scale.z + 1;\n set.rotation[x] = rotation.x;\n set.rotation[y] = rotation.y;\n set.rotation[z] = rotation.z;\n set.skipInterpolation[i] = skipInterpolation;\n\n this.progresses[i] = isNotZero(position) || isNotZero(scale) || isNotZero(rotation) ? new ArrayProgress(set, i) : AnimationProgress.empty(time);\n }\n\n /**\n * Builds the {@link AnimationKeyframe}.\n *\n * @return the created keyframe collection\n * @since 2.0.0\n */\n public @NotNull AnimationKeyframe build() {\n return new AnimationKeyframe(progresses);\n }\n }\n\n private record ArrayProgress(@NotNull AnimationArray array, int index) implements AnimationProgress {\n\n @Override\n public @NotNull BoneMovement animate(@NotNull BoneMovement movement, @NotNull BoneMovement dest) {\n\n var destPos = movement.position().get(dest.position());\n var destScl = movement.scale().get(dest.scale());\n var destRot = movement.rotation().get(dest.rotation());\n var destRawRot = movement.rawRotation().get(dest.rawRotation());\n\n var position = array.position;\n var scale = array.scale;\n var rotation = array.rotation;\n\n var x = index * 3;\n var y = x + 1;\n var z = x + 2;\n\n destPos.add(position[x], position[y], position[z]);\n destScl.mul(scale[x], scale[y], scale[z]);\n MathUtil.toQuaternion(destRawRot.add(rotation[x], rotation[y], rotation[z]), destRot);\n\n return dest;\n }\n\n @Override\n public boolean skipInterpolation() {\n return array.skipInterpolation[index];\n }\n\n @Override\n public boolean globalRotation() {\n return array.rotateGlobal;\n }\n\n @Override\n public float time() {\n return array.times[index];\n }\n }\n\n @Override\n public @NotNull AnimationProgress get(int i) {\n return progresses[i];\n }\n\n @Override\n public @NotNull AnimationProgress getLast() {\n return get(progresses.length - 1);\n }\n\n @Override\n public int size() {\n return progresses.length;\n }\n\n /**\n * Converts this keyframe collection to a storage of empty progresses.\n *\n * @return a new timed storage with empty progresses\n * @since 2.0.0\n */\n public @NotNull TimedStorage toEmpty() {\n return TimedStorage.listOf(Arrays.stream(progresses)\n .map(AnimationProgress::toEmpty)\n .toList());\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationModifier.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport kr.toxicity.model.api.util.FunctionUtil;\nimport kr.toxicity.model.api.util.MathUtil;\nimport kr.toxicity.model.api.util.function.FloatSupplier;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.function.BooleanSupplier;\n\n/**\n * A modifier of animation.\n * @param predicate predicate\n * @param start start lerp\n * @param end end lerp\n * @param priority priority\n * @param type animation type\n * @param speed speed modifier\n * @param override override\n * @param player player\n */\npublic record AnimationModifier(\n @Nullable BooleanSupplier predicate,\n int start,\n int end,\n int priority,\n @Nullable AnimationIterator.Type type,\n @Nullable FloatSupplier speed,\n @Nullable Boolean override,\n @Nullable PlatformPlayer player\n) {\n\n /**\n * Default modifier\n */\n @NotNull\n public static final AnimationModifier DEFAULT = builder().build();\n\n /**\n * Default with play once modifier\n */\n public static final AnimationModifier DEFAULT_WITH_PLAY_ONCE = builder().type(AnimationIterator.Type.PLAY_ONCE).build();\n\n /**\n * Creates builder\n * @return builder\n */\n public static @NotNull Builder builder() {\n return new Builder();\n }\n\n /**\n * Makes this modifier as builder\n * @return builder\n */\n public @NotNull Builder toBuilder() {\n return builder()\n .predicate(predicate)\n .start(start)\n .end(end)\n .type(type)\n .speed(speed)\n .override(override)\n .player(player);\n }\n\n /**\n * Builder\n */\n public static final class Builder {\n private BooleanSupplier predicate = null;\n private int start = 1;\n private int end = 0;\n private int priority = 0;\n private AnimationIterator.Type type = null;\n private FloatSupplier speed = null;\n private Boolean override = null;\n private PlatformPlayer player = null;\n\n /**\n * Private initializer\n */\n private Builder() {\n }\n\n /**\n * Sets the predicate of this modifier\n * @param predicate predicate\n * @return self\n */\n public @NotNull Builder predicate(@Nullable BooleanSupplier predicate) {\n this.predicate = predicate == null ? null : FunctionUtil.throttleTickBoolean(predicate);\n return this;\n }\n\n /**\n * Sets the lerp-in time of this modifier\n * @param start lerp-in time\n * @return self\n */\n public @NotNull Builder start(int start) {\n this.start = start;\n return this;\n }\n\n /**\n * Sets the lerp-out time of this modifier\n * @param end lerp-out time\n * @return self\n */\n public @NotNull Builder end(int end) {\n this.end = end;\n return this;\n }\n\n /**\n * Sets the priority of this modifier\n * @param priority priority\n * @return self\n */\n public @NotNull Builder priority(int priority) {\n this.priority = priority;\n return this;\n }\n\n /**\n * Sets the animation type of this modifier\n * @param type animation type\n * @return self\n */\n public @NotNull Builder type(@Nullable AnimationIterator.Type type) {\n this.type = type;\n return this;\n }\n\n /**\n * Sets the speed modifier of this modifier\n * @param speed speed\n * @return self\n */\n public @NotNull Builder speed(float speed) {\n this.speed = toSupplier(speed);\n return this;\n }\n\n /**\n * Sets the speed modifier of this modifier\n * @param speed speed modifier\n * @return self\n */\n public @NotNull Builder speed(@Nullable FloatSupplier speed) {\n this.speed = speed == null ? null : FunctionUtil.throttleTickFloat(speed);\n return this;\n }\n\n /**\n * Sets the override flag of this modifier\n * @param override override flag\n * @return self\n */\n public @NotNull Builder override(@Nullable Boolean override) {\n this.override = override;\n return this;\n }\n\n /**\n * Sets the target player of this modifier\n * @param player target player\n * @return self\n */\n public @NotNull Builder player(@Nullable PlatformPlayer player) {\n this.player = player;\n return this;\n }\n\n /**\n * Merges non-default value with other modifier\n * @param modifier modifier\n * @return self\n */\n public @NotNull Builder mergeNotDefault(@NotNull AnimationModifier modifier) {\n if (modifier.predicate != null) predicate(modifier.predicate);\n if (modifier.start >= 0) start(modifier.start);\n if (modifier.end >= 0) end(modifier.end);\n if (modifier.type != null) type(modifier.type);\n if (modifier.speed != null) speed(modifier.speed);\n if (modifier.override != null) override(modifier.override);\n if (modifier.player != null) player(modifier.player);\n return this;\n }\n\n /**\n * Builds animation modifier\n * @return build\n */\n public @NotNull AnimationModifier build() {\n return new AnimationModifier(\n predicate,\n start,\n end,\n priority,\n type,\n speed,\n override,\n player\n );\n }\n }\n\n\n /**\n * Creates modifier\n *\n * @param start start time\n * @param end end time\n */\n public AnimationModifier(int start, int end) {\n this(start, end, null, null);\n }\n\n /**\n * Creates modifier\n *\n * @param start start time\n * @param end end time\n * @param speedValue speed value\n */\n public AnimationModifier(int start, int end, float speedValue) {\n this(start, end, null, FloatSupplier.of(speedValue));\n }\n\n /**\n * Creates modifier\n *\n * @param start start time\n * @param end end time\n * @param supplier speed supplier\n */\n public AnimationModifier(int start, int end, @Nullable FloatSupplier supplier) {\n this(start, end, null, supplier);\n }\n\n /**\n * Creates modifier\n *\n * @param start start time\n * @param end end time\n * @param type type\n */\n public AnimationModifier(int start, int end, @Nullable AnimationIterator.Type type) {\n this(start, end, type, null);\n }\n\n /**\n * Creates modifier\n *\n * @param start start time\n * @param end end time\n * @param type type\n * @param speed speed\n */\n public AnimationModifier(int start, int end, @Nullable AnimationIterator.Type type, @Nullable FloatSupplier speed) {\n this(null, start, end, type, speed);\n }\n\n /**\n * Creates modifier\n *\n * @param predicate animation predicate\n * @param start start time\n * @param end end time\n * @param type type\n * @param speed speed\n */\n public AnimationModifier(@Nullable BooleanSupplier predicate, int start, int end, @Nullable AnimationIterator.Type type, @Nullable FloatSupplier speed) {\n this(predicate, start, end, 0, type, speed, null, null);\n }\n\n /**\n * Gets modifier's type or default value\n * @param defaultType default value\n * @return modifier's type or default value\n */\n public @NotNull AnimationIterator.Type type(@NotNull AnimationIterator.Type defaultType) {\n return type != null ? type : defaultType;\n }\n\n /**\n * Gets speed value\n * @return speed value\n */\n public float speedValue() {\n return speed != null ? speed.getAsFloat() : 1F;\n }\n\n /**\n * Gets predicate value\n * @return predicate value\n */\n public boolean predicateValue() {\n return predicate == null || predicate.getAsBoolean();\n }\n\n /**\n * Gets override\n * @param original original value\n * @return override\n */\n public boolean override(boolean original) {\n return override != null ? override : original;\n }\n\n private static @Nullable FloatSupplier toSupplier(float speed) {\n return MathUtil.isSimilar(speed, 1F) ? null : FloatSupplier.of(speed);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationOverrideState.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\npublic enum AnimationOverrideState {\n NOT_MATCHED,\n MATCHED\n ;\n\n public boolean shouldSkip() {\n return this == NOT_MATCHED;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationProgress.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.bone.BoneMovement;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.List;\n\n/**\n * Represents the state of an animation at a specific keyframe.\n * \n * This interface defines how to apply the keyframe's transformation to a bone's movement.\n *
\n *\n * @since 2.0.0\n */\npublic interface AnimationProgress extends Timed {\n /**\n * An empty animation progress that applies no transformation.\n * @since 2.0.0\n */\n AnimationProgress EMPTY = empty(0);\n\n /**\n * Checks if interpolation should be skipped after this keyframe.\n *\n * @return true to skip interpolation, false otherwise\n * @since 2.0.0\n */\n boolean skipInterpolation();\n\n /**\n * Checks if the rotation in this keyframe should be applied globally.\n *\n * @return true for global rotation, false for local\n * @since 2.0.0\n */\n boolean globalRotation();\n\n /**\n * Creates an empty animation progress at a specific time.\n *\n * @param time the time of the keyframe\n * @return an empty progress\n * @since 2.0.0\n */\n static @NotNull AnimationProgress empty(float time) {\n return new EmptyProgress(time);\n }\n\n /**\n * Converts this progress to empty progress at the same time.\n *\n * @return an empty progress\n * @since 2.0.0\n */\n default @NotNull AnimationProgress toEmpty() {\n var time = time();\n return time <= 0 ? EMPTY : empty(time);\n }\n\n /**\n * Creates an empty timed storage with a start and end keyframe.\n *\n * @param time the duration of the empty animation\n * @return the timed storage\n * @since 2.0.0\n */\n static @NotNull TimedStorage emptyStorage(float time) {\n return TimedStorage.listOf(List.of(\n EMPTY,\n empty(time)\n ));\n }\n\n /**\n * Applies this keyframe's animation to a bone's movement.\n *\n * @param movement the current bone movement\n * @param dest the destination object to store the result\n * @return the resulting bone movement\n * @since 2.0.0\n */\n @NotNull BoneMovement animate(@NotNull BoneMovement movement, @NotNull BoneMovement dest);\n\n /**\n * An implementation of {@link AnimationProgress} that represents an empty keyframe.\n *\n * @param time the time of the keyframe\n * @since 2.0.0\n */\n record EmptyProgress(float time) implements AnimationProgress {\n\n @Override\n public @NotNull BoneMovement animate(@NotNull BoneMovement movement, @NotNull BoneMovement dest) {\n return dest.set(movement);\n }\n\n @Override\n public @NotNull AnimationProgress toEmpty() {\n return this;\n }\n\n @Override\n public boolean skipInterpolation() {\n return false;\n }\n\n @Override\n public boolean globalRotation() {\n return false;\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/AnimationStateHandler.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.tracker.Tracker;\nimport kr.toxicity.model.api.util.MathUtil;\nimport kr.toxicity.model.api.util.collection.PriorityMap;\nimport lombok.Getter;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.Iterator;\nimport java.util.function.BiConsumer;\nimport java.util.function.BooleanSupplier;\n\n/**\n * Animation state handler\n * @param timed value\n */\n@RequiredArgsConstructor\n@ApiStatus.Internal\npublic final class AnimationStateHandler {\n\n private final T initialValue;\n private final BiConsumer setConsumer;\n\n private final PriorityMap animators = new PriorityMap<>();\n\n @Getter\n private int delay;\n private volatile TreeIterator currentIterator = null;\n private volatile T beforeKeyframe = null, afterKeyframe = null;\n\n /**\n * Checks this keyframe has been finished\n * @return finished\n */\n public boolean keyframeFinished() {\n return delay <= 0;\n }\n\n /**\n * Gets before keyframe\n * @return before keyframe\n */\n public T beforeKeyframe() {\n return beforeKeyframe;\n }\n\n /**\n * Gets after keyframe\n * @return after keyframe\n */\n public T afterKeyframe() {\n return afterKeyframe;\n }\n\n /**\n * Gets before keyframe\n * @param defaultValue default value\n * @return before keyframe\n */\n @NotNull\n public T beforeKeyframe(@NotNull T defaultValue) {\n var value = beforeKeyframe;\n return value != null ? value : defaultValue;\n }\n\n /**\n * Gets after keyframe\n * @param defaultValue default value\n * @return after keyframe\n */\n @NotNull\n public T afterKeyframe(@NotNull T defaultValue) {\n var value = afterKeyframe;\n return value != null ? value : defaultValue;\n }\n\n /**\n * Gets running animation\n * @return animation\n */\n public @Nullable RunningAnimation runningAnimation() {\n var iterator = currentIterator;\n return iterator != null ? iterator.animation : null;\n }\n\n /**\n * Ticks this state handler\n * @return keyframe has been shifted or not\n */\n public boolean tick() {\n return tick(() -> {});\n }\n\n /**\n * Ticks this state handler\n * @param ifEmpty callback if animator is empty\n * @return keyframe has been shifted or not\n */\n public boolean tick(@NotNull Runnable ifEmpty) {\n delay--;\n if (animators.isEmpty()) {\n ifEmpty.run();\n return false;\n }\n return shouldUpdateAnimation() && updateAnimation();\n }\n\n /**\n * Gets the progress of current keyframe\n * @return progress\n */\n public float progress() {\n var frame = frame();\n return frame == 0 ? 0 : Math.clamp((float) delay / frame, 0F, 1F);\n }\n\n private boolean shouldUpdateAnimation() {\n return (afterKeyframe != null && keyframeFinished()) || delay % Tracker.MINECRAFT_TICK_MULTIPLIER == 0;\n }\n\n private boolean updateAnimation() {\n synchronized (animators) {\n var iterator = animators.valueIterator();\n while (iterator.hasNext()) {\n var next = iterator.next();\n if (!next.getAsBoolean()) continue;\n if (currentIterator == null) {\n if (updateKeyframe(iterator, next)) {\n currentIterator = next;\n return setAfterKeyframe(next.next());\n }\n } else if (currentIterator != next) {\n if (updateKeyframe(iterator, next)) {\n currentIterator.clear();\n currentIterator = next;\n return setAfterKeyframe(next.next());\n }\n } else if (keyframeFinished()) {\n if (updateKeyframe(iterator, next)) {\n return setAfterKeyframe(next.next());\n }\n } else {\n return false;\n }\n }\n }\n return setAfterKeyframe(null);\n }\n\n private boolean updateKeyframe(@NotNull Iterator iterator, @NotNull TreeIterator next) {\n if (!next.hasNext()) {\n next.removeTask.run();\n iterator.remove();\n return false;\n } else {\n return true;\n }\n }\n\n private boolean setAfterKeyframe(@Nullable T next) {\n if (afterKeyframe == next) return false;\n setConsumer.accept(\n beforeKeyframe = afterKeyframe,\n afterKeyframe = next\n );\n delay = Math.round(frame());\n return true;\n }\n\n /**\n * Adds animation\n * @param name name\n * @param iterator iterator\n * @param modifier modifier\n * @param removeTask remove task\n */\n public void addAnimation(@NotNull String name, @NotNull AnimationIterator iterator, @NotNull AnimationModifier modifier, @NotNull Runnable removeTask) {\n synchronized (animators) {\n animators.put(name, new TreeIterator(name, iterator, modifier, removeTask), modifier.priority());\n }\n }\n\n /**\n * Replaces animation\n * @param name name\n * @param iterator iterator\n * @param modifier modifier\n */\n public void replaceAnimation(@NotNull String name, @NotNull AnimationIterator iterator, @NotNull AnimationModifier modifier) {\n synchronized (animators) {\n animators.replace(name, v -> new TreeIterator(name, iterator, v.modifier.toBuilder()\n .mergeNotDefault(modifier)\n .build(), v.removeTask));\n }\n }\n\n /**\n * Remove animation\n * @param name name\n * @return success\n */\n public boolean stopAnimation(@NotNull String name) {\n synchronized (animators) {\n if (animators.remove(name) != null) {\n return true;\n }\n }\n return false;\n }\n\n /**\n * Gets ticking frame of current keyframe\n * @return ticking frame\n */\n public float frame() {\n return afterKeyframe != null ? 20 * Tracker.MINECRAFT_TICK_MULTIPLIER * (currentIterator.time + MathUtil.FRAME_EPSILON) : 0F;\n }\n\n private class TreeIterator implements BooleanSupplier {\n private final RunningAnimation animation;\n private final AnimationIterator iterator;\n private final AnimationModifier modifier;\n private final Runnable removeTask;\n\n private final T previous;\n\n private boolean started = false;\n private boolean ended = false;\n\n private float time = 0;\n\n public TreeIterator(String name, AnimationIterator iterator, AnimationModifier modifier, Runnable removeTask) {\n animation = new RunningAnimation(name, iterator.type());\n this.iterator = iterator;\n this.modifier = modifier;\n this.removeTask = removeTask;\n\n previous = afterKeyframe != null ? afterKeyframe : initialValue;\n }\n\n @Override\n public boolean getAsBoolean() {\n return modifier.predicateValue();\n }\n\n public boolean hasNext() {\n return iterator.hasNext() || (modifier.end() > 0 && !ended);\n }\n\n public @NotNull T next() {\n if (!started) {\n started = true;\n time = (float) modifier.start() / 20;\n return iterator.next();\n }\n if (!iterator.hasNext()) {\n ended = true;\n time = (float) modifier.end() / 20;\n return previous;\n }\n var nxt = iterator.next();\n time = nxt.time() / modifier.speedValue();\n return nxt;\n }\n\n public void clear() {\n iterator.clear();\n started = ended = !iterator.hasNext();\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/RunningAnimation.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Running animation\n * @param name name\n * @param type type\n */\npublic record RunningAnimation(@NotNull String name, @NotNull AnimationIterator.Type type) {\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/Timed.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Object with keyframe time\n */\npublic interface Timed extends Comparable {\n\n default int compareTo(@NotNull Timed o) {\n return MathUtil.FRAME_COMPARATOR.compare(time(), o.time());\n }\n\n /**\n * Gets time\n * @return time\n */\n float time();\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/TimedStorage.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport org.jetbrains.annotations.NotNull;\nimport org.jspecify.annotations.NonNull;\n\nimport java.util.List;\n\n/**\n * A read-only storage for timed elements (keyframes), allowing indexed access.\n * \n * This interface abstracts the underlying data structure (e.g., List, Array) used to store animation frames.\n *
\n *\n * @param the type of timed element\n * @since 2.0.0\n */\npublic interface TimedStorage {\n\n /**\n * Creates a TimedStorage backed by a List.\n *\n * @param list the list of elements\n * @param the type of element\n * @return a new TimedStorage\n * @since 2.0.0\n */\n @NotNull\n static TimedStorage listOf(@NotNull List list) {\n return new ListDelegate<>(list);\n }\n\n /**\n * Retrieves the element at the specified index.\n *\n * @param index the index of the element\n * @return the element\n * @throws IndexOutOfBoundsException if the index is out of range\n * @since 2.0.0\n */\n @NotNull T get(int index);\n\n /**\n * Returns the number of elements in the storage.\n *\n * @return the size\n * @since 2.0.0\n */\n int size();\n\n /**\n * Retrieves the last element in the storage.\n *\n * @return the last element\n * @throws java.util.NoSuchElementException if the storage is empty\n * @since 2.0.0\n */\n @NotNull T getLast();\n\n /**\n * A {@link TimedStorage} implementation that delegates to a {@link List}.\n *\n * @param list the backing list\n * @param the type of element\n * @since 2.0.0\n */\n record ListDelegate(@NotNull List list) implements TimedStorage {\n @Override\n public @NonNull T get(int index) {\n return list.get(index);\n }\n\n @Override\n public int size() {\n return list.size();\n }\n\n @Override\n public @NonNull T getLast() {\n return list.getLast();\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/animation/VectorPoint.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.animation;\n\nimport kr.toxicity.model.api.util.function.FloatFunction;\nimport kr.toxicity.model.api.util.interpolator.VectorInterpolator;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Vector3f;\n\n/**\n * Represents a keyframe point in an animation timeline.\n * \n * This record holds the value of a vector (position, rotation, or scale) at a specific time,\n * along with interpolation information to create smooth transitions between keyframes.\n *
\n *\n * @param function a function to get the vector value, which may be dynamic (e.g., based on Molang expressions)\n * @param time the time of this keyframe in seconds\n * @param bezier the bezier curve configuration for interpolation, if applicable\n * @param interpolator the interpolation method to use (e.g., linear, bezier, catmull-rom)\n * @since 1.15.2\n */\npublic record VectorPoint(@NotNull FloatFunction function, float time, @NotNull BezierConfig bezier, @NotNull VectorInterpolator interpolator) implements Timed {\n\n private static final Vector3f ZERO = new Vector3f();\n\n /**\n * An empty, default vector point at time 0 with linear interpolation.\n * @since 1.15.2\n */\n public static final VectorPoint EMPTY = new VectorPoint(\n FloatFunction.of(ZERO),\n 0F,\n new BezierConfig(null, null, null, null),\n VectorInterpolator.LINEAR\n );\n\n /**\n * Gets the vector value at this keyframe's specific time.\n *\n * @return the vector value\n * @since 1.15.2\n */\n public @NotNull Vector3f vector() {\n return vector(time);\n }\n\n /**\n * Gets the vector value at a specific time, evaluating the function if necessary.\n *\n * @param time the time to evaluate at\n * @return the calculated vector\n * @since 1.15.2\n */\n public @NotNull Vector3f vector(float time) {\n return function.apply(time);\n }\n\n /**\n * Checks if the interpolation method for this point is continuous.\n *\n * @return true if continuous (e.g., linear), false if stepped\n * @since 1.15.2\n */\n public boolean isContinuous() {\n return interpolator.isContinuous();\n }\n\n /**\n * Configuration for bezier curve interpolation.\n *\n * @param leftTime the time offset for the incoming (left) handle\n * @param leftValue the value offset for the incoming (left) handle\n * @param rightTime the time offset for the outgoing (right) handle\n * @param rightValue the value offset for the outgoing (right) handle\n * @since 1.15.2\n */\n public record BezierConfig(@Nullable Vector3f leftTime, @Nullable Vector3f leftValue, @Nullable Vector3f rightTime, @Nullable Vector3f rightValue) {\n\n /**\n * Gets the time offset for the incoming (left) handle.\n * If null, returns a zero vector.\n * @return the left time offset vector\n * @since 1.15.2\n */\n @Override\n public @NotNull Vector3f leftTime() {\n return leftTime != null ? leftTime : ZERO;\n }\n\n /**\n * Gets the value offset for the incoming (left) handle.\n * If null, returns a zero vector.\n * @return the left value offset vector\n * @since 1.15.2\n */\n @Override\n public @NotNull Vector3f leftValue() {\n return leftValue != null ? leftValue : ZERO;\n }\n\n /**\n * Gets the time offset for the outgoing (right) handle.\n * If null, returns a zero vector.\n * @return the right time offset vector\n * @since 1.15.2\n */\n @Override\n public @NotNull Vector3f rightTime() {\n return rightTime != null ? rightTime : ZERO;\n }\n\n /**\n * Gets the value offset for the outgoing (right) handle.\n * If null, returns a zero vector.\n * @return the right value offset vector\n * @since 1.15.2\n */\n @Override\n public @NotNull Vector3f rightValue() {\n return rightValue != null ? rightValue : ZERO;\n }\n }\n\n @Override\n public boolean equals(Object o) {\n if (!(o instanceof VectorPoint that)) return false;\n return Float.compare(time, that.time) == 0;\n }\n\n @Override\n public int hashCode() {\n return Float.hashCode(time);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/armor/ArmorItem.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.armor;\n\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Armor item\n * @param tint tint value\n * @param type armor type\n * @param trim trim\n * @param palette palette\n */\npublic record ArmorItem(int tint, @NotNull String type, @Nullable String trim, @Nullable String palette) {\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/armor/PlayerArmor.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.armor;\n\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Player armor\n */\npublic interface PlayerArmor {\n\n /**\n * Empty armor\n */\n PlayerArmor EMPTY = new PlayerArmor() {\n @Override\n public @Nullable ArmorItem helmet() {\n return null;\n }\n\n @Override\n public @Nullable ArmorItem chestplate() {\n return null;\n }\n\n @Override\n public @Nullable ArmorItem leggings() {\n return null;\n }\n\n @Override\n public @Nullable ArmorItem boots() {\n return null;\n }\n };\n\n /**\n * Gets helmet\n * @return helmet\n */\n @Nullable ArmorItem helmet();\n\n /**\n * Gets chestplate\n * @return chestplate\n */\n @Nullable ArmorItem chestplate();\n\n /**\n * Gets leggings\n * @return leggings\n */\n @Nullable ArmorItem leggings();\n\n /**\n * Gets boots\n * @return boots\n */\n @Nullable ArmorItem boots();\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneEventDispatcher.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport kr.toxicity.model.api.nms.HitBoxListener;\nimport lombok.AllArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.UUID;\nimport java.util.function.BiConsumer;\nimport java.util.function.BiFunction;\n\n/**\n * Dispatches events related to bone lifecycle and interaction.\n * \n * This class manages handlers for hitbox creation, state creation, and state removal.\n * It allows for extending behavior by chaining dispatchers.\n *
\n *\n * @since 1.15.2\n */\npublic final class BoneEventDispatcher {\n private final EventFunction builder = new EventFunction();\n private EventFunction applier = builder;\n\n /**\n * Extends this dispatcher with another dispatcher's handlers.\n * \n * The handlers from the provided dispatcher will be executed before the handlers in this dispatcher.\n *
\n *\n * @param dispatcher the dispatcher to extend\n * @throws UnsupportedOperationException if attempting to extend self\n * @since 1.15.2\n */\n public synchronized void extend(@NotNull BoneEventDispatcher dispatcher) {\n if (dispatcher == this) throw new UnsupportedOperationException(\"cannot extend self\");\n applier = EventFunction.concat(dispatcher.applier, builder);\n }\n\n /**\n * Registers a handler for hitbox creation.\n *\n * @param function the function to modify the hitbox listener builder\n * @since 1.15.2\n */\n public synchronized void handleCreateHitBox(@NotNull BiFunction function) {\n var before = builder.createHitBox;\n builder.createHitBox = (b, l) -> function.apply(b, before.apply(b, l));\n }\n\n /**\n * Registers a handler for state creation (e.g., when a bone is initialized for a player).\n *\n * @param function the consumer to handle state creation\n * @since 1.15.2\n */\n public synchronized void handleStateCreate(@NotNull BiConsumer function) {\n builder.stateCreate = builder.stateCreate.andThen(function);\n }\n\n /**\n * Registers a handler for state removal (e.g., when a bone is removed for a player).\n *\n * @param function the consumer to handle state removal\n * @since 1.15.2\n */\n public synchronized void handleStateRemove(@NotNull BiConsumer function) {\n builder.stateRemove = builder.stateRemove.andThen(function);\n }\n\n @NotNull HitBoxListener.Builder onCreateHitBox(@NotNull RenderedBone bone, @NotNull HitBoxListener.Builder builder) {\n return applier.createHitBox.apply(bone, builder);\n }\n\n void onStateCreated(@NotNull RenderedBone bone, @NotNull UUID uuid) {\n applier.stateCreate.accept(bone, uuid);\n }\n\n void onStateRemoved(@NotNull RenderedBone bone, @NotNull UUID uuid) {\n applier.stateRemove.accept(bone, uuid);\n }\n\n @AllArgsConstructor\n private static class EventFunction {\n private BiFunction createHitBox;\n private BiConsumer stateCreate;\n private BiConsumer stateRemove;\n\n EventFunction() {\n this(\n (_, l) -> l,\n (_, _) -> {},\n (_, _) -> {}\n );\n }\n\n static @NotNull EventFunction concat(@NotNull EventFunction first, @NotNull EventFunction second) {\n return new EventFunction(\n (b, l) -> second.createHitBox.apply(b, first.createHitBox.apply(b, l)),\n (b, u) -> {\n first.stateCreate.accept(b, u);\n second.stateCreate.accept(b, u);\n },\n (b, u) -> {\n first.stateRemove.accept(b, u);\n second.stateRemove.accept(b, u);\n }\n );\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneEventHandler.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport org.jetbrains.annotations.NotNull;\n\npublic interface BoneEventHandler {\n @NotNull BoneEventDispatcher eventDispatcher();\n\n default void extend(@NotNull BoneEventHandler eventHandler) {\n eventDispatcher().extend(eventHandler.eventDispatcher());\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneIKSolver.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport it.unimi.dsi.fastutil.objects.Object2ObjectLinkedOpenHashMap;\nimport kr.toxicity.model.api.util.InterpolationUtil;\nimport kr.toxicity.model.api.util.MathUtil;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Quaternionf;\nimport org.joml.Vector3f;\n\nimport java.util.Map;\nimport java.util.UUID;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.newSequencedAddressingMap;\n\n/**\n * Bone IK solver\n */\n@ApiStatus.Internal\n@RequiredArgsConstructor\npublic final class BoneIKSolver {\n\n private static final int MAX_IK_ITERATION = 20;\n private static final Vector3f FROM_VECTOR = new Vector3f(0, -1, 0).normalize();\n\n private final Map boneMap;\n private final Object2ObjectLinkedOpenHashMap locators = newSequencedAddressingMap();\n\n /**\n * Adds some external locator to this solver\n * @param ikSource nullable source\n * @param ikTarget target bone\n * @param locator locator bone\n */\n public void addLocator(@Nullable UUID ikSource, @NotNull UUID ikTarget, @NotNull RenderedBone locator) {\n var target = boneMap.get(ikTarget);\n if (target == null) return;\n var source = ikSource == null ? target.root : boneMap.getOrDefault(ikSource, target.root);\n var chainArray = source.flatten()\n .filter(bone -> !bone.flattenBones().contains(locator) && bone.flattenBones().contains(target))\n .toArray(RenderedBone[]::new);\n if (chainArray.length < 2) return;\n locators.put(locator, new IKChain(chainArray));\n }\n\n /**\n * Solves ik\n */\n public void solve() {\n solve(null);\n }\n\n /**\n * Solves ik\n * @param uuid player uuid\n */\n public void solve(@Nullable UUID uuid) {\n if (locators.isEmpty()) return;\n locators.object2ObjectEntrySet().fastForEach(entry -> {\n var locator = entry.getKey();\n var value = entry.getValue();\n fabrik(\n value.movements(uuid),\n value.invertedFirstRotation(uuid),\n value.cache.lengths,\n locator.state(uuid).after().position().get(value.cache.destination)\n .add(locator.root.group.getPosition())\n .sub(value.first().root.group.getPosition())\n );\n });\n }\n\n private record IKChain(@NotNull RenderedBone[] bones, @NotNull IKCache cache) {\n\n private IKChain(@NotNull RenderedBone[] bones) {\n this(bones, new IKCache(bones.length));\n }\n\n private @NotNull RenderedBone first() {\n return bones[0];\n }\n\n private @NotNull Quaternionf invertedFirstRotation(@Nullable UUID uuid) {\n return first().state(uuid).after().rotation().invert(cache.rotation);\n }\n\n private @NotNull BoneMovement[] movements(@Nullable UUID uuid) {\n var movements = cache.movements;\n for (int i = 0; i < bones.length; i++) {\n movements[i] = bones[i].state(uuid).after();\n }\n return movements;\n }\n }\n\n private record IKCache(@NotNull BoneMovement[] movements, float[] lengths, @NotNull Vector3f destination, @NotNull Quaternionf rotation) {\n private IKCache(int length) {\n this(new BoneMovement[length], new float[length - 1], new Vector3f(), new Quaternionf());\n }\n }\n\n private static void fabrik(@NotNull BoneMovement[] bones, @NotNull Quaternionf firstRot, float[] lengths, @NotNull Vector3f target) {\n var first = bones[0].position();\n var last = bones[bones.length - 1].position();\n\n var vecCache = new Vector3f();\n var rootPos = first.get(vecCache);\n\n for (int i = 0; i < bones.length - 1; i++) {\n var before = bones[i];\n var after = bones[i + 1];\n lengths[i] = before.position().distance(after.position());\n }\n for (int iter = 0; iter < MAX_IK_ITERATION; iter++) {\n // Forward\n last.set(target);\n for (int i = bones.length - 2; i >= 0; i--) {\n var current = bones[i].position();\n var next = bones[i + 1].position();\n var dist = current.distanceSquared(next);\n if (dist < MathUtil.VECTOR_COMPARISON_EPSILON_SQ) continue;\n InterpolationUtil.lerp(next, current, lengths[i] / (float) Math.sqrt(dist), current);\n }\n // Backward\n first.set(rootPos);\n for (int i = 0; i < bones.length - 1; i++) {\n var current = bones[i].position();\n var next = bones[i + 1].position();\n var dist = current.distanceSquared(next);\n if (dist < MathUtil.VECTOR_COMPARISON_EPSILON_SQ) continue;\n InterpolationUtil.lerp(current, next, lengths[i] / (float) Math.sqrt(dist), next);\n }\n // Check\n if (last.distanceSquared(target) < MathUtil.VECTOR_COMPARISON_EPSILON_SQ) break;\n }\n var rotCache = new Quaternionf();\n for (int i = 0; i < bones.length - 1; i++) {\n var current = bones[i];\n var next = bones[i + 1];\n\n var dir = next.position().sub(current.position(), vecCache);\n current.rotation().set(rotCache.identity().rotateTo(FROM_VECTOR, dir.normalize()).mul(firstRot).mul(current.rotation()));\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneItemMapper.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport kr.toxicity.model.api.data.renderer.RenderSource;\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport kr.toxicity.model.api.platform.PlatformItemTransform;\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport kr.toxicity.model.api.util.TransformedItemStack;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.BiFunction;\nimport java.util.function.Function;\n\n/**\n * Item-mapper of bone\n */\npublic interface BoneItemMapper extends BiFunction {\n\n @Override\n @NotNull TransformedItemStack apply(@NotNull BoneRenderContext context, @NotNull TransformedItemStack transformedItemStack);\n\n /**\n * Empty\n */\n BoneItemMapper EMPTY = new BoneItemMapper() {\n @NotNull\n @Override\n public PlatformItemTransform transform() {\n return PlatformItemTransform.FIXED;\n }\n\n @Override\n @NotNull\n public TransformedItemStack apply(@NotNull BoneRenderContext context, @NotNull TransformedItemStack transformedItemStack) {\n return transformedItemStack;\n }\n };\n\n /**\n * Mapped if a render source is player\n * @param transform transformation\n * @param mapper mapper\n * @return bone item mapper\n */\n static @NotNull BoneItemMapper player(@NotNull PlatformItemTransform transform, @NotNull Function mapper) {\n return new BoneItemMapper() {\n\n private static final TransformedItemStack AIR = TransformedItemStack.empty();\n\n @NotNull\n @Override\n public PlatformItemTransform transform() {\n return transform;\n }\n\n @Override\n public @NotNull TransformedItemStack apply(@NotNull BoneRenderContext context, @NotNull TransformedItemStack transformedItemStack) {\n if (context.source() instanceof RenderSource.BasePlayer(PlatformPlayer player)) {\n var get = mapper.apply(player);\n return get == null ? AIR : get;\n }\n return transformedItemStack;\n }\n };\n }\n\n /**\n * Mapped if a render source is entity\n * @param transform transformation\n * @param mapper mapper\n * @return bone item mapper\n */\n static @NotNull BoneItemMapper entity(@NotNull PlatformItemTransform transform, @NotNull Function mapper) {\n return new BoneItemMapper() {\n\n private static final TransformedItemStack AIR = TransformedItemStack.empty();\n\n @NotNull\n @Override\n public PlatformItemTransform transform() {\n return transform;\n }\n\n @Override\n public @NotNull TransformedItemStack apply(@NotNull BoneRenderContext context, @NotNull TransformedItemStack transformedItemStack) {\n if (context.source() instanceof RenderSource.Entity entity) {\n var get = mapper.apply(entity.entity());\n return get == null ? AIR : get;\n }\n return transformedItemStack;\n }\n };\n }\n\n /**\n * Gets this mapper's display is fixed\n * @return fixed\n */\n default boolean fixed() {\n return transform() == PlatformItemTransform.FIXED;\n }\n\n /**\n * Gets item display transformation\n * @return transformation\n */\n @NotNull PlatformItemTransform transform();\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneMovement.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport kr.toxicity.model.api.util.InterpolationUtil;\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Quaternionf;\nimport org.joml.Vector3f;\n\n/**\n * Represents the transformation state of a single bone, including its position, scale, and rotation.\n * \n * This record is used to calculate the final transformation of a bone after applying animations.\n *
\n *\n * @param position the local position of the bone\n * @param scale the local scale of the bone\n * @param rotation the final local rotation of the bone as a quaternion\n * @param rawRotation the local rotation of the bone in Euler angles (degrees) before being converted to a quaternion\n * @since 1.15.2\n */\npublic record BoneMovement(\n @NotNull Vector3f position,\n @NotNull Vector3f scale,\n @NotNull Quaternionf rotation,\n @NotNull Vector3f rawRotation\n) {\n\n /**\n * Creates a new BoneMovement with default (identity) transformations.\n * @since 1.15.2\n */\n public BoneMovement() {\n this(\n new Vector3f(),\n new Vector3f(1),\n new Quaternionf(),\n new Vector3f()\n );\n }\n\n /**\n * Copies the values from another BoneMovement into this one.\n *\n * @param movement the source movement\n * @return this movement instance\n * @since 1.15.2\n */\n public @NotNull BoneMovement set(@NotNull BoneMovement movement) {\n position.set(movement.position);\n scale.set(movement.scale);\n rotation.set(movement.rotation);\n rawRotation.set(movement.rawRotation);\n return this;\n }\n\n /**\n * Linearly interpolates between this movement and another movement.\n *\n * @param to the target movement\n * @param alpha the interpolation factor (0.0 to 1.0)\n * @param dest the destination movement to store the result\n * @return the destination movement\n * @since 2.1.0\n */\n public @NotNull BoneMovement lerp(@NotNull BoneMovement to, float alpha, @NotNull BoneMovement dest) {\n InterpolationUtil.lerp(position, to.position, alpha, dest.position);\n InterpolationUtil.lerp(scale, to.scale, alpha, dest.scale);\n MathUtil.toQuaternion(InterpolationUtil.lerp(rawRotation, to.rawRotation, alpha, dest.rawRotation), dest.rotation);\n return dest;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneName.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport com.google.gson.JsonDeserializer;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Objects;\nimport java.util.Set;\n\n/**\n * A tagged name of some bone\n * @param tags tags\n * @param name name\n * @param rawName original name\n */\npublic record BoneName(@NotNull @Unmodifiable Set tags, @NotNull String name, @NotNull String rawName) {\n\n /**\n * A JSON deserializer for parsing BoneName from a string.\n * @since 2.0.1\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> BoneName.of(json.getAsString());\n\n /**\n * Internal constructor for BoneName.\n */\n @ApiStatus.Internal\n public BoneName {\n }\n\n /**\n * Creates a new BoneName by parsing the raw name string.\n * @param rawName the raw string to parse\n * @since 2.0.1\n * @return a parsed BoneName instance\n */\n public static @NotNull BoneName of(@NotNull String rawName) {\n return BoneTag.REGISTRY.parse(rawName);\n }\n\n /**\n * Checks this name has some tags\n * @param tags tags\n * @return any match\n */\n public boolean tagged(@NotNull BoneTag... tags) {\n for (BoneTag boneTag : tags) {\n if (this.tags.contains(boneTag)) return true;\n }\n return false;\n }\n\n /**\n * Gets an item mapper of this bone name.\n * @return item mapper\n */\n public @NotNull BoneItemMapper toItemMapper() {\n return tags.isEmpty() ? BoneItemMapper.EMPTY : tags.stream().map(BoneTag::itemMapper).filter(Objects::nonNull).findFirst().orElse(BoneItemMapper.EMPTY);\n }\n\n @Override\n public boolean equals(Object o) {\n if (this == o) return true;\n if (!(o instanceof BoneName boneName)) return false;\n return rawName.equals(boneName.rawName);\n }\n\n @Override\n public int hashCode() {\n return rawName.hashCode();\n }\n\n @Override\n public @NotNull String toString() {\n return rawName;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BonePosition.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Vector3f;\n\nimport java.util.UUID;\n\n/**\n * Represents the position and state of a bone in a model.\n *\n * @param globalOffset the global offset vector\n * @param localOffset the local offset vector\n * @param state the unique identifier of the current state, or null if none\n * @since 2.1.0\n */\npublic record BonePosition(\n @NotNull Vector3f globalOffset,\n @NotNull Vector3f localOffset,\n @Nullable UUID state\n) {\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneRenderContext.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.data.renderer.RenderSource;\nimport kr.toxicity.model.api.skin.SkinData;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Render item context\n * @param source source\n * @param skin skin\n */\npublic record BoneRenderContext(@NotNull RenderSource source, @NotNull SkinData skin) {\n\n /**\n * Creates default context\n * @param source source\n */\n public BoneRenderContext(@NotNull RenderSource source) {\n this(source, BetterModel.platform().skinManager().fallback());\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneTag.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.List;\n\n/**\n * A tag of bone\n */\npublic interface BoneTag {\n\n /**\n * The default registry for bone tags.\n * @since 2.0.1\n */\n BoneTagRegistry REGISTRY = new BoneTagRegistry();\n\n /**\n * Gets tag name\n * @return tag name\n */\n @NotNull String name();\n\n /**\n * Gets an item mapper\n * @return item mapper\n */\n @Nullable BoneItemMapper itemMapper();\n\n /**\n * Gets a tag list like 'h', 'hi', 'b'\n * @since 2.0.1\n * @return tags\n */\n @NotNull @Unmodifiable\n List tags();\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneTagRegistry.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport it.unimi.dsi.fastutil.objects.*;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.List;\nimport java.util.Locale;\nimport java.util.Optional;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.newAddressingMap;\n\n/**\n * Bone tag registry\n */\npublic final class BoneTagRegistry {\n\n private static final String TAG_SPLITTER = \"_\";\n private final Object2ObjectMap byName = newAddressingMap();\n\n BoneTagRegistry() {\n for (BoneTags value : BoneTags.values()) {\n addTag(value);\n }\n }\n\n /**\n * Adds some tag to this registry\n * @param tag tag\n */\n public void addTag(@NotNull BoneTag tag) {\n BoneTag checkDuplicate;\n for (String s : tag.tags()) {\n if ((checkDuplicate = byName.put(s, tag)) != null) throw new RuntimeException(\"Duplicated tags: \" + tag.name() + \" between \" + checkDuplicate.name());\n }\n }\n\n /**\n * Gets a bone tag by its name wrapped in an Optional.\n * @param tag tag name\n * @return bone tag\n * @since 1.15.2\n */\n public @NotNull Optional byTagName(@NotNull String tag) {\n return Optional.ofNullable(byTagNameOrNull(tag));\n }\n\n /**\n * Gets a bone tag by its name.\n * @param tag tag name\n * @return bone tag or null\n * @since 2.1.0\n */\n public @Nullable BoneTag byTagNameOrNull(@NotNull String tag) {\n return byName.get(tag);\n }\n\n /**\n * Parses bone name by raw group name\n * @param rawName raw name\n * @return bone name\n */\n public @NotNull BoneName parse(@NotNull String rawName) {\n rawName = rawName.toLowerCase(Locale.ROOT);\n var tagArray = rawName.split(TAG_SPLITTER);\n if (tagArray.length < 2) return new BoneName(ObjectSets.emptySet(), rawName, rawName);\n var tagList = List.of(tagArray);\n var maxSize = tagList.size() - 1;\n ObjectSet set = maxSize <= 4 ? new ObjectArraySet<>(maxSize) : new ObjectOpenHashSet<>(maxSize);\n for (String s : tagList) {\n var tag = byTagNameOrNull(s);\n if (tag != null && set.size() < maxSize) set.add(tag);\n else return new BoneName(\n set.isEmpty() ? ObjectSets.emptySet() : ObjectSets.unmodifiable(set),\n set.isEmpty() ? rawName : String.join(TAG_SPLITTER, tagList.subList(set.size(), tagList.size())),\n rawName\n );\n }\n return new BoneName(\n ObjectSets.unmodifiable(set),\n String.join(TAG_SPLITTER, tagList.subList(set.size(), tagList.size())),\n rawName\n );\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/BoneTags.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport kr.toxicity.model.api.nms.Profiled;\nimport kr.toxicity.model.api.platform.PlatformItemTransform;\nimport kr.toxicity.model.api.player.PlayerLimb;\nimport kr.toxicity.model.api.util.TransformedItemStack;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.List;\n\n/**\n * Builtin tags\n */\npublic enum BoneTags implements BoneTag {\n /**\n * Follows entity's head rotation\n */\n HEAD(\"h\"),\n /**\n * Follows entity's head rotation\n */\n HEAD_WITH_CHILDREN(\"hi\"),\n /**\n * Creates a hitbox following this bone\n */\n HITBOX(\"b\", \"ob\"),\n /**\n * It can be used as a seat\n */\n SEAT(\"p\"),\n /**\n * It can be used as a seat but not controllable\n */\n SUB_SEAT(\"sp\"),\n /**\n * Nametag\n */\n TAG(\"tag\"),\n /**\n * Mob's nametag\n */\n MOB_TAG(\"mtag\"),\n /**\n * Player's nametag\n */\n PLAYER_TAG(\"ptag\"),\n /**\n * Glow\n */\n GLOW(\"glow\"),\n /**\n * Entity's item in left hand\n */\n LEFT_ITEM(BoneItemMapper.entity(\n PlatformItemTransform.THIRDPERSON_LEFTHAND,\n BaseEntity::offHand\n ), \"pli\", \"li\"),\n /**\n * Entity's item in right hand\n */\n RIGHT_ITEM(BoneItemMapper.entity(\n PlatformItemTransform.THIRDPERSON_RIGHTHAND,\n BaseEntity::mainHand\n ), \"pri\", \"ri\"),\n /**\n * Player head\n */\n PLAYER_HEAD(PlayerLimb.HEAD.getItemMapper(), \"ph\"),\n /**\n * Player right arm\n */\n PLAYER_RIGHT_ARM(PlayerLimb.RIGHT_ARM.getItemMapper(), \"pra\"),\n /**\n * Player right forearm\n */\n PLAYER_RIGHT_FOREARM(PlayerLimb.RIGHT_FOREARM.getItemMapper(), \"prfa\"),\n /**\n * Player left arm\n */\n PLAYER_LEFT_ARM(PlayerLimb.LEFT_ARM.getItemMapper(), \"pla\"),\n /**\n * Player left forearm\n */\n PLAYER_LEFT_FOREARM(PlayerLimb.LEFT_FOREARM.getItemMapper(), \"plfa\"),\n /**\n * Player left hip\n */\n PLAYER_HIP(PlayerLimb.HIP.getItemMapper(), \"phip\"),\n /**\n * Player left waist\n */\n PLAYER_WAIST(PlayerLimb.WAIST.getItemMapper(), \"pw\"),\n /**\n * Player left chest\n */\n PLAYER_CHEST(PlayerLimb.CHEST.getItemMapper(), \"pc\"),\n /**\n * Player right leg\n */\n PLAYER_RIGHT_LEG(PlayerLimb.RIGHT_LEG.getItemMapper(), \"prl\"),\n /**\n * Player right foreleg\n */\n PLAYER_RIGHT_FORELEG(PlayerLimb.RIGHT_FORELEG.getItemMapper(), \"prfl\"),\n /**\n * Player left leg\n */\n PLAYER_LEFT_LEG(PlayerLimb.LEFT_LEG.getItemMapper(), \"pll\"),\n /**\n * Player left foreleg\n */\n PLAYER_LEFT_FORELEG(PlayerLimb.LEFT_FORELEG.getItemMapper(), \"plfl\"),\n /**\n * Cape\n */\n CAPE(new BoneItemMapper() {\n @Override\n public @NotNull TransformedItemStack apply(@NotNull BoneRenderContext context, @NotNull TransformedItemStack transformedItemStack) {\n TransformedItemStack cape = null;\n if (context.source() instanceof Profiled profiled && profiled.skinParts().isCapeEnabled()) {\n cape = context.skin().cape(profiled.armors());\n }\n return cape != null ? cape : TransformedItemStack.empty();\n }\n\n @Override\n public @NotNull PlatformItemTransform transform() {\n return PlatformItemTransform.FIXED;\n }\n }, \"cape\")\n ;\n\n BoneTags(@NotNull String... tags) {\n this(null, tags);\n }\n\n BoneTags(@Nullable BoneItemMapper itemMapper, @NotNull String... tags) {\n this.itemMapper = itemMapper;\n this.tags = List.of(tags);\n }\n\n @Nullable\n private final BoneItemMapper itemMapper;\n @NotNull\n private final List tags;\n\n @Nullable\n @Override\n public BoneItemMapper itemMapper() {\n return itemMapper;\n }\n\n @NotNull\n @Unmodifiable\n @Override\n public List tags() {\n return tags;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/bone/RenderedBone.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.bone;\n\nimport it.unimi.dsi.fastutil.ints.Int2ObjectMap;\nimport it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;\nimport it.unimi.dsi.fastutil.objects.ObjectLinkedOpenHashSet;\nimport it.unimi.dsi.fastutil.objects.ObjectSortedSets;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.animation.*;\nimport kr.toxicity.model.api.data.blueprint.BlueprintAnimation;\nimport kr.toxicity.model.api.data.blueprint.BlueprintElement;\nimport kr.toxicity.model.api.data.blueprint.ModelBoundingBox;\nimport kr.toxicity.model.api.data.renderer.RenderSource;\nimport kr.toxicity.model.api.data.renderer.RendererGroup;\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport kr.toxicity.model.api.nms.*;\nimport kr.toxicity.model.api.platform.PlatformItemStack;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport kr.toxicity.model.api.tracker.ModelRotation;\nimport kr.toxicity.model.api.tracker.Tracker;\nimport kr.toxicity.model.api.util.*;\nimport kr.toxicity.model.api.util.collection.SingletonSequencedSet;\nimport kr.toxicity.model.api.util.function.BonePredicate;\nimport kr.toxicity.model.api.util.function.FloatConstantSupplier;\nimport kr.toxicity.model.api.util.function.FloatSupplier;\nimport kr.toxicity.model.api.util.lock.DuplexLock;\nimport lombok.Getter;\nimport lombok.Setter;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\nimport org.joml.Quaternionf;\nimport org.joml.Vector3f;\n\nimport java.util.*;\nimport java.util.concurrent.ConcurrentHashMap;\nimport java.util.concurrent.atomic.AtomicBoolean;\nimport java.util.function.*;\nimport java.util.stream.Collectors;\nimport java.util.stream.Stream;\n\n/**\n * A rendered item-display.\n */\npublic final class RenderedBone implements BoneEventHandler {\n\n private static final int INITIAL_TINT_VALUE = 0xFFFFFF;\n private static final Vector3f EMPTY_VECTOR = new Vector3f();\n private static final BonePosition EMPTY_POSITION = new BonePosition(EMPTY_VECTOR, EMPTY_VECTOR, null);\n\n @Getter\n @NotNull\n final RendererGroup group;\n private final BoneMovement defaultFrame;\n private volatile BoneRenderContext renderContext;\n private final BoneEventDispatcher eventDispatcher = new BoneEventDispatcher();\n\n @NotNull\n @Getter\n final RenderedBone root;\n @Nullable\n @Getter\n final RenderedBone parent;\n final RenderedBone[] children;\n\n private volatile SequencedSet flattenBones;\n\n private final Int2ObjectMap tintCacheMap = new Int2ObjectOpenHashMap<>();\n @Getter\n private final boolean dummyBone;\n private final Object itemLock = new Object();\n\n //Resource\n @Getter\n @Nullable\n private final ModelDisplay display;\n @Getter\n @Nullable\n private HitBox hitBox;\n @Getter\n @Nullable\n private ModelNametag nametag;\n\n //Item\n @Getter\n @Setter\n private BoneItemMapper itemMapper;\n private volatile int previousTint = INITIAL_TINT_VALUE, tint = INITIAL_TINT_VALUE;\n private volatile TransformedItemStack itemStack;\n\n //Animation\n private final BoneStateHandler globalState;\n private final Map perPlayerState = new ConcurrentHashMap<>();\n private volatile ModelRotation rotation = ModelRotation.EMPTY;\n\n private Supplier defaultPosition = FunctionUtil.asSupplier(EMPTY_VECTOR);\n private FloatSupplier scale = FloatConstantSupplier.ONE;\n\n private Function positionModifier = p -> p;\n private Vector3f lastModifiedPosition = new Vector3f();\n private Function localRotModifier = r -> r, globalRotModifier = r -> r;\n private Quaternionf lastModifiedLocalRot = new Quaternionf(), lastModifiedGlobalRot = new Quaternionf();\n\n /**\n * Creates entity.\n * @param group group\n * @param parent parent entity\n * @param context render context\n * @param movement spawn movement\n * @param childrenMapper mapper\n */\n @ApiStatus.Internal\n public RenderedBone(\n @NotNull RendererGroup group,\n @Nullable RenderedBone parent,\n @NotNull BoneRenderContext context,\n @NotNull BoneMovement movement,\n @NotNull Function childrenMapper\n ) {\n this.group = group;\n this.parent = parent;\n this.renderContext = context;\n itemMapper = group.getItemMapper();\n root = parent != null ? parent.root : this;\n this.itemStack = itemMapper.apply(renderContext, group.getItemStack());\n this.dummyBone = group.getItemStack().isAir() && itemMapper == BoneItemMapper.EMPTY;\n defaultFrame = movement;\n children = childrenMapper.apply(this);\n if (!dummyBone) {\n display = BetterModel.nms().create(context.source().location(), context.source() instanceof RenderSource.Entity ? -4096 : 0, d -> {\n d.display(itemMapper.transform());\n d.invisible(!group.getParent().visibility());\n d.viewRange(EntityUtil.entityModelViewRadius());\n applyItem(d);\n });\n } else display = null;\n globalState = new BoneStateHandler(null, _ -> {});\n }\n\n public void locator(@NotNull BoneIKSolver solver) {\n if (getGroup().getParent() instanceof BlueprintElement.NullObject nullObject) {\n var ikTarget = nullObject.ikTarget();\n if (ikTarget == null) return;\n solver.addLocator(nullObject.ikSource(), ikTarget, this);\n }\n }\n\n private @NotNull BoneStateHandler state(@Nullable PlatformPlayer player) {\n return state(player != null ? player.uuid() : null);\n }\n\n @NotNull BoneStateHandler state(@Nullable UUID uuid) {\n return uuid == null ? globalState : perPlayerState.getOrDefault(uuid, globalState);\n }\n\n private @NotNull BoneStateHandler getOrCreateState(@Nullable PlatformPlayer player) {\n return getOrCreateState(player != null ? player.uuid() : null);\n }\n\n private @NotNull BoneStateHandler getOrCreateState(@Nullable UUID uuid) {\n return uuid == null ? globalState : perPlayerState.computeIfAbsent(uuid, u -> {\n eventDispatcher.onStateCreated(this, u);\n return new BoneStateHandler(u, targetUUID -> eventDispatcher.onStateRemoved(this, targetUUID));\n });\n }\n\n public @Nullable RunningAnimation runningAnimation() {\n return globalState.state.runningAnimation();\n }\n\n @Override\n public @NotNull BoneEventDispatcher eventDispatcher() {\n return eventDispatcher;\n }\n\n public boolean updateItem(@NotNull Predicate predicate) {\n return itemStack(predicate, itemMapper.apply(renderContext, itemStack));\n }\n\n public boolean updateItem(@NotNull BoneRenderContext context) {\n synchronized (this) {\n renderContext = context;\n }\n return updateItem(_ -> true);\n }\n\n /**\n * Creates hit box.\n * @param entity target entity\n * @param predicate predicate\n * @param listener hit box listener\n * @return success\n */\n public boolean createHitBox(@NotNull BaseEntity entity, @NotNull Predicate predicate, @Nullable HitBoxListener listener) {\n if (predicate.test(this)) {\n var previous = hitBox;\n synchronized (this) {\n if (previous != hitBox) return false;\n var h = group.getHitBox();\n if (h == null) h = ModelBoundingBox.MIN;\n var l = eventDispatcher.onCreateHitBox(this, (listener != null ? listener : HitBoxListener.EMPTY).toBuilder()).build();\n if (hitBox != null) hitBox.removeHitBox();\n hitBox = BetterModel.nms().createHitBox(entity, this, h, group.getMountController(), l);\n return hitBox != null;\n }\n }\n return false;\n }\n\n /**\n * Creates nametag\n * @param predicate predicate\n * @param consumer nametag consumer\n * @return success\n */\n public boolean createNametag(@NotNull Predicate predicate, @NotNull Consumer consumer) {\n if (nametag == null && predicate.test(this)) {\n synchronized (this) {\n if (nametag != null) return false;\n nametag = BetterModel.nms().createNametag(this, consumer);\n }\n return true;\n }\n return false;\n }\n\n /**\n * Make item has enchantment or not\n * @param predicate predicate\n * @param enchant should enchant\n * @return success or not\n */\n public boolean enchant(@NotNull Predicate predicate, boolean enchant) {\n return itemStack(predicate, itemStack.modify(i -> i.enchant(enchant)));\n }\n\n /**\n * Sets the scale of this bone\n * @param scale scale\n */\n public void scale(@NotNull FloatSupplier scale) {\n this.scale = scale;\n }\n\n /**\n * Applies some function at display\n * @param predicate predicate\n * @param consumer consumer\n * @return success or not\n */\n public boolean applyAtDisplay(@NotNull Predicate predicate, @NotNull Consumer consumer) {\n if (display != null && predicate.test(this)) {\n consumer.accept(display);\n return true;\n }\n return false;\n }\n\n /**\n * Changes displayed item\n * @param predicate predicate\n * @param itemStack target item\n * @return success\n */\n public boolean itemStack(@NotNull Predicate predicate, @NotNull TransformedItemStack itemStack) {\n if (this.itemStack != itemStack && predicate.test(this)) {\n synchronized (itemLock) {\n if (this.itemStack == itemStack) return false;\n this.itemStack = itemStack;\n if (display != null) display.invisible(itemStack.isAir());\n tintCacheMap.clear();\n return applyItem();\n }\n }\n return false;\n }\n\n /**\n * Adds local rot modifier.\n * @param predicate predicate\n * @param function animation consumer\n * @return whether to success\n */\n public synchronized boolean addLocalRotModifier(@NotNull Predicate predicate, @NotNull Function function) {\n if (predicate.test(this)) {\n localRotModifier = localRotModifier.andThen(function);\n return true;\n }\n return false;\n }\n\n /**\n * Adds global rot modifier.\n * @param predicate predicate\n * @param function animation consumer\n * @return whether to success\n */\n public synchronized boolean addGlobalRotModifier(@NotNull Predicate predicate, @NotNull Function function) {\n if (predicate.test(this)) {\n globalRotModifier = globalRotModifier.andThen(function);\n return true;\n }\n return false;\n }\n\n /**\n * Adds position modifier.\n * @param predicate predicate\n * @param function animation consumer\n * @return whether to success\n */\n public synchronized boolean addPositionModifier(@NotNull Predicate predicate, @NotNull Function function) {\n if (predicate.test(this)) {\n positionModifier = positionModifier.andThen(function);\n return true;\n }\n return false;\n }\n\n public boolean rotate(@NotNull ModelRotation rotation, @NotNull PacketBundler bundler) {\n this.rotation = rotation;\n if (display != null) {\n display.rotate(rotation, bundler);\n return true;\n }\n return false;\n }\n\n public boolean tick() {\n return globalState.tick();\n }\n\n public boolean tick(@NotNull UUID uuid) {\n var get = perPlayerState.get(uuid);\n return get != null && get.tick();\n }\n\n public void dirtyUpdate(@NotNull PacketBundler bundler) {\n var d = display;\n if (d != null) d.sendDirtyEntityData(bundler);\n }\n\n public void forceUpdate(boolean showItem, @NotNull PacketBundler bundler) {\n var d = display;\n if (d != null) d.sendEntityData(showItem, bundler);\n }\n\n public void forceUpdate(@NotNull PacketBundler bundler) {\n var d = display;\n if (d != null) d.sendEntityData(!d.invisible(), bundler);\n }\n\n public void sendTransformation(@Nullable UUID uuid, @NotNull AnimationBundler bundler) {\n state(uuid).sendTransformation(bundler);\n }\n\n public void forceTransformation(@NotNull PacketBundler bundler) {\n var d = globalState.transformer;\n if (d != null) d.sendTransformation(bundler);\n }\n\n public int interpolationDuration() {\n return globalState.interpolationDuration();\n }\n\n public @NotNull Vector3f worldPosition() {\n return worldPosition(EMPTY_POSITION);\n }\n\n public @NotNull Vector3f worldPosition(@NotNull BonePosition position) {\n return worldPosition(position, new BoneMovement());\n }\n\n public @NotNull Vector3f worldPosition(@NotNull BoneMovement cache) {\n return worldPosition(EMPTY_POSITION, cache);\n }\n\n public @NotNull Vector3f worldPosition(@NotNull BonePosition position, @NotNull BoneMovement cache) {\n return state(position.state()).worldPosition(position, cache);\n }\n\n public @NotNull Vector3f worldRotation() {\n return worldRotation(null);\n }\n\n public @NotNull Vector3f worldRotation(@Nullable UUID uuid) {\n return state(uuid).worldRotation();\n }\n\n public void defaultPosition(@NotNull Supplier movement) {\n defaultPosition = movement;\n }\n\n private @NotNull Vector3f modifiedPosition(boolean preventModifierUpdate) {\n return preventModifierUpdate ? lastModifiedPosition : (lastModifiedPosition = positionModifier.apply(lastModifiedPosition.set(EMPTY_VECTOR)));\n }\n\n private @NotNull Quaternionf modifiedLocalRot(boolean preventModifierUpdate) {\n return preventModifierUpdate ? lastModifiedLocalRot : (lastModifiedLocalRot = localRotModifier.apply(lastModifiedLocalRot.identity()));\n }\n\n private @NotNull Quaternionf modifiedGlobalRot(boolean preventModifierUpdate) {\n return preventModifierUpdate ? lastModifiedGlobalRot : (lastModifiedGlobalRot = globalRotModifier.apply(lastModifiedGlobalRot.identity()));\n }\n\n public boolean tint(@NotNull Predicate predicate) {\n return tint(predicate, previousTint);\n }\n\n public boolean tint(@NotNull Predicate predicate, int tint) {\n if (this.tint != tint && predicate.test(this)) {\n synchronized (itemLock) {\n if (this.tint == tint) return false;\n this.previousTint = this.tint;\n this.tint = tint;\n return applyItem();\n }\n }\n return false;\n }\n\n private boolean applyItem() {\n if (display != null) {\n applyItem(display);\n return true;\n }\n return false;\n }\n\n private void applyItem(@NotNull ModelDisplay targetDisplay) {\n targetDisplay.item(itemStack.isAir() ? itemStack.itemStack() : tintCacheMap.computeIfAbsent(tint, i -> BetterModel.nms().tint(itemStack.itemStack(), i)));\n }\n\n public void teleport(@NotNull PlatformLocation location, @NotNull PacketBundler bundler) {\n if (display != null) display.teleport(location, bundler);\n }\n\n public void spawn(boolean hide, @NotNull PacketBundler bundler) {\n if (display != null) display.spawn(!hide && !display.invisible(), bundler);\n var transformer = globalState.transformer;\n if (transformer != null) transformer.sendTransformation(bundler);\n }\n\n public boolean addAnimation(@NotNull AnimationOverrideState overrideState, @NotNull BlueprintAnimation animator, @NotNull AnimationModifier modifier, @NotNull Runnable removeTask) {\n var get = animator.animator().get(name());\n if (get == null && modifier.override(animator.override()) && overrideState.shouldSkip()) return false;\n var type = modifier.type(animator.loop());\n var iterator = get != null ? get.iterator(type) : animator.emptyIterator(type);\n getOrCreateState(modifier.player()).state.addAnimation(animator.name(), iterator, modifier, removeTask);\n return true;\n }\n\n public boolean replaceAnimation(@NotNull AnimationOverrideState overrideState, @NotNull String target, @NotNull BlueprintAnimation animator, @NotNull AnimationModifier modifier) {\n var get = animator.animator().get(name());\n if (get == null && modifier.override(animator.override()) && overrideState.shouldSkip()) return false;\n var type = modifier.type(animator.loop());\n var iterator = get != null ? get.iterator(type) : animator.emptyIterator(type);\n state(modifier.player()).state.replaceAnimation(target, iterator, modifier);\n return true;\n }\n\n /**\n * Stops bone's animation\n * @param filter filter\n * @param name animation's name\n * @param player player\n */\n public boolean stopAnimation(@NotNull Predicate filter, @NotNull String name, @Nullable PlatformPlayer player) {\n return filter.test(this) && state(player).state.stopAnimation(name);\n }\n\n /**\n * Removes model's display\n * @param bundler packet bundler\n */\n public void remove(@NotNull PacketBundler bundler) {\n if (display != null) display.remove(bundler);\n if (nametag != null) nametag.remove(bundler);\n }\n\n public @NotNull Stream flatten() {\n return flattenBones().stream();\n }\n\n @Unmodifiable\n @NotNull\n public SequencedSet flattenBones() {\n SequencedSet set;\n if ((set = flattenBones) != null) return set;\n synchronized (this) {\n if ((set = flattenBones) != null) return set;\n return flattenBones = children.length == 0 ? SingletonSequencedSet.of(this) : Stream.concat(\n Stream.of(this),\n Arrays.stream(children).flatMap(RenderedBone::flatten)\n ).collect(Collectors.collectingAndThen(\n Collectors.toCollection(ObjectLinkedOpenHashSet::new),\n ObjectSortedSets::unmodifiable\n ));\n }\n }\n\n public boolean matchTree(@NotNull BonePredicate predicate, @NotNull BiPredicate mapper) {\n var parentResult = mapper.test(this, predicate);\n var childPredicate = predicate.children(parentResult);\n for (RenderedBone value : children) {\n if (value.matchTree(childPredicate, mapper)) parentResult = true;\n }\n return parentResult;\n }\n\n public boolean matchAnimation(@NotNull AnimationOverrideState overrideState, @NotNull BiPredicate mapper) {\n var parentResult = mapper.test(this, overrideState);\n if (parentResult) overrideState = AnimationOverrideState.MATCHED;\n for (RenderedBone value : children) {\n if (value.matchAnimation(overrideState, mapper)) parentResult = true;\n }\n return parentResult;\n }\n\n @NotNull\n public Vector3f hitBoxPosition() {\n return hitBoxPosition(new BoneMovement());\n }\n\n @NotNull\n public Vector3f hitBoxPosition(@NotNull BoneMovement cache) {\n var box = getGroup().getHitBox();\n if (box != null) return worldPosition(new BonePosition(EMPTY_VECTOR, group.getHitBoxPoint(), null), cache);\n return worldPosition(cache);\n }\n\n public float hitBoxScale() {\n return scale.getAsFloat();\n }\n\n @NotNull\n public ModelRotation rotation() {\n return rotation;\n }\n\n final class BoneStateHandler {\n\n private final @Nullable UUID uuid;\n private final Consumer consumer;\n\n //States\n private final AnimationStateHandler state;\n private final BoneMovement before = new BoneMovement(), after = new BoneMovement(), current = new BoneMovement();\n private final DisplayTransformer transformer = display != null ? display.createTransformer() : null;\n\n //Flags\n private boolean firstTick = true;\n private boolean skipInterpolation = false;\n private final AtomicBoolean updateAfter = new AtomicBoolean();\n private final AtomicBoolean updateCurrent = new AtomicBoolean();\n\n //Caches\n private final Vector3f positionCache = new Vector3f(), scaleCache = new Vector3f();\n private final Quaternionf localRotCache = new Quaternionf(), globalRotCache = new Quaternionf();\n\n //Lock\n private final DuplexLock lock = new DuplexLock();\n\n private BoneStateHandler(@Nullable UUID uuid, @NotNull Consumer consumer) {\n this.uuid = uuid;\n this.consumer = consumer;\n state = new AnimationStateHandler<>(\n AnimationProgress.EMPTY,\n (_, a) -> skipInterpolation = (a != null && a.skipInterpolation()) || (parent != null && parent.state(uuid).skipInterpolation)\n );\n }\n\n @NotNull BoneMovement after() {\n if (!updateAfter.compareAndSet(true, false)) return after;\n var keyframe = state.afterKeyframe(AnimationProgress.EMPTY);\n var preventModifierUpdate = interpolationDuration() < 1;\n var def = keyframe.animate(defaultFrame, after);\n if (parent != null) {\n var p = parent.state(uuid).after();\n MathUtil.fma(\n def.position().rotate(p.rotation()),\n p.scale(),\n p.position()\n ).sub(parent.lastModifiedPosition)\n .add(modifiedPosition(preventModifierUpdate));\n def.scale().mul(p.scale());\n def.rotation().set(parent.lastModifiedGlobalRot.invert(globalRotCache)\n .mul(modifiedGlobalRot(preventModifierUpdate))\n .mul((keyframe.globalRotation() ? localRotCache.identity() : p.rotation().div(parent.lastModifiedLocalRot, localRotCache)).mul(def.rotation()))\n .mul(modifiedLocalRot(preventModifierUpdate))\n );\n } else {\n def.position().add(modifiedPosition(preventModifierUpdate));\n def.rotation().set(modifiedGlobalRot(preventModifierUpdate).get(globalRotCache)\n .mul(def.rotation())\n .mul(modifiedLocalRot(preventModifierUpdate)));\n }\n return def;\n }\n\n private boolean tick() {\n var result = state.tick(() -> {\n if (uuid != null) {\n perPlayerState.remove(uuid);\n consumer.accept(uuid);\n }\n }) || firstTick;\n if (result && updateAfter.compareAndSet(false, true)) {\n lock.accessToWriteLock(() -> before.set(current));\n updateCurrent.set(true);\n }\n firstTick = false;\n return result;\n }\n\n private float progress() {\n return 1F - state.progress();\n }\n\n private int interpolationDuration() {\n if (skipInterpolation) return 0;\n var frame = state.frame() / (float) Tracker.MINECRAFT_TICK_MULTIPLIER;\n return Math.round(frame + MathUtil.FLOAT_COMPARISON_EPSILON);\n }\n\n private void sendTransformation(@NotNull AnimationBundler bundler) {\n if (!updateCurrent.compareAndSet(true, false)) return;\n var after = after();\n var movement = lock.accessToWriteLock(() -> current.set(after));\n if (transformer == null) return;\n var mul = scale.getAsFloat();\n transformer.transform(\n interpolationDuration(),\n MathUtil.fma(\n itemStack.offset().rotate(movement.rotation(), positionCache)\n .add(movement.position())\n .add(root.group.getPosition()),\n mul,\n itemStack.position()\n ).add(defaultPosition.get()),\n movement.scale()\n .mul(itemStack.scale(), scaleCache)\n .mul(mul)\n .max(EMPTY_VECTOR),\n movement.rotation(),\n bundler\n );\n }\n\n private @NotNull Vector3f worldPosition(@NotNull BonePosition position, @NotNull BoneMovement cache) {\n var progress = progress();\n var interpolated = lock.accessToReadLock(() -> before.lerp(current, progress, cache));\n return MathUtil.fma(\n interpolated.position()\n .add(itemStack.offset())\n .add(position.localOffset())\n .rotate(interpolated.rotation()),\n interpolated.scale(),\n position.globalOffset()\n )\n .add(root.getGroup().getPosition())\n .mul(scale.getAsFloat())\n .rotateX(-rotation.radianX())\n .rotateY(-rotation.radianY());\n }\n\n private @NotNull Vector3f worldRotation() {\n var progress = progress();\n return lock.accessToReadLock(() -> InterpolationUtil.lerp(before.rawRotation(), current.rawRotation(), progress));\n }\n }\n\n public @NotNull BoneName name() {\n return getGroup().name();\n }\n\n public @NotNull UUID uuid() {\n return getGroup().uuid();\n }\n\n @Override\n public boolean equals(Object obj) {\n if (obj == this) return true;\n if (!(obj instanceof RenderedBone bone)) return false;\n return uuid().equals(bone.uuid());\n }\n\n @Override\n public int hashCode() {\n return uuid().hashCode();\n }\n\n @Override\n public String toString() {\n return name().toString();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/config/DebugConfig.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.config;\n\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Arrays;\nimport java.util.Collections;\nimport java.util.EnumSet;\nimport java.util.Set;\nimport java.util.function.Predicate;\nimport java.util.stream.Collectors;\n\n/**\n * Debug config\n * @param options options\n */\npublic record DebugConfig(@NotNull @Unmodifiable Set options) {\n /**\n * Debug option\n */\n @RequiredArgsConstructor\n public enum DebugOption {\n /**\n * Debug stack trace of exception\n */\n EXCEPTION(\"exception\"),\n /**\n * Debug hit-box entity\n */\n HITBOX(\"hitbox\"),\n /**\n * Debug packing resource pack\n */\n PACK(\"pack\"),\n /**\n * Debug tracker thread\n */\n TRACKER(\"tracker\")\n ;\n private final String config;\n }\n\n /**\n * Checks this config has this option\n * @param option option\n * @return has or not\n */\n public boolean has(@NotNull DebugOption option) {\n return options.contains(option);\n }\n\n /**\n * Default config\n */\n public static final DebugConfig DEFAULT = new DebugConfig(Collections.emptySet());\n\n /**\n * Creates config from YAML\n * @param predicate predicate\n * @return config\n */\n public static @NotNull DebugConfig from(@NotNull Predicate predicate) {\n return new DebugConfig(Collections.unmodifiableSet(Arrays.stream(DebugOption.values())\n .filter(o -> predicate.test(o.config))\n .collect(Collectors.toCollection(() -> EnumSet.noneOf(DebugOption.class)))));\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/config/IndicatorConfig.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.config;\n\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Arrays;\nimport java.util.Collections;\nimport java.util.EnumSet;\nimport java.util.Set;\nimport java.util.function.Predicate;\nimport java.util.stream.Collectors;\n\n/**\n * Indicator config\n * @param options options\n */\npublic record IndicatorConfig(@NotNull @Unmodifiable Set options) {\n /**\n * Indicator option\n */\n @RequiredArgsConstructor\n public enum IndicatorOption {\n /**\n * Progress bar\n */\n PROGRESS_BAR(\"progress_bar\"),\n ;\n private final String config;\n }\n\n /**\n * Default config\n */\n public static final IndicatorConfig DEFAULT = new IndicatorConfig(Collections.emptySet());\n\n /**\n * Creates config from YAML\n * @param predicate predicate\n * @return config\n */\n public static @NotNull IndicatorConfig from(@NotNull Predicate predicate) {\n return new IndicatorConfig(Collections.unmodifiableSet(Arrays.stream(IndicatorOption.values())\n .filter(o -> predicate.test(o.config))\n .collect(Collectors.toCollection(() -> EnumSet.noneOf(IndicatorOption.class)))));\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/config/ModuleConfig.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.config;\n\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.Predicate;\n\n/**\n * Module config\n * @param model creates model\n * @param playerAnimation create player animation\n */\npublic record ModuleConfig(\n boolean model,\n boolean playerAnimation\n) {\n /**\n * Default config\n */\n public static final ModuleConfig DEFAULT = new ModuleConfig(\n true,\n true\n );\n\n /**\n * Creates config from YAML\n * @param predicate predicate\n * @return config\n */\n public static @NotNull ModuleConfig from(@NotNull Predicate predicate) {\n return new ModuleConfig(\n predicate.test(\"model\"),\n predicate.test(\"player-animation\")\n );\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/config/PackConfig.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.config;\n\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.Predicate;\n\n/**\n * Pack config\n * @param generateModernModel generate modern model\n * @param generateLegacyModel generate legacy model\n * @param useObfuscation use obfuscation\n */\npublic record PackConfig(\n boolean generateModernModel,\n boolean generateLegacyModel,\n boolean useObfuscation\n) {\n /**\n * Default config\n */\n public static final PackConfig DEFAULT = new PackConfig(true, true, false);\n\n /**\n * Creates config from YAML\n * @param predicate predicate\n * @return config\n */\n public static @NotNull PackConfig from(@NotNull Predicate predicate) {\n return new PackConfig(\n predicate.test(\"generate-modern-model\"),\n predicate.test(\"generate-legacy-model\"),\n predicate.test(\"use-obfuscation\")\n );\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/Float2.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data;\n\nimport com.google.gson.JsonDeserializer;\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Vector2f;\n\n/**\n * A simple record representing two float values.\n *\n * @param x the x value\n * @param y the y value\n * @since 3.0.0\n */\npublic record Float2(\n float x,\n float y\n) {\n /**\n * A GSON deserializer for {@link Float2}.\n * @since 3.0.0\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> {\n var array = json.getAsJsonArray();\n return new Float2(\n array.get(0).getAsFloat(),\n array.get(1).getAsFloat()\n );\n };\n\n /**\n * Converts this record to a {@link Vector2f}.\n *\n * @return a new vector instance\n * @since 3.0.0\n */\n public @NotNull Vector2f toVector() {\n return new Vector2f(x, y);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/Float3.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data;\n\nimport com.google.gson.JsonArray;\nimport com.google.gson.JsonDeserializer;\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Quaternionf;\nimport org.joml.Vector3f;\n\n/**\n * A three float value (origin, rotation)\n * @param x x\n * @param y y\n * @param z z\n */\n@ApiStatus.Internal\npublic record Float3(\n float x,\n float y,\n float z\n) {\n\n /**\n * Creates floats\n * @param value scala\n */\n public Float3(float value) {\n this(value, value, value);\n }\n /**\n * Center\n */\n public static final Float3 CENTER = new Float3(8, 8, 8);\n /**\n * Zero\n */\n public static final Float3 ZERO = new Float3(0, 0, 0);\n\n public static final Float3 MESH_TRIANGLE_FROM = new Float3(-8, 0, 0);\n\n public static final Float3 MESH_TRIANGLE_TO = new Float3(0, 8, 0);\n\n /**\n * Parser\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> {\n var array = json.getAsJsonArray();\n return new Float3(\n array.get(0).getAsFloat(),\n array.get(1).getAsFloat(),\n array.get(2).getAsFloat()\n );\n };\n\n /**\n * Adds other floats.\n * @param other other floats\n * @return new floats\n */\n public @NotNull Float3 plus(@NotNull Float3 other) {\n return new Float3(\n x + other.x,\n y + other.y,\n z + other.z\n );\n }\n\n /**\n * Converts zxy euler to xyz euler (Minecraft)\n * @return new float\n */\n public @NotNull Float3 convertToMinecraftDegree() {\n var vec = MathUtil.toXYZEuler(toVector());\n return new Float3(vec.x, vec.y, vec.z);\n }\n\n /**\n * Rotates this float\n * @param quaternionf rotation\n * @return new float\n */\n public @NotNull Float3 rotate(@NotNull Quaternionf quaternionf) {\n var vec = toVector().rotate(quaternionf);\n return new Float3(vec.x, vec.y, vec.z);\n }\n\n\n /**\n * Subtracts other floats.\n * @param other other floats\n * @return new floats\n */\n public @NotNull Float3 minus(@NotNull Float3 other) {\n return new Float3(\n x - other.x,\n y - other.y,\n z - other.z\n );\n }\n\n /**\n * Converts item model scale to block scale\n * @return block\n */\n public @NotNull Float3 toBlockScale() {\n return div(MathUtil.MODEL_TO_BLOCK_MULTIPLIER);\n }\n\n /**\n * Multiplies floats.\n * @param value multiplier\n * @return new floats\n */\n public @NotNull Float3 times(float value) {\n return new Float3(\n x * value,\n y * value,\n z * value\n );\n }\n /**\n * Divides floats.\n * @param value multiplier\n * @return new floats\n */\n public @NotNull Float3 div(float value) {\n return new Float3(\n x / value,\n y / value,\n z / value\n );\n }\n\n /**\n * Inverts XZ\n * @return new floats\n */\n public @NotNull Float3 invertXZ() {\n return new Float3(\n -x,\n y,\n -z\n );\n }\n\n /**\n * Converts floats to JSON array.\n * @return json array\n */\n public @NotNull JsonArray toJson() {\n var array = new JsonArray(3);\n array.add(x);\n array.add(y);\n array.add(z);\n return array;\n }\n\n public @NotNull Quaternionf toQuaternionZYX() {\n return new Quaternionf()\n .rotateZYX(\n z * MathUtil.DEGREES_TO_RADIANS,\n y * MathUtil.DEGREES_TO_RADIANS,\n x * MathUtil.DEGREES_TO_RADIANS\n );\n }\n\n public @NotNull Quaternionf toQuaternionXYZ() {\n return new Quaternionf()\n .rotateXYZ(\n x * MathUtil.DEGREES_TO_RADIANS,\n y * MathUtil.DEGREES_TO_RADIANS,\n z * MathUtil.DEGREES_TO_RADIANS\n );\n }\n\n /**\n * Converts floats to vector.\n * @return vector\n */\n public @NotNull Vector3f toVector() {\n return new Vector3f(x, y, z);\n }\n\n @Override\n public int hashCode() {\n var hash = 31;\n var value = 1;\n value = value * hash + MathUtil.similarHashCode(x);\n value = value * hash + MathUtil.similarHashCode(y);\n value = value * hash + MathUtil.similarHashCode(z);\n return value;\n }\n\n @Override\n public boolean equals(Object obj) {\n if (obj == this) return true;\n if (!(obj instanceof Float3(float x1, float y1, float z1))) return false;\n return MathUtil.isSimilar(x, x1)\n && MathUtil.isSimilar(y, y1)\n && MathUtil.isSimilar(z, z1);\n }\n\n @Override\n public @NotNull String toString() {\n return toJson().toString();\n }\n\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/Float4.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data;\n\nimport com.google.gson.JsonArray;\nimport com.google.gson.JsonDeserializer;\nimport kr.toxicity.model.api.data.raw.ModelResolution;\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * A four float values (uv)\n * @param dx from-x\n * @param dz from-z\n * @param tx to-x\n * @param tz to-z\n */\n@ApiStatus.Internal\npublic record Float4(\n float dx,\n float dz,\n float tx,\n float tz\n) {\n\n /**\n * Parser\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> {\n var array = json.getAsJsonArray();\n return new Float4(\n array.get(0).getAsFloat(),\n array.get(1).getAsFloat(),\n array.get(2).getAsFloat(),\n array.get(3).getAsFloat()\n );\n };\n\n public static final Float4 MAX_UV = new Float4(0, 0, 16, 16);\n\n /**\n * Divides floats by resolution.\n * @param resolution model resolution\n * @return new floats\n */\n public @NotNull Float4 div(@NotNull ModelResolution resolution) {\n return div((float) resolution.width() / MathUtil.MODEL_TO_BLOCK_MULTIPLIER, (float) resolution.height() / MathUtil.MODEL_TO_BLOCK_MULTIPLIER);\n }\n\n /**\n * Divides floats by width, height\n * @param width width\n * @param height height\n * @return new floats\n */\n public @NotNull Float4 div(float width, float height) {\n return new Float4(\n dx / width,\n dz / height,\n tx / width,\n tz / height\n );\n }\n\n /**\n * Checks validity of this uv\n * @return is valid\n */\n public boolean isValid() {\n return dx >= 0 && dx <= 16\n && dz >= 0 && dz <= 16\n && tx >= 0 && tx <= 16\n && tz >= 0 && tz <= 16;\n }\n\n /**\n * Converts floats to JSON array.\n * @return json array\n */\n public @NotNull JsonArray toJson() {\n var array = new JsonArray(4);\n array.add(dx);\n array.add(dz);\n array.add(tx);\n array.add(tz);\n return array;\n }\n\n @Override\n public int hashCode() {\n var hash = 31;\n var value = 1;\n value = value * hash + MathUtil.similarHashCode(dx);\n value = value * hash + MathUtil.similarHashCode(dz);\n value = value * hash + MathUtil.similarHashCode(tx);\n value = value * hash + MathUtil.similarHashCode(tz);\n return value;\n }\n\n @Override\n public boolean equals(Object obj) {\n if (obj == this) return true;\n if (!(obj instanceof Float4(float dx1, float dz1, float tx1, float tz1))) return false;\n return MathUtil.isSimilar(dx, dx1)\n && MathUtil.isSimilar(dz, dz1)\n && MathUtil.isSimilar(tx, tx1)\n && MathUtil.isSimilar(tz, tz1);\n }\n\n @Override\n public @NotNull String toString() {\n return toJson().toString();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/ModelAsset.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data;\n\nimport com.google.gson.JsonParseException;\nimport kr.toxicity.model.api.data.raw.ModelData;\nimport kr.toxicity.model.api.data.raw.ModelLoadResult;\nimport kr.toxicity.model.api.util.PackUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.io.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\n\n/**\n * Represents a raw model asset that can be loaded into the engine.\n * \n * This record encapsulates the source of the model data (e.g., a file or stream), its name, and metadata.\n * It provides methods to load and parse the model data into a usable format.\n *
\n *\n * @param rawName the original raw name or path of the asset\n * @param name the sanitized, pack-compliant name of the asset\n * @param sizeAssume the estimated size of the asset in bytes (0 if unknown)\n * @param supplier a supplier for the input stream containing the model data\n * @since 2.0.0\n */\npublic record ModelAsset(\n @NotNull String rawName,\n @NotNull String name,\n long sizeAssume,\n @NotNull StreamSupplier supplier\n) implements Comparable {\n\n /**\n * Internal constructor for ModelAsset.\n */\n @ApiStatus.Internal\n public ModelAsset {\n }\n\n /**\n * Creates a new ModelAsset from a name and byte array.\n *\n * @param name the name of the asset\n * @param bytes the byte array containing the model data\n * @return the created asset\n * @since 2.0.0\n */\n public static @NotNull ModelAsset of(@NotNull String name, byte[] bytes) {\n return of(name, bytes.length, () -> new ByteArrayInputStream(bytes));\n }\n\n /**\n * Creates a new ModelAsset from a name and stream supplier.\n *\n * @param name the name of the asset\n * @param supplier the stream supplier\n * @return the created asset\n * @since 2.0.0\n */\n public static @NotNull ModelAsset of(@NotNull String name, @NotNull StreamSupplier supplier) {\n return of(name, 0, supplier); // Unknown size\n }\n\n /**\n * Creates a new ModelAsset from a name, stream supplier, and estimated size.\n *\n * @param name the name of the asset\n * @param sizeAssume the estimated size in bytes\n * @param supplier the stream supplier\n * @return the created asset\n * @since 2.0.0\n */\n public static @NotNull ModelAsset of(@NotNull String name, long sizeAssume, @NotNull StreamSupplier supplier) {\n PackUtil.assertPackName(name);\n return new ModelAsset(name, name, sizeAssume, supplier);\n }\n\n /**\n * Creates a new ModelAsset from a file.\n *\n * @param file the source file\n * @return the created asset\n * @since 2.0.0\n */\n public static @NotNull ModelAsset of(@NotNull File file) {\n return new ModelAsset(file.getPath(), nameWithoutExtension(file.getName()), file.length(), () -> new FileInputStream(file));\n }\n\n /**\n * Creates a new ModelAsset from a path.\n *\n * @param path the source path\n * @return the created asset\n * @throws RuntimeException if an I/O error occurs\n * @since 2.0.0\n */\n public static @NotNull ModelAsset of(@NotNull Path path) {\n try {\n return new ModelAsset(path.toString(), nameWithoutExtension(path.getFileName().toString()), Files.size(path), () -> Files.newInputStream(path));\n } catch (IOException e) {\n throw new RuntimeException(e);\n }\n }\n\n private static @NotNull String nameWithoutExtension(@NotNull String name) {\n var index = name.lastIndexOf('.');\n return PackUtil.toPackName(index > 0 ? name.substring(0, index) : name);\n }\n\n /**\n * Loads and parses the model data from this asset.\n *\n * @return the result of the load operation\n * @throws RuntimeException if an I/O or parsing error occurs\n * @since 2.0.0\n */\n public @NotNull ModelLoadResult toResult() {\n try (\n var stream = supplier.get();\n var reader = new InputStreamReader(stream, StandardCharsets.UTF_8)\n ) {\n var result = ModelData.GSON.fromJson(reader, ModelData.class);\n result.assertSupported();\n return result.loadBlueprint(name);\n } catch (IOException e) {\n throw new RuntimeException(\"Unable to load this asset: \" + this, e);\n } catch (JsonParseException e) {\n throw new RuntimeException(\"Unable to parse this json asset: \" + this, e);\n }\n }\n\n @Override\n public int compareTo(@NotNull ModelAsset o) {\n return name.compareTo(o.name);\n }\n\n @Override\n public boolean equals(Object o) {\n if (!(o instanceof ModelAsset that)) return false;\n return name.equals(that.name);\n }\n\n @Override\n public int hashCode() {\n return name.hashCode();\n }\n\n @Override\n public @NotNull String toString() {\n return rawName;\n }\n\n /**\n * A functional interface for supplying an input stream.\n *\n * @since 2.0.0\n */\n public interface StreamSupplier {\n /**\n * Gets the input stream.\n *\n * @return the input stream\n * @throws IOException if an I/O error occurs\n * @since 2.0.0\n */\n @NotNull InputStream get() throws IOException;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/AnimationGenerator.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport it.unimi.dsi.fastutil.floats.*;\nimport kr.toxicity.model.api.animation.VectorPoint;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.util.InterpolationUtil;\nimport kr.toxicity.model.api.util.MathUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Vector3f;\n\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.function.Function;\nimport java.util.stream.Stream;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.*;\n\n/**\n * Generates animation data by interpolating keyframes and calculating bone movements.\n * \n * This class processes raw animation points and generates smooth transitions for position, rotation, and scale.\n * It handles the creation of intermediate frames to ensure fluid motion, especially for rotations.\n *
\n *\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic final class AnimationGenerator {\n\n private static final Vector3f EMPTY = new Vector3f();\n private final Map pointMap;\n private final List trees;\n\n /**\n * Creates a map of blueprint animators from the provided animation data.\n * \n * This method calculates all necessary interpolation frames and builds the final animation structures for each bone.\n *
\n *\n * @param length the total length of the animation in seconds\n * @param children the list of root blueprint elements (bones)\n * @param pointMap a map containing raw animation data for each bone\n * @return a map of generated blueprint animators keyed by bone name\n * @since 1.15.2\n */\n public static @NotNull Map createMovements(\n float length,\n @NotNull List children,\n @NotNull Map pointMap\n ) {\n var floatSet = mapFloat(pointMap.values()\n .stream()\n .flatMap(BlueprintAnimator.AnimatorData::allPoints), VectorPoint::time, () -> new FloatAVLTreeSet(MathUtil.FRAME_COMPARATOR));\n floatSet.add(0F);\n floatSet.add(length);\n InterpolationUtil.insertLerpFrame(floatSet);\n var generator = new AnimationGenerator(pointMap, children);\n generator.interpolateRotation(floatSet);\n generator.interpolateStep(floatSet);\n return mapValue(pointMap, v -> new BlueprintAnimator(\n v.name(),\n InterpolationUtil.buildAnimation(\n v.position(),\n v.rotation(),\n v.scale(),\n v.rotationGlobal(),\n floatSet\n )\n ));\n }\n\n private AnimationGenerator(\n @NotNull Map pointMap,\n @NotNull List children\n ) {\n this.pointMap = pointMap;\n trees = filterIsInstance(children, BlueprintElement.Group.class)\n .map(g -> new AnimationTree(g, pointMap.get(g.name())))\n .flatMap(AnimationTree::flatten)\n .toList();\n }\n\n private float firstTime = 0F;\n private float secondTime = 0F;\n\n /**\n * Inserts additional keyframes to smooth out large rotations.\n * \n * This ensures that rotations larger than 90 degrees between frames are broken down into smaller steps.\n *
\n *\n * @param floats the set of keyframe times to update\n * @since 1.15.2\n */\n public void interpolateRotation(@NotNull FloatSortedSet floats) {\n var iterator = new FloatArrayList(floats).iterator();\n var time = 0.05F;\n while (iterator.hasNext()) {\n firstTime = secondTime;\n secondTime = iterator.nextFloat();\n if (secondTime - firstTime <= 0) continue;\n var minus = trees.stream()\n .mapToDouble(t -> t.tree(firstTime, secondTime, BlueprintAnimator.AnimatorData::rotation))\n .max()\n .orElse(0);\n var length = (float) Math.ceil(minus / 90);\n if (length < 2) continue;\n var addTime = Math.max(\n InterpolationUtil.lerp(0, secondTime - firstTime, 1F / length),\n time\n );\n for (float f = 1; f < length; f++) {\n if (secondTime - addTime < time + MathUtil.FRAME_EPSILON) continue;\n floats.add(firstTime + f * addTime);\n }\n }\n }\n\n /**\n * Inserts keyframes for step interpolation (non-continuous transitions).\n *\n * @param floats the set of keyframe times to update\n * @since 1.15.2\n */\n public void interpolateStep(@NotNull FloatSortedSet floats) {\n trees.stream()\n .map(tree -> tree.data)\n .filter(Objects::nonNull)\n .forEach(data -> {\n interpolateStep(floats, data.position());\n interpolateStep(floats, data.rotation());\n interpolateStep(floats, data.scale());\n });\n }\n\n private void interpolateStep(@NotNull FloatSortedSet floats, @NotNull List points) {\n if (points.size() < 2) return;\n for (int i = 1; i < points.size(); i++) {\n var before = points.get(i - 1);\n if (before.isContinuous()) continue;\n var time = points.get(i).time() - 0.05F;\n if (time < 0 || time - before.time() < 0) continue;\n floats.add(time);\n }\n }\n\n private class AnimationTree {\n private final AnimationTree parent;\n private final List children;\n private final BlueprintAnimator.AnimatorData data;\n private int searchCache = 0;\n private final Float2ObjectMap valueCache = new Float2ObjectOpenHashMap<>();\n\n AnimationTree(@NotNull BlueprintElement.Group group, @Nullable BlueprintAnimator.AnimatorData data) {\n this(null, group, data);\n }\n AnimationTree(\n @Nullable AnimationTree parent,\n @NotNull BlueprintElement.Group group,\n @Nullable BlueprintAnimator.AnimatorData data\n ) {\n this.parent = parent;\n this.data = data;\n children = filterIsInstance(group.children(), BlueprintElement.Group.class)\n .map(g -> new AnimationTree(this, g, pointMap.get(g.name())))\n .toList();\n }\n\n @NotNull\n Stream flatten() {\n return children.isEmpty() ? Stream.of(this) : Stream.concat(\n Stream.of(this),\n children.stream().flatMap(AnimationTree::flatten)\n );\n }\n\n private float tree(float first, float second, @NotNull Function> mapper) {\n var value = data != null ? mapper.apply(data) : Collections.emptyList();\n return findTree(first, second, value).length();\n }\n\n private @NotNull Vector3f findTree(float first, float second, @NotNull List target) {\n var get = find(first, second, target);\n return parent != null ? parent.findTree(first, second, target).add(get) : get;\n }\n private @NotNull Vector3f find(float first, float second, @NotNull List target) {\n return find(second, target).sub(find(first, target), new Vector3f());\n }\n private @NotNull Vector3f find(float time, @NotNull List target) {\n return valueCache.computeIfAbsent(time, _ -> {\n if (target.size() <= 1) return EMPTY;\n var i = searchCache;\n for (; i < target.size(); i++) {\n if (target.get(i).time() >= time) break;\n }\n searchCache = i;\n if (i == 0) return EMPTY;\n if (i == target.size()) return EMPTY;\n var first = target.get(i - 1);\n var second = target.get(i);\n var t1 = first.time();\n var t2 = second.time();\n var a = InterpolationUtil.alpha(t1, t2, time);\n return second.time() == time ? second.vector() : InterpolationUtil.lerp(\n first.vector(InterpolationUtil.lerp(t1, t2, a)),\n second.vector(),\n a\n );\n });\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintAnimation.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport kr.toxicity.model.api.animation.AnimationIterator;\nimport kr.toxicity.model.api.animation.AnimationModifier;\nimport kr.toxicity.model.api.animation.AnimationProgress;\nimport kr.toxicity.model.api.animation.TimedStorage;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.script.BlueprintScript;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Map;\n\n/**\n * Represents a complete, processed animation for a model.\n * \n * This record contains all the necessary data to play an animation, including keyframes for each bone,\n * loop settings, and associated scripts.\n *
\n *\n * @param name the name of the animation\n * @param loop the default loop mode\n * @param length the length of the animation in seconds\n * @param override whether this animation overrides others\n * @param animator a map of animators for each bone\n * @param script the script associated with this animation, if any\n * @param emptyAnimator a list of empty movements, used as a fallback or for initialization\n * @since 1.15.2\n */\npublic record BlueprintAnimation(\n @NotNull String name,\n @NotNull AnimationIterator.Type loop,\n float length,\n boolean override,\n @NotNull @Unmodifiable Map animator,\n @Nullable BlueprintScript script,\n @NotNull TimedStorage emptyAnimator\n) {\n\n /**\n * Retrieves the script for this animation, considering the provided modifier.\n * \n * If the modifier overrides the animation or specifies a player, the script may be suppressed.\n *
\n *\n * @param modifier the animation modifier\n * @return the script, or null if suppressed\n * @since 1.15.2\n */\n public @Nullable BlueprintScript script(@NotNull AnimationModifier modifier) {\n return modifier.override(override) || modifier.player() != null ? null : script;\n }\n\n /**\n * Creates an iterator for the empty animation sequence.\n *\n * @param type the loop type\n * @return an animation iterator\n * @since 1.15.2\n */\n public @NotNull AnimationIterator emptyIterator(@NotNull AnimationIterator.Type type) {\n return type.create(emptyAnimator);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintAnimator.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport kr.toxicity.model.api.animation.AnimationIterator;\nimport kr.toxicity.model.api.animation.AnimationKeyframe;\nimport kr.toxicity.model.api.animation.AnimationProgress;\nimport kr.toxicity.model.api.animation.VectorPoint;\nimport kr.toxicity.model.api.bone.BoneName;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.List;\nimport java.util.stream.Stream;\n\n/**\n * Represents the processed animation data for a single bone within a model blueprint.\n * \n * This record holds the sequence of keyframes that define the bone's movement over time.\n *
\n *\n * @param name the name of the bone this animator applies to\n * @param keyframe a list of animation movements representing the keyframes\n * @since 1.15.2\n */\npublic record BlueprintAnimator(\n @NotNull BoneName name,\n @NotNull AnimationKeyframe keyframe\n) {\n\n /**\n * Holds the raw, separated animation data points for a bone before final processing.\n *\n * @param name the name of the bone\n * @param position a list of position keyframes\n * @param scale a list of scale keyframes\n * @param rotation a list of rotation keyframes\n * @param rotationGlobal whether the rotation is applied globally\n * @since 1.15.2\n */\n public record AnimatorData(\n @NotNull BoneName name,\n @NotNull List position,\n @NotNull List scale,\n @NotNull List rotation,\n boolean rotationGlobal\n ) {\n /**\n * Returns a stream containing all keyframe points (position, scale, and rotation).\n *\n * @return a stream of all vector points\n * @since 1.15.2\n */\n public @NotNull Stream allPoints() {\n return Stream.concat(\n Stream.concat(\n position.stream(),\n scale.stream()\n ),\n rotation.stream()\n );\n }\n }\n\n /**\n * Creates an iterator for the keyframes based on a specified loop type.\n *\n * @param type the loop type (e.g., play_once, loop)\n * @return an animation iterator\n * @since 1.15.2\n */\n public @NotNull AnimationIterator iterator(@NotNull AnimationIterator.Type type) {\n return type.create(keyframe);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintElement.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport com.google.gson.JsonObject;\nimport io.github.toxicity188.javamesh.MeshBuilder;\nimport io.github.toxicity188.javamesh.MeshPoint;\nimport io.github.toxicity188.javamesh.MeshShape;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.bone.BoneTags;\nimport kr.toxicity.model.api.data.Float2;\nimport kr.toxicity.model.api.data.Float3;\nimport kr.toxicity.model.api.data.raw.ModelFace;\nimport kr.toxicity.model.api.pack.PackObfuscator;\nimport kr.toxicity.model.api.util.MathUtil;\nimport kr.toxicity.model.api.util.PackUtil;\nimport kr.toxicity.model.api.util.json.JsonObjectBuilder;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\nimport org.joml.Quaternionf;\n\nimport java.util.*;\nimport java.util.stream.Stream;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.*;\n\n/**\n * Represents a processed element within a model blueprint.\n * \n * This is a sealed interface with implementations for different types of elements like bones, groups, cubes, and locators.\n *
\n *\n * @since 1.15.2\n */\npublic sealed interface BlueprintElement {\n\n String MESH_TRIANGLE_SINGLE = \"mesh_triangle_single\";\n\n String MESH_TRIANGLE_DUPLEX = \"mesh_triangle_duplex\";\n\n String MESH_PIXEL = \"mesh_pixel\";\n\n /**\n * Represents an element that acts as a bone in the model's armature.\n *\n * @since 1.15.2\n */\n sealed interface Bone extends BlueprintElement {\n\n /**\n * Returns the UUID of the bone.\n *\n * @return the UUID\n * @since 1.15.2\n */\n @NotNull UUID uuid();\n\n /**\n * Returns the name of the bone.\n *\n * @return the bone name\n * @since 1.15.2\n */\n @NotNull BoneName name();\n\n /**\n * Returns the origin (pivot point) of the bone.\n *\n * @return the origin\n * @since 1.15.2\n */\n @NotNull Float3 origin();\n }\n\n /**\n * Returns the rotation of the element.\n *\n * @return the rotation, defaulting to zero\n * @since 1.15.2\n */\n default @NotNull Float3 rotation() {\n return Float3.ZERO;\n }\n\n /**\n * Checks if the element is visible.\n *\n * @return true if visible, false otherwise\n * @since 1.15.2\n */\n default boolean visibility() {\n return false;\n }\n\n /**\n * Represents a group of elements, forming a bone in the hierarchy.\n *\n * @param uuid the UUID of the group\n * @param name the name of the group/bone\n * @param origin the pivot point of the group\n * @param rotation the rotation of the group\n * @param children the list of child elements\n * @param visibility whether the group is visible\n * @since 1.15.2\n */\n record Group(\n @NotNull UUID uuid,\n @NotNull BoneName name,\n @NotNull Float3 origin,\n @NotNull Float3 rotation,\n @NotNull List children,\n boolean visibility\n ) implements Bone {\n\n /**\n * Returns the origin with inverted X and Z axes.\n *\n * @return the inverted origin\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Float3 origin() {\n return origin.invertXZ();\n }\n\n private @NotNull String jsonName(@NotNull BlueprintLoadContext context) {\n return PackUtil.toPackName(context.name() + \"_\" + name.rawName());\n }\n\n /**\n * Builds the JSON representation for legacy clients (1.21.3 or under).\n *\n * @param obfuscator the obfuscator for model and texture names\n * @param context the load context\n * @return the generated blueprint JSON, or null if not applicable\n * @since 1.15.2\n */\n public @Nullable BlueprintJson buildLegacyJson(\n @NotNull PackObfuscator.Pair obfuscator,\n @NotNull BlueprintLoadContext context\n ) {\n return buildJson(-2, 1, scale(), obfuscator, context, Float3.ZERO, filterIsInstance(children, Cube.class).filter(element -> MathUtil.checkValidDegree(element.identifierDegree())));\n }\n\n /**\n * Builds the JSON representation for modern clients.\n *\n * @param obfuscator the obfuscator for model and texture names\n * @param context the load context\n * @return a list of generated blueprint JSONs, or null if not applicable\n * @since 1.15.2\n */\n @Nullable\n @Unmodifiable\n public List buildModernJson(\n @NotNull PackObfuscator.Pair obfuscator,\n @NotNull BlueprintLoadContext context\n ) {\n var scale = scale();\n var list = mapIndexed(\n group(\n filterIsInstance(children, Cube.class),\n Cube::identifierDegree\n ),\n (i, entry) -> buildJson(0, i + 1, scale, obfuscator, context, entry.getKey(), entry.getValue().stream())\n ).filter(Objects::nonNull)\n .toList();\n return list.isEmpty() ? null : list;\n }\n\n /**\n * Builds the JSON representation for a mesh-based item model.\n *\n * @param context the load context\n * @return the generated mesh JSON, or null if no meshes are present\n * @since 3.0.0\n */\n public @Nullable JsonObject buildMeshItemModel(\n @NotNull BlueprintLoadContext context\n ) {\n var scale = 1F / scale();\n var meshes = filterIsInstance(children, Mesh.class).toList();\n if (meshes.isEmpty()) return null;\n var builder = MeshBuilder.of(context.triangleName())\n .matrixModifier(mat -> mat.scale(scale))\n .image(context.imageByIndex());\n meshes.forEach(mesh -> builder.load(mesh.toShape(origin)));\n return builder.toJson();\n }\n\n private @Nullable BlueprintJson buildJson(\n int tint,\n int number,\n float scale,\n @NotNull PackObfuscator.Pair obfuscator,\n @NotNull BlueprintLoadContext context,\n @NotNull Float3 identifier,\n @NotNull Stream cubes\n ) {\n var cubeElement = cubes\n .filter(Cube::hasTexture)\n .toList();\n var selectedTextures = cubeElement.stream()\n .flatMapToInt(tex -> tex.faces().textureIndex())\n .distinct()\n .sorted()\n .mapToObj(i -> Map.entry(Integer.toString(i), context.texture(i).packNamespace(obfuscator.textures())))\n .toList();\n if (selectedTextures.isEmpty()) return null;\n return new BlueprintJson(obfuscator.models().obfuscate(jsonName(context) + \"_\" + number), () -> JsonObjectBuilder.builder()\n .jsonObject(\"textures\", textures -> textures\n .stringProperties(selectedTextures)\n .property(\"particle\", selectedTextures.getFirst().getValue()))\n .jsonArray(\"elements\", mapToJson(cubeElement, cube -> cube.buildJson(tint, scale, context, this, identifier)))\n .jsonObject(\"display\", display -> display.jsonObject(\"fixed\", fixed -> {\n if (!identifier.equals(Float3.ZERO)) {\n fixed.jsonArray(\"rotation\", identifier.convertToMinecraftDegree().toJson());\n }\n }))\n .build());\n }\n\n /**\n * Calculates the required scale for the cubes in this group.\n *\n * @return the scale factor\n * @since 1.15.2\n */\n public float scale() {\n return (float) Math.max(filterIsInstance(children, Cube.class)\n .mapToDouble(e -> e.max(origin) / 16F)\n .max()\n .orElse(1F), 1F);\n }\n\n /**\n * Calculates the bounding box for this group to be used as a hitbox.\n *\n * @return the named bounding box, or null if no cubes are present\n * @since 1.15.2\n */\n public @Nullable ModelBoundingBox hitBox() {\n return filterIsInstance(children, Cube.class)\n .map(element -> {\n var from = element.from()\n .minus(origin)\n .toBlockScale();\n var to = element.to()\n .minus(origin)\n .toBlockScale();\n return ModelBoundingBox.of(\n from.x(),\n from.y(),\n from.z(),\n to.x(),\n to.y(),\n to.z()\n ).invert();\n })\n .max(Comparator.comparingDouble(ModelBoundingBox::length))\n .orElse(null);\n }\n }\n\n /**\n * Represents a locator element, used as a named attachment point.\n *\n * @param uuid the UUID of the locator\n * @param name the name of the locator\n * @param origin the position of the locator\n * @since 1.15.2\n */\n record Locator(\n @NotNull UUID uuid,\n @NotNull BoneName name,\n @NotNull Float3 origin\n ) implements Bone {\n /**\n * Returns the origin with inverted X and Z axes.\n *\n * @return the inverted origin\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Float3 origin() {\n return origin.invertXZ();\n }\n }\n\n /**\n * Represents a camera element (currently a placeholder).\n *\n * @param uuid the UUID of the camera\n * @since 1.15.2\n */\n record Camera(\n @NotNull UUID uuid\n ) implements BlueprintElement {\n }\n\n /**\n * Represents a null object, often used for IK or as a simple bone.\n *\n * @param uuid the UUID of the null object\n * @param name the name of the null object\n * @param ikTarget the UUID of the IK target bone\n * @param ikSource the UUID of the IK source bone\n * @param origin the position of the null object\n * @since 1.15.2\n */\n record NullObject(\n @NotNull UUID uuid,\n @NotNull BoneName name,\n @Nullable UUID ikTarget,\n @Nullable UUID ikSource,\n @NotNull Float3 origin\n ) implements Bone {\n /**\n * Returns the origin with inverted X and Z axes.\n *\n * @return the inverted origin\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Float3 origin() {\n return origin.invertXZ();\n }\n }\n\n /**\n * Represents a cube element, the basic building block of a model.\n *\n * @param name the name of the cube\n * @param from the starting coordinate (min corner)\n * @param to the ending coordinate (max corner)\n * @param inflate the inflation value\n * @param rotation the rotation of the cube\n * @param origin the pivot point of the cube\n * @param faces the UV mapping for the faces\n * @param lightEmission the light emission level (1-15 or null if 0)\n * @param visibility whether the cube is visible\n * @since 1.15.2\n */\n record Cube(\n @NotNull String name,\n @NotNull Float3 from,\n @NotNull Float3 to,\n float inflate,\n @NotNull Float3 rotation,\n @NotNull Float3 origin,\n @Nullable ModelFace faces,\n @Nullable Integer lightEmission,\n boolean visibility\n ) implements BlueprintElement {\n\n private @NotNull Float3 identifierDegree() {\n return MathUtil.identifier(rotation());\n }\n\n private static @NotNull Float3 centralize(@NotNull Float3 target, @NotNull Float3 groupOrigin, float scale) {\n return target.minus(groupOrigin).div(scale);\n }\n\n private static @NotNull Float3 deltaPosition(@NotNull Float3 target, @NotNull Quaternionf quaternionf) {\n return target.rotate(quaternionf).minus(target);\n }\n\n private @NotNull JsonObject buildJson(\n int tint,\n float scale,\n @NotNull BlueprintLoadContext parent,\n @NotNull BlueprintElement.Group group,\n @NotNull Float3 identifier\n ) {\n var qua = identifier.toQuaternionZYX().invert();\n var centerOrigin = centralize(origin(), group.origin, scale);\n var groupDelta = deltaPosition(centerOrigin, qua);\n var inflate = new Float3(inflate() / scale);\n return JsonObjectBuilder.builder()\n .property(\"light_emission\", group.name.tagged(BoneTags.GLOW) ? Integer.valueOf(15) : lightEmission)\n .jsonArray(\"from\", centralize(from(), group.origin, scale)\n .plus(groupDelta)\n .plus(Float3.CENTER)\n .minus(inflate)\n .toJson())\n .jsonArray(\"to\", centralize(to(), group.origin, scale)\n .plus(groupDelta)\n .plus(Float3.CENTER)\n .plus(inflate)\n .toJson())\n .jsonObject(\"faces\", faces().toJson(parent, tint))\n .jsonObject(\"rotation\", Optional.of(rotation().minus(identifier))\n .filter(r -> !Float3.ZERO.equals(r))\n .map(rot -> {\n var rotation = getRotation(rot);\n rotation.add(\"origin\", centerOrigin\n .plus(groupDelta)\n .plus(Float3.CENTER)\n .toJson());\n return rotation;\n })\n .orElse(null))\n .build();\n }\n\n /**\n * Calculates the maximum distance from the origin to any corner of the cube.\n *\n * @param origin the reference origin\n * @return the maximum length\n * @since 1.15.2\n */\n public float max(@NotNull Float3 origin) {\n var f = from().minus(origin);\n var t = to().minus(origin);\n var max = 0F;\n max = Math.max(max, Math.abs(f.x()));\n max = Math.max(max, Math.abs(f.y()));\n max = Math.max(max, Math.abs(f.z()));\n max = Math.max(max, Math.abs(t.x()));\n max = Math.max(max, Math.abs(t.y()));\n max = Math.max(max, Math.abs(t.z()));\n return max;\n }\n\n @Override\n public @NotNull ModelFace faces() {\n return Objects.requireNonNull(faces);\n }\n\n /**\n * Checks if this cube has any textures defined.\n *\n * @return true if it has textures, false otherwise\n * @since 1.15.2\n */\n public boolean hasTexture() {\n return faces != null && faces.hasTexture();\n }\n\n private @NotNull JsonObject getRotation(@NotNull Float3 rot) {\n var rotation = new JsonObject();\n if (Math.abs(rot.x()) > 0) {\n rotation.addProperty(\"angle\", rot.x());\n rotation.addProperty(\"axis\", \"x\");\n } else if (Math.abs(rot.y()) > 0) {\n rotation.addProperty(\"angle\", rot.y());\n rotation.addProperty(\"axis\", \"y\");\n } else if (Math.abs(rot.z()) > 0) {\n rotation.addProperty(\"angle\", rot.z());\n rotation.addProperty(\"axis\", \"z\");\n }\n return rotation;\n }\n }\n\n /**\n * Represents a mesh element, allowing for complex geometry beyond simple cubes.\n *\n * @param origin the pivot point of the mesh\n * @param rotation the rotation of the mesh\n * @param faces the list of faces forming the mesh\n * @param visibility whether the mesh is visible\n * @since 3.0.0\n */\n record Mesh(\n @NotNull Float3 origin,\n @NotNull Float3 rotation,\n @NotNull List faces,\n boolean visibility\n ) implements BlueprintElement {\n\n /**\n * Converts this mesh into a list of {@link MeshShape} for rendering.\n *\n * @param parentOrigin the origin of the parent bone\n * @return an unmodifiable list of mesh shapes\n * @since 3.0.0\n */\n @NotNull\n @Unmodifiable\n public List toShape(@NotNull Float3 parentOrigin) {\n var deltaOrigin = origin().minus(parentOrigin).toVector();\n var pointRotation = rotation().toQuaternionXYZ();\n return faces.stream()\n .map(face -> new MeshShape(\n face.points.stream()\n .map(p -> new MeshPoint(\n p.vertices.toVector()\n .rotate(pointRotation)\n .add(deltaOrigin)\n .mul(-1F, 1F, -1F)\n .div(MathUtil.MODEL_TO_BLOCK_MULTIPLIER),\n p.uv.toVector()\n .div(MathUtil.MODEL_TO_BLOCK_MULTIPLIER)\n ))\n .toList(),\n Integer.toString(face.texture)\n ))\n .toList();\n }\n\n /**\n * Represents a single face of a mesh.\n *\n * @param points the vertices and UV coordinates of the face\n * @param texture the index of the texture used by this face\n * @since 3.0.0\n */\n public record Face(@NotNull @Unmodifiable List points, int texture) {}\n\n /**\n * Represents a single point (vertex) in a mesh face.\n *\n * @param vertices the 3D coordinates of the vertex\n * @param uv the 2D UV coordinates for texture mapping\n * @since 3.0.0\n */\n public record Point(@NotNull Float3 vertices, @NotNull Float2 uv) {}\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintImage.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport com.google.gson.JsonObject;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents an image file to be generated as part of the resource pack.\n * \n * This record holds the image's name, its binary content, and an optional .mcmeta file for animations.\n *
\n *\n * @param name the name of the image file (including extension)\n * @param image the binary content of the image\n * @param mcmeta the JSON object for the .mcmeta file, if any\n * @since 1.15.2\n */\npublic record BlueprintImage(@NotNull String name, byte[] image, @Nullable JsonObject mcmeta) {\n /**\n * Returns the estimated size of the image in bytes.\n *\n * @return the image size\n * @since 1.15.2\n */\n public long estimatedSize() {\n return image.length;\n }\n\n /**\n * Returns the name of the image file with a .png extension.\n *\n * @return the png file name\n * @since 2.0.1\n */\n public @NotNull String pngName() {\n return name + \".png\";\n }\n\n /**\n * Returns the name of the metadata file associated with the png.\n *\n * @return the mcmeta file name\n * @since 2.0.1\n */\n public @NotNull String mcmetaName() {\n return pngName() + \".mcmeta\";\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintJson.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport com.google.gson.JsonElement;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.function.Supplier;\n\n/**\n * Represents a JSON file to be generated as part of the resource pack.\n * \n * This record holds the file name and a supplier for the JSON content.\n *
\n *\n * @param name the name of the JSON file (without extension)\n * @param element a supplier that provides the JSON content\n * @since 1.15.2\n */\npublic record BlueprintJson(\n @NotNull String name,\n @NotNull Supplier element\n) {\n\n /**\n * Returns the name of the JSON file with a .json extension.\n *\n * @return the JSON file name\n * @since 2.0.1\n */\n public @NotNull String jsonName() {\n return name + \".json\";\n }\n\n /**\n * Builds and returns the JSON content by invoking the supplier.\n *\n * @since 2.0.1\n * @return the generated JSON element\n */\n public @NotNull JsonElement buildJson() {\n return element.get();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintLoadContext.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2026 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport io.github.toxicity188.javamesh.MeshImage;\nimport io.github.toxicity188.javamesh.MeshTriangleName;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.data.raw.ModelResolution;\nimport kr.toxicity.model.api.pack.PackObfuscator;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport javax.imageio.ImageIO;\nimport java.io.ByteArrayInputStream;\nimport java.io.IOException;\nimport java.util.*;\nimport java.util.concurrent.atomic.AtomicBoolean;\nimport java.util.stream.Collectors;\nimport java.util.stream.IntStream;\nimport java.util.stream.Stream;\n\n/**\n * A context class for loading blueprints.\n *\n * @since 3.0.0\n */\n@ApiStatus.Internal\npublic final class BlueprintLoadContext {\n\n private final String name;\n private final ModelResolution resolution;\n private final TextureRef[] textureRefs;\n private final boolean canBeRendered;\n\n private volatile Map imageRefMap;\n\n private final MeshTriangleName triangleName = new MeshTriangleName(\n BetterModel.config().namespace() + \":\" + BlueprintElement.MESH_TRIANGLE_SINGLE,\n BetterModel.config().namespace() + \":\" + BlueprintElement.MESH_TRIANGLE_DUPLEX\n );\n\n BlueprintLoadContext(\n @NotNull String name,\n @NotNull ModelResolution resolution,\n @NotNull List textures\n ) {\n this.name = name;\n this.resolution = resolution;\n this.textureRefs = new TextureRef[textures.size()];\n var i = 0;\n var canBeRendered = false;\n for (BlueprintTexture texture : textures) {\n canBeRendered |= texture.canBeRendered();\n this.textureRefs[i++] = new TextureRef(texture);\n }\n this.canBeRendered = canBeRendered;\n }\n\n /**\n * Gets the name of the blueprint.\n *\n * @return the name\n * @since 3.0.0\n */\n public @NotNull String name() {\n return name;\n }\n\n /**\n * Gets the mesh triangle name.\n *\n * @return the triangle name\n * @since 3.0.0\n */\n public @NotNull MeshTriangleName triangleName() {\n return triangleName;\n }\n\n /**\n * Gets the model resolution.\n *\n * @return the resolution\n * @since 3.0.0\n */\n public @NotNull ModelResolution resolution() {\n return resolution;\n }\n\n /**\n * Gets a texture by its index.\n *\n * @param index the index\n * @return the texture\n * @since 3.0.0\n */\n public @NotNull BlueprintTexture texture(int index) {\n return Objects.requireNonNull(textureRefs[index]).texture();\n }\n\n @NotNull\n @Unmodifiable\n Map imageByIndex() {\n Map map;\n if ((map = imageRefMap) != null) return map;\n synchronized (this) {\n if ((map = imageRefMap) != null) return map;\n return imageRefMap = Collections.unmodifiableMap(new AbstractMap<>() {\n @Override\n public MeshImage get(Object key) {\n var get = textureRefs[Integer.parseInt(key.toString())];\n return get != null ? get.image() : null;\n }\n\n @Override\n @Unmodifiable\n public @NotNull Set> entrySet() {\n return IntStream.range(0, textureRefs.length)\n .mapToObj(i -> Map.entry(Integer.toString(i), textureRefs[i].image()))\n .collect(Collectors.toUnmodifiableSet());\n }\n });\n }\n }\n\n /**\n * Returns whether this context can be rendered.\n *\n * @return true if renderable\n * @since 3.0.0\n */\n public boolean canBeRendered() {\n return canBeRendered;\n }\n\n /**\n * Builds a stream of blueprint images using the provided obfuscator.\n *\n * @param obfuscator the obfuscator\n * @return a stream of images\n * @since 3.0.0\n */\n @NotNull\n public Stream buildImage(@NotNull PackObfuscator obfuscator) {\n if (!canBeRendered()) return Stream.empty();\n return Arrays.stream(textureRefs)\n .filter(TextureRef::canBeRendered)\n .map(ref -> new BlueprintImage(\n ref.texture.packName(obfuscator),\n ref.texture.image(),\n ref.texture.isAnimatedTexture() ? ref.texture.toMcmeta() : null)\n );\n }\n\n private static final class TextureRef {\n\n private final BlueprintTexture texture;\n private final AtomicBoolean referenced = new AtomicBoolean();\n private volatile MeshImage image;\n\n private TextureRef(BlueprintTexture texture) {\n this.texture = texture;\n }\n\n public boolean canBeRendered() {\n return referenced.get() && texture.canBeRendered();\n }\n\n public @NotNull BlueprintTexture texture() {\n referenced.set(true);\n return texture;\n }\n\n public @NotNull MeshImage image() {\n MeshImage img;\n if ((img = image) != null) return img;\n synchronized (this) {\n if ((img = image) != null) return img;\n try (var input = new ByteArrayInputStream(texture.image())) {\n return image = MeshImage.from(ImageIO.read(input));\n } catch (IOException e) {\n throw new RuntimeException(e);\n }\n }\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/BlueprintTexture.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport com.google.gson.JsonObject;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.data.raw.ModelResolution;\nimport kr.toxicity.model.api.pack.PackObfuscator;\nimport kr.toxicity.model.api.util.json.JsonObjectBuilder;\nimport org.jetbrains.annotations.NotNull;\n\n/**\n * Represents a processed texture in a model blueprint.\n * \n * This record holds the texture's name, binary image data, dimensions, and rendering properties.\n *
\n *\n * @param name the internal name of the texture\n * @param image the binary content of the texture image\n * @param width the original width of the texture in pixels\n * @param height the original height of the texture in pixels\n * @param uvWidth the UV width of the texture, if specified\n * @param uvHeight the UV height of the texture, if specified\n * @param canBeRendered whether this texture should be included in the resource pack\n * @param frameTime the frame time of the texture\n * @param frameInterpolate the interpolation flag of the texture\n * @since 1.15.2\n */\npublic record BlueprintTexture(\n @NotNull String name,\n byte[] image,\n int width,\n int height,\n int uvWidth,\n int uvHeight,\n boolean canBeRendered,\n int frameTime,\n boolean frameInterpolate\n) {\n /**\n * Checks if this texture is an animated texture (a texture atlas for animation).\n *\n * @return true if it is an animated texture, false otherwise\n * @since 1.15.2\n */\n public boolean isAnimatedTexture() {\n if (hasUVSize()) {\n var h = (float) height / uvHeight;\n var w = (float) width / uvWidth;\n return h > w;\n } else {\n return height > 0 && width > 0 && height / width > 1;\n }\n }\n\n /**\n * Generates the .mcmeta file content for this texture if it is animated.\n *\n * @return the JSON object for the .mcmeta file\n * @since 1.15.2\n */\n public @NotNull JsonObject toMcmeta() {\n return JsonObjectBuilder.builder()\n .jsonObject(\"animation\", animation -> {\n animation.property(\"interpolate\", frameInterpolate());\n animation.property(\"frametime\", frameTime());\n })\n .build();\n }\n\n /**\n * Generates the pack-compliant file name for this texture.\n *\n * @param obfuscator the obfuscator to use for the name\n * @return the obfuscated file name\n * @since 1.15.2\n */\n public @NotNull String packName(@NotNull PackObfuscator obfuscator) {\n return obfuscator.obfuscate(name());\n }\n\n /**\n * Generates the full resource pack namespace path for this texture.\n *\n * @param obfuscator the obfuscator to use for the name\n * @return the texture's namespace path\n * @since 1.15.2\n */\n public @NotNull String packNamespace(@NotNull PackObfuscator obfuscator) {\n return BetterModel.config().namespace() + \":item/\" + packName(obfuscator);\n }\n\n /**\n * Checks if this texture has a specific UV size defined.\n *\n * @return true if UV width and height are specified, false otherwise\n * @since 1.15.2\n */\n public boolean hasUVSize() {\n return uvWidth > 0 && uvHeight > 0;\n }\n\n /**\n * Returns the effective resolution for this texture's UV mapping.\n *\n * @param resolution the parent model's resolution\n * @return the UV resolution, or the parent resolution if not specified\n * @since 1.15.2\n */\n public @NotNull ModelResolution resolution(@NotNull ModelResolution resolution) {\n if (!hasUVSize()) return resolution;\n return resolution.width() == width && resolution.height() == height ? resolution : new ModelResolution(uvWidth, uvHeight);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/ModelBlueprint.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport kr.toxicity.model.api.data.raw.ModelResolution;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.List;\nimport java.util.Map;\n\n/**\n * Represents a fully processed model blueprint, ready for generation and rendering.\n * \n * This record contains all the necessary data derived from a raw model file, including\n * textures, structural elements (bones/cubes), and animations.\n *
\n *\n * @param name the name of the model\n * @param resolution the texture resolution of the model\n * @param textures the list of textures used by the model\n * @param elements the hierarchical list of model elements (bones)\n * @param animations a map of animations available for this model\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelBlueprint(\n @NotNull String name,\n @NotNull ModelResolution resolution,\n @NotNull List textures,\n @NotNull List elements,\n @NotNull Map animations\n) {\n\n /**\n * Creates a new load context for this blueprint.\n *\n * @since 3.0.0\n * @return a new blueprint load context\n */\n public @NotNull BlueprintLoadContext context() {\n return new BlueprintLoadContext(\n name(),\n resolution(),\n textures()\n );\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/blueprint/ModelBoundingBox.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.blueprint;\n\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Quaterniond;\nimport org.joml.Vector3d;\nimport org.joml.Vector3f;\n\n/**\n * Represents an axis-aligned bounding box (AABB) for a model part.\n * \n * This record defines the spatial extent of a model element or group, used for hitboxes and collision detection.\n *
\n *\n * @param minX the minimum X coordinate\n * @param minY the minimum Y coordinate\n * @param minZ the minimum Z coordinate\n * @param maxX the maximum X coordinate\n * @param maxY the maximum Y coordinate\n * @param maxZ the maximum Z coordinate\n * @since 1.15.2\n */\npublic record ModelBoundingBox(\n double minX,\n double minY,\n double minZ,\n double maxX,\n double maxY,\n double maxZ\n) {\n /**\n * A minimal bounding box size (0.1 x 0.1 x 0.1).\n * @since 1.15.2\n */\n public static final ModelBoundingBox MIN = of(0.1, 0.1, 0.1);\n\n /**\n * Creates a bounding box from two corner vectors.\n *\n * @param min the minimum corner vector\n * @param max the maximum corner vector\n * @return the bounding box\n * @since 1.15.2\n */\n public static @NotNull ModelBoundingBox of(@NotNull Vector3d min, @NotNull Vector3d max) {\n return of(\n min.x,\n min.y,\n min.z,\n max.x,\n max.y,\n max.z\n );\n }\n\n /**\n * Creates a bounding box centered at the origin with the given dimensions.\n *\n * @param x the width (X-axis)\n * @param y the height (Y-axis)\n * @param z the depth (Z-axis)\n * @return the centered bounding box\n * @since 1.15.2\n */\n public static @NotNull ModelBoundingBox of(double x, double y, double z) {\n return of(\n -x / 2,\n -y / 2,\n -z / 2,\n x / 2,\n y / 2,\n z / 2\n );\n }\n\n /**\n * Creates a bounding box from explicit min/max coordinates.\n * \n * This method automatically ensures that min values are less than or equal to max values.\n *
\n *\n * @param minX the first X coordinate\n * @param minY the first Y coordinate\n * @param minZ the first Z coordinate\n * @param maxX the second X coordinate\n * @param maxY the second Y coordinate\n * @param maxZ the second Z coordinate\n * @return the normalized bounding box\n * @since 1.15.2\n */\n public static @NotNull ModelBoundingBox of(\n double minX,\n double minY,\n double minZ,\n double maxX,\n double maxY,\n double maxZ\n ) {\n return new ModelBoundingBox(\n Math.min(minX, maxX),\n Math.min(minY, maxY),\n Math.min(minZ, maxZ),\n Math.max(minX, maxX),\n Math.max(minY, maxY),\n Math.max(minZ, maxZ)\n );\n }\n\n /**\n * Returns the width of the bounding box (X-axis extent).\n *\n * @return the width\n * @since 1.15.2\n */\n public double x() {\n return maxX - minX;\n }\n\n /**\n * Returns the height of the bounding box (Y-axis extent).\n *\n * @return the height\n * @since 1.15.2\n */\n public double y() {\n return maxY - minY;\n }\n\n /**\n * Returns the Y coordinate of the center of the bounding box.\n *\n * @return the center Y\n * @since 1.15.2\n */\n public double centerY() {\n return (maxY + minY) / 2;\n }\n\n /**\n * Returns the depth of the bounding box (Z-axis extent).\n *\n * @return the depth\n * @since 1.15.2\n */\n public double z() {\n return maxZ - minZ;\n }\n\n /**\n * Returns the center point of the bounding box as a vector.\n *\n * @return the center vector\n * @since 1.15.2\n */\n public @NotNull Vector3f centerPoint() {\n return new Vector3f(\n (float) (minX + maxX),\n (float) (minY + maxY),\n (float) (minZ + maxZ)\n ).div(2F);\n }\n\n /**\n * Scales the bounding box by a uniform factor.\n *\n * @param scale the scale factor\n * @return the scaled bounding box\n * @since 1.15.2\n */\n public @NotNull ModelBoundingBox times(double scale) {\n return of(\n minX * scale,\n minY * scale,\n minZ * scale,\n maxX * scale,\n maxY * scale,\n maxZ * scale\n );\n }\n\n /**\n * Returns a new bounding box with the same dimensions but centered at the origin (0,0,0).\n *\n * @return the centered bounding box\n * @since 1.15.2\n */\n public @NotNull ModelBoundingBox center() {\n var center = centerPoint();\n return of(\n minX - center.x,\n minY - center.y,\n minZ - center.z,\n maxX - center.x,\n maxY - center.y,\n maxZ - center.z\n );\n }\n\n /**\n * Inverts the X and Z coordinates of the bounding box.\n *\n * @return the inverted bounding box\n * @since 1.15.2\n */\n public @NotNull ModelBoundingBox invert() {\n return of(\n -minX,\n minY,\n -minZ,\n -maxX,\n maxY,\n -maxZ\n );\n }\n\n /**\n * Rotates the bounding box around its center.\n *\n * @param quaterniond the rotation quaternion\n * @return the rotated bounding box\n * @since 1.15.2\n */\n public @NotNull ModelBoundingBox rotate(@NotNull Quaterniond quaterniond) {\n var centerVec = centerPoint();\n return of(\n min().sub(centerVec).rotate(quaterniond).add(centerVec),\n max().sub(centerVec).rotate(quaterniond).add(centerVec)\n );\n }\n\n /**\n * Returns the minimum corner as a vector.\n *\n * @return the min vector\n * @since 1.15.2\n */\n public @NotNull Vector3d min() {\n return new Vector3d(minX, minY, minZ);\n }\n\n /**\n * Returns the maximum corner as a vector.\n *\n * @return the max vector\n * @since 1.15.2\n */\n public @NotNull Vector3d max() {\n return new Vector3d(maxX, maxY, maxZ);\n }\n\n /**\n * Calculates the diagonal length in the XZ plane.\n *\n * @return the XZ diagonal length\n * @since 1.15.2\n */\n public double lengthZX() {\n return Math.sqrt(Math.pow(x(), 2) + Math.pow(z(), 2));\n }\n\n /**\n * Calculates the full diagonal length of the bounding box.\n *\n * @return the diagonal length\n * @since 1.15.2\n */\n public double length() {\n return Math.sqrt(Math.pow(x(), 2) + Math.pow(y(), 2) + Math.pow(z(), 2));\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/KeyframeChannel.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.annotations.SerializedName;\nimport org.jetbrains.annotations.ApiStatus;\n\n/**\n * Represents the type of property a keyframe affects.\n *\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic enum KeyframeChannel {\n /**\n * Affects the position of a bone.\n * @since 1.15.2\n */\n @SerializedName(\"position\")\n POSITION,\n /**\n * Affects the rotation of a bone.\n * @since 1.15.2\n */\n @SerializedName(\"rotation\")\n ROTATION,\n /**\n * Affects the scale of a bone.\n * @since 1.15.2\n */\n @SerializedName(\"scale\")\n SCALE,\n /**\n * Represents a timeline for sound or particle effects.\n * @since 1.15.2\n */\n @SerializedName(\"timeline\")\n TIMELINE,\n /**\n * Represents a sound effect.\n * @since 1.15.2\n */\n @SerializedName(\"sound\")\n SOUND,\n /**\n * Represents a particle effect.\n * @since 1.15.2\n */\n @SerializedName(\"particle\")\n PARTICLE,\n /**\n * Represents an unknown or unsupported channel.\n * @since 1.15.2\n */\n NOT_FOUND\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelAnimation.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport it.unimi.dsi.fastutil.objects.ObjectAVLTreeSet;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.animation.AnimationIterator;\nimport kr.toxicity.model.api.animation.AnimationProgress;\nimport kr.toxicity.model.api.animation.VectorPoint;\nimport kr.toxicity.model.api.data.blueprint.AnimationGenerator;\nimport kr.toxicity.model.api.data.blueprint.BlueprintAnimation;\nimport kr.toxicity.model.api.data.blueprint.BlueprintAnimator;\nimport kr.toxicity.model.api.data.blueprint.BlueprintElement;\nimport kr.toxicity.model.api.script.AnimationScript;\nimport kr.toxicity.model.api.script.BlueprintScript;\nimport kr.toxicity.model.api.script.TimeScript;\nimport kr.toxicity.model.api.util.InterpolationUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.*;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.associate;\n\n/**\n * Represents a raw animation definition from a model file.\n * \n * This record holds the properties of an animation, such as its name, length, loop mode,\n * and the animators that define the keyframes for each bone group.\n *
\n *\n * @param name the name of the animation\n * @param loop the loop mode (e.g., play_once, loop, hold)\n * @param override whether this animation should override others\n * @param uuid the unique identifier of the animation\n * @param length the total length of the animation in seconds\n * @param animators a map of animators, keyed by the UUID of the bone group they affect\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelAnimation(\n @NotNull String name,\n @Nullable AnimationIterator.Type loop,\n boolean override,\n @NotNull String uuid,\n float length,\n @Nullable Map animators\n) {\n /**\n * Converts this raw animation data into a processed {@link BlueprintAnimation}.\n *\n * @param context the model loading context\n * @param children the list of root blueprint elements\n * @return the blueprint animation\n * @since 1.15.2\n */\n public @NotNull BlueprintAnimation toBlueprint(\n @NotNull ModelLoadContext context,\n @NotNull List children\n ) {\n var animators = AnimationGenerator.createMovements(length(), children, associate(\n animators().entrySet().stream()\n .filter(e -> context.availableUUIDs.contains(e.getKey()))\n .map(Map.Entry::getValue)\n .filter(ModelAnimator::isAvailable)\n .map(a -> buildAnimationData(context, a)),\n BlueprintAnimator.AnimatorData::name\n ));\n return new BlueprintAnimation(\n name(),\n loop(),\n length(),\n override(),\n animators,\n Optional.ofNullable(animators().get(\"effects\"))\n .filter(ModelAnimator::isNotEmpty)\n .map(a -> toScript(a, context.placeholder))\n .orElseGet(() -> BlueprintScript.fromEmpty(this)),\n animators.isEmpty() ? AnimationProgress.emptyStorage(length()) : animators.values()\n .iterator()\n .next()\n .keyframe()\n .toEmpty()\n );\n }\n\n private @NotNull BlueprintScript toScript(@NotNull ModelAnimator animator, @NotNull ModelPlaceholder placeholder) {\n var set = new ObjectAVLTreeSet();\n set.add(TimeScript.EMPTY);\n set.add(TimeScript.EMPTY.time(length()));\n animator.stream()\n .filter(f -> f.point().hasScript())\n .map(d -> AnimationScript.of(Arrays.stream(placeholder.parseVariable(d.point().script()).split(\"\\n\"))\n .map(BetterModel.platform().scriptManager()::build)\n .filter(Objects::nonNull)\n .toList())\n .time(d.time()))\n .forEach(set::add);\n var array = new TimeScript[set.size()];\n var before = 0F;\n var i = 0;\n for (TimeScript timeScript : set) {\n var t = timeScript.time();\n array[i++] = timeScript.time(InterpolationUtil.roundTime(t - before));\n before = t;\n }\n return new BlueprintScript(\n name(),\n loop(),\n length(),\n List.of(array)\n );\n }\n\n /**\n * Returns the loop mode of the animation.\n *\n * @return the loop mode, defaulting to {@link AnimationIterator.Type#PLAY_ONCE} if null\n * @since 1.15.2\n */\n @Override\n public @NotNull AnimationIterator.Type loop() {\n return loop != null ? loop : AnimationIterator.Type.PLAY_ONCE;\n }\n\n /**\n * Returns the map of animators for this animation.\n *\n * @return the animators, or an empty map if null\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Map animators() {\n return animators != null ? animators : Collections.emptyMap();\n }\n\n @NotNull\n private BlueprintAnimator.AnimatorData buildAnimationData(@NotNull ModelLoadContext context, @NotNull ModelAnimator animator) {\n var position = new ArrayList();\n var rotation = new ArrayList();\n var scale = new ArrayList();\n var version = context.meta.formatVersion();\n animator.stream().filter(keyframe -> keyframe.time() <= length()).forEach(keyframe -> {\n switch (keyframe.channel()) {\n case POSITION -> position.add(keyframe.point(context, version::convertAnimationPosition));\n case ROTATION -> rotation.add(keyframe.point(context, version::convertAnimationRotation));\n case SCALE -> scale.add(keyframe.point(context, version::convertAnimationScale));\n }\n });\n return new BlueprintAnimator.AnimatorData(\n animator.name(),\n position,\n scale,\n rotation,\n animator.rotationGlobal()\n );\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelAnimator.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.bone.BoneName;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.stream.Stream;\n\n/**\n * Represents a raw animator from a model file, containing a set of keyframes for a specific bone group.\n *\n * @param name the name of the bone group this animator affects\n * @param keyframes the list of keyframes\n * @param _rotationGlobal whether the rotation is applied globally (true) or locally (false/null)\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelAnimator(\n @Nullable BoneName name,\n @Nullable List keyframes,\n @Nullable @SerializedName(\"rotation_global\") Boolean _rotationGlobal\n) {\n\n /**\n * Checks if the rotation should be applied globally.\n *\n * @return true if rotation is global, false otherwise\n * @since 1.15.2\n */\n public boolean rotationGlobal() {\n return Boolean.TRUE.equals(_rotationGlobal);\n }\n\n /**\n * Checks if this animator is valid and has keyframes.\n *\n * @return true if available, false otherwise\n * @since 1.15.2\n */\n public boolean isAvailable() {\n return name != null && isNotEmpty();\n }\n\n /**\n * Checks if this animator contains any keyframes.\n *\n * @return true if not empty, false otherwise\n * @since 1.15.2\n */\n public boolean isNotEmpty() {\n return !keyframes().isEmpty();\n }\n\n /**\n * Returns the name of the bone group this animator affects.\n *\n * @return the name of the bone group\n */\n @Override\n public @NotNull BoneName name() {\n return Objects.requireNonNull(name);\n }\n\n /**\n * Returns the list of keyframes for this animator. If no keyframes are present, an empty list is returned.\n *\n * @return the list of keyframes\n */\n @Override\n public @NotNull List keyframes() {\n return keyframes != null ? keyframes : Collections.emptyList();\n }\n\n /**\n * Returns a sorted stream of valid keyframes.\n *\n * @return the stream of keyframes\n * @since 1.15.2\n */\n public @NotNull Stream stream() {\n return keyframes().stream()\n .filter(ModelKeyframe::hasPoint)\n .sorted();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelData.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.Gson;\nimport com.google.gson.GsonBuilder;\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.data.Float2;\nimport kr.toxicity.model.api.data.Float3;\nimport kr.toxicity.model.api.data.Float4;\nimport kr.toxicity.model.api.data.blueprint.BlueprintAnimation;\nimport kr.toxicity.model.api.data.blueprint.ModelBlueprint;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.Collections;\nimport java.util.List;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.*;\n\n/**\n * Represents the raw data structure of a model file, typically parsed from a .bbmodel JSON file.\n * \n * This record holds all the top-level components of a BlockBench model, including metadata, elements, textures, and animations.\n * It serves as the initial data container before being processed into a {@link ModelBlueprint}.\n *
\n *\n * @param meta the metadata of the model\n * @param resolution the texture resolution\n * @param elements the list of cube/mesh elements\n * @param outliner the hierarchical structure of the model\n * @param textures the list of textures used in the model\n * @param animations the list of animations\n * @param groups the list of groups (used in BlockBench 5.0.0+)\n * @param placeholder the animation variable placeholders\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelData(\n @NotNull ModelMeta meta,\n @NotNull ModelResolution resolution,\n @NotNull List elements,\n @NotNull List outliner,\n @NotNull List textures,\n @Nullable List animations,\n @Nullable List groups,\n @Nullable @SerializedName(\"animation_variable_placeholders\") ModelPlaceholder placeholder\n) {\n /**\n * The GSON parser configured for deserializing model data.\n * @since 1.15.2\n */\n public static final Gson GSON = new GsonBuilder()\n .registerTypeAdapter(Float2.class, Float2.PARSER)\n .registerTypeAdapter(Float3.class, Float3.PARSER)\n .registerTypeAdapter(Float4.class, Float4.PARSER)\n .registerTypeAdapter(BoneName.class, BoneName.PARSER)\n .registerTypeAdapter(ModelMeta.class, ModelMeta.PARSER)\n .registerTypeAdapter(ModelOutliner.class, ModelOutliner.PARSER)\n .registerTypeAdapter(ModelPlaceholder.class, ModelPlaceholder.PARSER)\n .registerTypeAdapter(ModelElement.class, ModelElement.PARSER)\n .create();\n\n /**\n * Converts this raw model data into a processed {@link ModelBlueprint}.\n *\n * @param name the name to assign to the blueprint\n * @return the result of the loading process, containing the blueprint and any errors\n * @since 1.15.2\n */\n public @NotNull ModelLoadResult loadBlueprint(@NotNull String name) {\n return loadBlueprint(name, BetterModel.config().enableStrictLoading());\n }\n\n /**\n * Converts this raw model data into a processed {@link ModelBlueprint} with a specific loading mode.\n *\n * @param name the name to assign to the blueprint\n * @param strict whether to use strict loading mode (fail on unsupported features)\n * @return the result of the loading process, containing the blueprint and any errors\n * @since 1.15.2\n */\n public @NotNull ModelLoadResult loadBlueprint(@NotNull String name, boolean strict) {\n var context = new ModelLoadContext(\n name,\n placeholder(),\n meta(),\n associate(elements(), ModelElement::uuid),\n associate(groups(), ModelGroup::uuid),\n mapToSet(outliner().stream().flatMap(ModelOutliner::flatten), ModelOutliner::uuid),\n strict\n );\n var group = mapToList(outliner(), outliner -> outliner.toBlueprint(context));\n return new ModelLoadResult(\n new ModelBlueprint(\n context.name,\n resolution(),\n mapToList(textures(), texture -> texture.toBlueprint(context)),\n group,\n associate(animations().stream().map(raw -> raw.toBlueprint(context, group)), BlueprintAnimation::name)\n ),\n context.errors\n );\n }\n\n /**\n * Asserts that the model does not contain any unsupported element types.\n *\n * @throws RuntimeException if an unsupported element is found\n * @since 1.15.2\n */\n public void assertSupported() {\n elements().stream()\n .filter(e -> !e.isSupported())\n .findFirst()\n .ifPresent(e -> {\n throw new RuntimeException(\"This model file has unsupported element type: \" + e.type());\n });\n }\n\n /**\n * Returns the animation variable placeholders, or an empty placeholder if none are defined.\n *\n * @return the animation variable placeholders\n * @since 1.15.2\n */\n @Override\n public @NotNull ModelPlaceholder placeholder() {\n return placeholder != null ? placeholder : ModelPlaceholder.EMPTY;\n }\n\n /**\n * Returns the list of animations, or an empty list if none are defined.\n *\n * @return the list of animations\n * @since 1.15.2\n */\n @Override\n @NotNull\n public List animations() {\n return animations != null ? animations : Collections.emptyList();\n }\n\n /**\n * Returns the list of groups, or an empty list if none are defined.\n *\n * @return the list of groups\n * @since 1.15.2\n */\n @Override\n public @NotNull List groups() {\n return groups != null ? groups : Collections.emptyList();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelDatapoint.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonPrimitive;\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.util.function.Float2FloatConstantFunction;\nimport kr.toxicity.model.api.util.function.Float2FloatFunction;\nimport kr.toxicity.model.api.util.function.FloatFunction;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Vector3f;\n\nimport java.util.Objects;\n\n/**\n * Represents a single data point within a keyframe, which can be a static value or a Molang script.\n * \n * This record holds the raw JSON values for x, y, and z coordinates, or a script string.\n *
\n *\n * @param x the x-coordinate value or script\n * @param y the y-coordinate value or script\n * @param z the z-coordinate value or script\n * @param script the script string (used for sound/particle effects)\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelDatapoint(\n @Nullable JsonPrimitive x,\n @Nullable JsonPrimitive y,\n @Nullable JsonPrimitive z,\n @Nullable String script\n) {\n\n /**\n * Checks if this data point contains a script.\n *\n * @return true if a script is present, false otherwise\n * @since 1.15.2\n */\n public boolean hasScript() {\n return script != null;\n }\n\n /**\n * Returns the script string.\n *\n * @return the script\n * @throws NullPointerException if no script is present\n * @since 1.15.2\n */\n @Override\n public @NotNull String script() {\n return Objects.requireNonNull(script);\n }\n\n /**\n * Converts this data point into a function that returns a {@link Vector3f}.\n * \n * If the data point contains static values, it returns a constant function.\n * If it contains Molang expressions, it compiles them into a function that evaluates the expressions.\n *
\n *\n * @param context the model loading context\n * @return a function to get the vector value\n * @since 1.15.2\n */\n public @NotNull FloatFunction toFunction(@NotNull ModelLoadContext context) {\n var xb = build(x, context);\n var yb = build(y, context);\n var zb = build(z, context);\n if (xb instanceof Float2FloatConstantFunction(float xc)\n && yb instanceof Float2FloatConstantFunction(float yc)\n && zb instanceof Float2FloatConstantFunction(float zc)\n ) {\n return FloatFunction.of(new Vector3f(xc, yc, zc));\n } else {\n return f -> new Vector3f(\n xb.applyAsFloat(f),\n yb.applyAsFloat(f),\n zb.applyAsFloat(f)\n );\n }\n }\n\n private static @NotNull Float2FloatFunction build(@Nullable JsonPrimitive primitive, @NotNull ModelLoadContext context) {\n if (primitive == null) return Float2FloatFunction.ZERO;\n if (primitive.isNumber()) return Float2FloatFunction.of(primitive.getAsFloat());\n var string = primitive.getAsString().trim();\n if (string.isEmpty()) return Float2FloatFunction.ZERO;\n try {\n return Float2FloatFunction.of(Float.parseFloat(string));\n } catch (NumberFormatException ignored) {\n return context.trySupply(\n () -> BetterModel.platform().evaluator().compile(context.placeholder.parseVariable(string)),\n error -> new ModelLoadContext.Fallback<>(\n Float2FloatFunction.ZERO,\n \"Cannot parse this datapoint: \" + primitive + \", reason: \" + error.getMessage()\n )\n );\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelElement.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonDeserializer;\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.data.Float2;\nimport kr.toxicity.model.api.data.Float3;\nimport kr.toxicity.model.api.data.blueprint.BlueprintElement;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.*;\n\n/**\n * Represents a raw element within a model file.\n * \n * This interface is a sealed type that permits specific implementations for different element types\n * found in BlockBench models, such as cubes, locators, null objects, and cameras.\n *
\n *\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic sealed interface ModelElement {\n\n /**\n * The type identifier for a null object element.\n * @since 2.2.1\n */\n String NULL_OBJECT = \"null_object\";\n /**\n * The type identifier for a locator element.\n * @since 2.2.1\n */\n String LOCATOR = \"locator\";\n /**\n * The type identifier for a camera element.\n * @since 2.2.1\n */\n String CAMERA = \"camera\";\n /**\n * The type identifier for a cube element.\n * @since 2.2.1\n */\n String CUBE = \"cube\";\n /**\n * The type identifier for a mesh element.\n * @since 3.0.0\n */\n String MESH = \"mesh\";\n\n /**\n * A JSON deserializer that automatically dispatches to the correct {@link ModelElement} implementation based on the \"type\" field.\n * @since 1.15.2\n */\n JsonDeserializer PARSER = (json, _, context) -> {\n var t = json.getAsJsonObject().getAsJsonPrimitive(\"type\");\n var select = t != null ? t.getAsString() : CUBE;\n return switch (select) {\n case NULL_OBJECT -> context.deserialize(json, NullObject.class);\n case LOCATOR -> context.deserialize(json, Locator.class);\n case CAMERA -> context.deserialize(json, Camera.class);\n case CUBE -> context.deserialize(json, Cube.class);\n case MESH -> context.deserialize(json, Mesh.class);\n default -> new Unsupported(select);\n };\n };\n\n /**\n * Returns the unique identifier (UUID) of this element.\n *\n * @return the UUID string\n * @since 1.15.2\n */\n @NotNull String uuid();\n\n /**\n * Returns the type identifier of this element (e.g., \"cube\", \"locator\").\n *\n * @return the type string\n * @since 1.15.2\n */\n @NotNull String type();\n\n /**\n * Converts this raw element into a processed {@link BlueprintElement}.\n *\n * @return the blueprint element\n * @since 1.15.2\n */\n @NotNull BlueprintElement toBlueprint();\n\n /**\n * Checks if this element type is supported by the engine.\n *\n * @return true if supported, false otherwise\n * @since 1.15.2\n */\n default boolean isSupported() {\n return true;\n }\n\n /**\n * Represents a locator element, used for positioning attachments or particles.\n *\n * @param name the name of the locator\n * @param uuid the UUID of the locator\n * @param position the position of the locator\n * @since 1.15.2\n */\n record Locator(\n @NotNull String name,\n @NotNull String uuid,\n @Nullable Float3 position\n ) implements ModelElement {\n @Override\n public @NotNull String type() {\n return LOCATOR;\n }\n /**\n * Returns the position of the locator.\n *\n * @return the position, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n public @NotNull Float3 position() {\n return position != null ? position : Float3.ZERO;\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n return new BlueprintElement.Locator(\n UUID.fromString(uuid),\n BoneName.of(name()),\n position()\n );\n }\n }\n\n /**\n * Represents a camera element (currently used as a placeholder).\n *\n * @param uuid the UUID of the camera\n * @since 1.15.2\n */\n record Camera(\n @NotNull String uuid\n ) implements ModelElement {\n @Override\n public @NotNull String type() {\n return CAMERA;\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n return new BlueprintElement.Camera(\n UUID.fromString(uuid)\n );\n }\n }\n\n /**\n * Represents a null object, often used for grouping or IK targets.\n *\n * @param name the name of the null object\n * @param uuid the UUID of the null object\n * @param ikTarget the UUID of the IK target, if any\n * @param ikSource the UUID of the IK source, if any\n * @param position the position of the null object\n * @since 1.15.2\n */\n record NullObject(\n @NotNull String name,\n @NotNull String uuid,\n @Nullable @SerializedName(\"ik_target\") String ikTarget,\n @Nullable @SerializedName(\"ik_source\") String ikSource,\n @Nullable Float3 position\n ) implements ModelElement {\n @Override\n public @NotNull String type() {\n return NULL_OBJECT;\n }\n\n /**\n * Returns the position of the null object.\n *\n * @return the position, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n public @NotNull Float3 position() {\n return position != null ? position : Float3.ZERO;\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n return new BlueprintElement.NullObject(\n UUID.fromString(uuid),\n BoneName.of(name()),\n Optional.ofNullable(ikTarget())\n .filter(str -> !str.isEmpty())\n .map(UUID::fromString)\n .orElse(null),\n Optional.ofNullable(ikSource())\n .filter(str -> !str.isEmpty())\n .map(UUID::fromString)\n .orElse(null),\n position()\n );\n }\n }\n\n /**\n * Represents an unsupported element type.\n *\n * @param type the unsupported type string\n * @since 1.15.2\n */\n record Unsupported(@NotNull String type) implements ModelElement {\n\n @Override\n public @NotNull String uuid() {\n throw new UnsupportedOperationException(type());\n }\n\n @Override\n public boolean isSupported() {\n return false;\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n throw new UnsupportedOperationException(type());\n }\n }\n\n /**\n * Represents a standard cube element.\n *\n * @param name the name of the cube\n * @param uuid the UUID of the cube\n * @param from the starting coordinate (min corner)\n * @param to the ending coordinate (max corner)\n * @param inflate the inflation value (size increase)\n * @param rotation the rotation of the cube\n * @param origin the pivot point (origin) of the cube\n * @param faces the UV mapping for the faces\n * @param lightEmission the light emission level (0-15)\n * @param _visibility the visibility state (null means visible)\n * @since 1.15.2\n */\n record Cube(\n @NotNull String name,\n @NotNull String uuid,\n @Nullable Float3 from,\n @Nullable Float3 to,\n float inflate,\n @Nullable Float3 rotation,\n @NotNull Float3 origin,\n @Nullable ModelFace faces,\n @SerializedName(\"light_emission\") int lightEmission,\n @SerializedName(\"visibility\") @Nullable Boolean _visibility\n ) implements ModelElement {\n\n @Override\n public @NotNull String type() {\n return CUBE;\n }\n\n /**\n * Returns the starting coordinate (min corner).\n *\n * @return the from vector, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n public @NotNull Float3 from() {\n return from != null ? from : Float3.ZERO;\n }\n\n /**\n * Returns the ending coordinate (max corner).\n *\n * @return the to vector, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n public @NotNull Float3 to() {\n return to != null ? to : Float3.ZERO;\n }\n\n /**\n * Checks if the cube is visible.\n *\n * @return true if visible, false otherwise\n * @since 1.15.2\n */\n public boolean visibility() {\n return !Boolean.FALSE.equals(_visibility);\n }\n\n /**\n * Returns the rotation of the cube.\n *\n * @return the rotation, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n public @NotNull Float3 rotation() {\n return rotation != null ? rotation : Float3.ZERO;\n }\n\n /**\n * Returns the light emission level of the cube.\n *\n * @return the light emission level (0-15)\n * @since 2.1.0\n */\n @Override\n public int lightEmission() {\n return name().toLowerCase().contains(\"glow\") ? 15 : lightEmission;\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n return new BlueprintElement.Cube(\n name(),\n from(),\n to(),\n inflate(),\n rotation(),\n origin(),\n faces(),\n Optional.of(lightEmission()).filter(i -> i > 0).orElse(null),\n visibility()\n );\n }\n }\n\n /**\n * Represents a mesh element, allowing for complex geometry beyond simple cubes.\n *\n * @param uuid the UUID of the mesh\n * @param origin the pivot point (origin) of the mesh\n * @param rotation the rotation of the mesh\n * @param vertices a map of vertex identifiers to their 3D positions\n * @param faces a map of face identifiers to their face data\n * @param _visibility the visibility state (null means visible)\n * @since 3.0.0\n */\n record Mesh(\n @NotNull String uuid,\n @Nullable Float3 origin,\n @Nullable Float3 rotation,\n @NotNull Map vertices,\n @NotNull Map faces,\n @SerializedName(\"visibility\") @Nullable Boolean _visibility\n ) implements ModelElement {\n /**\n * Returns the pivot point (origin) of the mesh.\n *\n * @return the origin vector, or {@link Float3#ZERO} if not specified\n * @since 3.0.0\n */\n @Override\n public @NotNull Float3 origin() {\n return origin != null ? origin : Float3.ZERO;\n }\n\n /**\n * Returns the rotation of the mesh.\n *\n * @return the rotation vector, or {@link Float3#ZERO} if not specified\n * @since 3.0.0\n */\n @Override\n public @NotNull Float3 rotation() {\n return rotation != null ? rotation : Float3.ZERO;\n }\n\n /**\n * Returns the type identifier of this element.\n *\n * @return {@link #MESH}\n * @since 3.0.0\n */\n @Override\n public @NotNull String type() {\n return MESH;\n }\n\n public boolean visibility() {\n return !Boolean.FALSE.equals(_visibility);\n }\n\n @Override\n public @NotNull BlueprintElement toBlueprint() {\n return new BlueprintElement.Mesh(\n origin(),\n rotation(),\n faces.values()\n .stream()\n .map(face -> new BlueprintElement.Mesh.Face(\n face.vertices.stream()\n .map(n -> new BlueprintElement.Mesh.Point(\n Objects.requireNonNull(vertices.get(n)),\n Objects.requireNonNull(face.uv.get(n))\n ))\n .toList(),\n face.texture\n ))\n .toList(),\n visibility()\n );\n }\n\n /**\n * Represents a single face of a mesh.\n *\n * @param uv a map of vertex identifiers to their UV coordinates\n * @param vertices a set of vertex identifiers that form this face\n * @param texture the index of the texture used by this face\n * @since 3.0.0\n */\n public record Face(@NotNull Map uv, @NotNull Set vertices, int texture) {}\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelFace.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonObject;\nimport kr.toxicity.model.api.data.blueprint.BlueprintLoadContext;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.stream.IntStream;\n\n/**\n * Represents the UV mappings for all six faces of a cube element.\n *\n * @param north the UV mapping for the north face\n * @param east the UV mapping for the east face\n * @param south the UV mapping for the south face\n * @param west the UV mapping for the west face\n * @param up the UV mapping for the up face\n * @param down the UV mapping for the down face\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelFace(\n @NotNull ModelUV north,\n @NotNull ModelUV east,\n @NotNull ModelUV south,\n @NotNull ModelUV west,\n @NotNull ModelUV up,\n @NotNull ModelUV down\n) {\n /**\n * Converts the face UV data to a JSON object for the Minecraft model file.\n * \n * Only faces with a defined texture will be included in the output.\n *
\n *\n * @param parent the parent model blueprint, used for texture resolution\n * @param tint the tint index to apply\n * @return the generated JSON object\n * @since 1.15.2\n */\n public @NotNull JsonObject toJson(@NotNull BlueprintLoadContext parent, int tint) {\n var object = new JsonObject();\n JsonObject add;\n if ((add = north.toJson(parent, tint)) != null) object.add(\"north\", add);\n if ((add = east.toJson(parent, tint)) != null) object.add(\"east\", add);\n if ((add = south.toJson(parent, tint)) != null) object.add(\"south\", add);\n if ((add = west.toJson(parent, tint)) != null) object.add(\"west\", add);\n if ((add = up.toJson(parent, tint)) != null) object.add(\"up\", add);\n if ((add = down.toJson(parent, tint)) != null) object.add(\"down\", add);\n return object;\n }\n\n /**\n * Checks if any face has a texture defined.\n *\n * @return true if at least one face has a texture, false otherwise\n * @since 1.15.2\n */\n public boolean hasTexture() {\n return north.hasTexture()\n || east.hasTexture()\n || south.hasTexture()\n || west.hasTexture()\n || up.hasTexture()\n || down.hasTexture();\n }\n\n public @NotNull IntStream textureIndex() {\n var builder = IntStream.builder();\n if (north.hasTexture()) builder.add(north.textureIndex());\n if (east.hasTexture()) builder.add(east.textureIndex());\n if (south.hasTexture()) builder.add(south.textureIndex());\n if (west.hasTexture()) builder.add(west.textureIndex());\n if (up.hasTexture()) builder.add(up.textureIndex());\n if (down.hasTexture()) builder.add(down.textureIndex());\n return builder.build();\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelGroup.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.data.Float3;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\n/**\n * Represents a group definition in the raw model data.\n * \n * Groups are used to organize elements and other groups hierarchically.\n * This record corresponds to the group structure found in newer BlockBench versions (>= 5.0.0).\n *
\n *\n * @param name the name of the group\n * @param uuid the unique identifier of the group\n * @param origin the pivot point (origin) of the group\n * @param rotation the rotation of the group\n * @param lightEmission the light emission level (0-15)\n * @param _visibility the visibility state of the group (null means visible)\n * @since 1.15.2\n */\npublic record ModelGroup(\n @NotNull String name,\n @NotNull String uuid,\n @Nullable Float3 origin,\n @Nullable Float3 rotation,\n @SerializedName(\"light_emission\") int lightEmission,\n @Nullable @SerializedName(\"visibility\") Boolean _visibility\n) {\n /**\n * Returns the origin (pivot point) of the group.\n *\n * @return the origin, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Float3 origin() {\n return origin != null ? origin : Float3.ZERO;\n }\n\n /**\n * Returns the rotation of the group.\n *\n * @return the rotation, or {@link Float3#ZERO} if not specified\n * @since 1.15.2\n */\n @Override\n @NotNull\n public Float3 rotation() {\n return rotation != null ? rotation : Float3.ZERO;\n }\n\n /**\n * Checks if the group is visible.\n *\n * @return true if visible, false otherwise\n * @since 1.15.2\n */\n public boolean visibility() {\n return !Boolean.FALSE.equals(_visibility);\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelKeyframe.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.animation.Timed;\nimport kr.toxicity.model.api.animation.VectorPoint;\nimport kr.toxicity.model.api.data.Float3;\nimport kr.toxicity.model.api.util.interpolator.VectorInterpolator;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.joml.Vector3f;\n\nimport java.util.List;\nimport java.util.Optional;\nimport java.util.function.Function;\n\n/**\n * Represents a single keyframe in an animation timeline.\n * \n * A keyframe defines the state of a bone (position, rotation, or scale) at a specific time,\n * along with interpolation data (linear, catmull-rom, bezier) to smooth transitions.\n *
\n *\n * @param channel the channel this keyframe affects (position, rotation, scale)\n * @param dataPoints the list of data points (values) for this keyframe\n * @param bezierLeftTime the time offset for the left bezier handle\n * @param bezierLeftValue the value offset for the left bezier handle\n * @param bezierRightTime the time offset for the right bezier handle\n * @param bezierRightValue the value offset for the right bezier handle\n * @param interpolation the interpolation type (e.g., linear, catmullrom, bezier)\n * @param time the time of the keyframe in seconds\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelKeyframe(\n @Nullable KeyframeChannel channel,\n @SerializedName(\"data_points\") @NotNull List dataPoints,\n @SerializedName(\"bezier_left_time\") @Nullable Float3 bezierLeftTime,\n @SerializedName(\"bezier_left_value\") @Nullable Float3 bezierLeftValue,\n @SerializedName(\"bezier_right_time\") @Nullable Float3 bezierRightTime,\n @SerializedName(\"bezier_right_value\") @Nullable Float3 bezierRightValue,\n @Nullable VectorInterpolator interpolation,\n float time\n) implements Timed {\n\n /**\n * Checks if this keyframe contains any data points.\n *\n * @return true if data points exist, false otherwise\n * @since 1.15.2\n */\n public boolean hasPoint() {\n return !dataPoints.isEmpty();\n }\n\n /**\n * Returns the first data point in the list.\n *\n * @return the first data point\n * @throws java.util.NoSuchElementException if the list is empty\n * @since 1.15.2\n */\n public @NotNull ModelDatapoint point() {\n return dataPoints.getFirst();\n }\n\n /**\n * Converts this keyframe into a processed {@link VectorPoint}.\n *\n * @param context the model loading context\n * @param function a transformation function to apply to the vector values (e.g., coordinate conversion)\n * @return the vector point\n * @since 1.15.2\n */\n public @NotNull VectorPoint point(@NotNull ModelLoadContext context, @NotNull Function function) {\n return new VectorPoint(\n point().toFunction(context).map(function).memoize(),\n time(),\n new VectorPoint.BezierConfig(\n Optional.ofNullable(bezierLeftTime).map(Float3::toVector).orElse(null),\n Optional.ofNullable(bezierLeftValue).map(Float3::toVector).map(function).orElse(null),\n Optional.ofNullable(bezierRightTime).map(Float3::toVector).orElse(null),\n Optional.ofNullable(bezierRightValue).map(Float3::toVector).map(function).orElse(null)\n ),\n interpolation()\n );\n }\n\n /**\n * Returns the interpolation type for this keyframe.\n *\n * @return the interpolation type, defaulting to {@link VectorInterpolator#LINEAR} if null\n * @since 1.15.2\n */\n @Override\n public @NotNull VectorInterpolator interpolation() {\n return interpolation != null ? interpolation : VectorInterpolator.LINEAR;\n }\n\n /**\n * Returns the channel this keyframe affects.\n *\n * @return the channel, defaulting to {@link KeyframeChannel#NOT_FOUND} if null\n * @since 1.15.2\n */\n @Override\n public @NotNull KeyframeChannel channel() {\n return channel != null ? channel : KeyframeChannel.NOT_FOUND;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelLoadContext.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.*;\nimport java.util.function.Function;\nimport java.util.function.Supplier;\n\n/**\n * Holds the context and state during the model loading process.\n * \n * This class provides access to all parts of the raw model data and accumulates errors\n * that occur during processing. It also controls the loading mode (strict or lenient).\n *
\n *\n * @since 1.15.2\n */\n@RequiredArgsConstructor\n@ApiStatus.Internal\npublic final class ModelLoadContext {\n final @NotNull String name;\n final @NotNull ModelPlaceholder placeholder;\n final @NotNull ModelMeta meta;\n final @NotNull Map elements;\n final @NotNull Map groups;\n final @NotNull Set availableUUIDs;\n private final boolean strict;\n private final List _errors = new ArrayList<>();\n final List errors = Collections.unmodifiableList(_errors);\n\n /**\n * Tries to execute a supplier, catching exceptions in lenient mode.\n *\n * @param supplier the supplier to execute\n * @param fallbackFunction a function to provide a fallback value and error message on exception\n * @param the return type\n * @return the result of the supplier or the fallback value\n * @since 1.15.2\n */\n @NotNull T trySupply(@NotNull Supplier supplier, @NotNull Function> fallbackFunction) {\n if (strict) return supplier.get();\n try {\n return supplier.get();\n } catch (Exception e) {\n var fallback = fallbackFunction.apply(e);\n _errors.add(fallback.message);\n return fallback.value;\n }\n }\n\n /**\n * Represents a fallback value and an associated error message.\n *\n * @param value the fallback value\n * @param message the error message\n * @param the type of the value\n * @since 1.15.2\n */\n record Fallback(@NotNull T value, @NotNull String message) {}\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelLoadResult.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport kr.toxicity.model.api.data.blueprint.ModelBlueprint;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.List;\n\n/**\n * Represents the result of loading and processing a raw model file.\n * \n * This record contains the successfully created {@link ModelBlueprint} and a list of any errors\n * or warnings that occurred during the loading process.\n *
\n *\n * @param blueprint the processed model blueprint\n * @param errors a list of error or warning messages generated during loading\n * @since 1.15.2\n */\npublic record ModelLoadResult(@NotNull ModelBlueprint blueprint, @NotNull @Unmodifiable List errors) {\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelMeta.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonDeserializer;\nimport kr.toxicity.model.api.util.MathUtil;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\nimport org.joml.Vector3f;\nimport org.semver4j.Semver;\n\nimport java.util.Arrays;\nimport java.util.Objects;\n\n/**\n * Represents metadata about the model file, specifically the format version.\n * \n * This record is used to handle differences in coordinate systems and animation data between different BlockBench versions.\n *
\n *\n * @param formatVersion the detected format version of the model file\n * @since 1.15.2\n */\npublic record ModelMeta(\n @NotNull FormatVersion formatVersion\n) {\n /**\n * A JSON deserializer for parsing {@link ModelMeta} from the \"meta\" object in a .bbmodel file.\n * @since 1.15.2\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> new ModelMeta(\n FormatVersion.find(Objects.requireNonNull(Semver.coerce(json.getAsJsonObject().getAsJsonPrimitive(\"format_version\").getAsString())).getMajor())\n );\n\n /**\n * Enumerates supported BlockBench format versions and their specific coordinate conversions.\n * @since 1.15.2\n */\n @RequiredArgsConstructor\n public enum FormatVersion {\n /**\n * BlockBench version 5.0.0 and later.\n * @since 1.15.2\n */\n BLOCKBENCH_5(5) {\n @Override\n public @NotNull Vector3f convertAnimationRotation(@NotNull Vector3f vector) {\n vector.x = -vector.x;\n vector.z = -vector.z;\n return vector;\n }\n\n @Override\n public @NotNull Vector3f convertAnimationPosition(@NotNull Vector3f vector) {\n vector.x = -vector.x;\n vector.z = -vector.z;\n return vector.div(MathUtil.MODEL_TO_BLOCK_MULTIPLIER);\n }\n },\n /**\n * Legacy BlockBench versions (pre-5.0.0).\n * @since 1.15.2\n */\n BLOCKBENCH_LEGACY(0) {\n @Override\n public @NotNull Vector3f convertAnimationRotation(@NotNull Vector3f vector) {\n vector.y = -vector.y;\n vector.z = -vector.z;\n return vector;\n }\n\n @Override\n public @NotNull Vector3f convertAnimationPosition(@NotNull Vector3f vector) {\n vector.z = -vector.z;\n return vector.div(MathUtil.MODEL_TO_BLOCK_MULTIPLIER);\n }\n },\n ;\n\n private final int major;\n\n /**\n * Finds the appropriate format version based on the major version number.\n *\n * @param major the major version number\n * @return the matching format version\n * @throws java.util.NoSuchElementException if no matching version is found\n * @since 1.15.2\n */\n public static @NotNull FormatVersion find(int major) {\n return Arrays.stream(values())\n .filter(v -> v.major <= major)\n .findFirst()\n .orElseThrow();\n }\n\n /**\n * Converts animation rotation values to the engine's coordinate system.\n *\n * @param vector the raw rotation vector\n * @return the converted rotation vector\n * @since 1.15.2\n */\n public abstract @NotNull Vector3f convertAnimationRotation(@NotNull Vector3f vector);\n\n /**\n * Converts animation position values to the engine's coordinate system.\n *\n * @param vector the raw position vector\n * @return the converted position vector\n * @since 1.15.2\n */\n public abstract @NotNull Vector3f convertAnimationPosition(@NotNull Vector3f vector);\n\n /**\n * Converts animation scale values to the engine's format (relative to 1.0).\n *\n * @param vector the raw scale vector\n * @return the converted scale vector\n * @since 1.15.2\n */\n public @NotNull Vector3f convertAnimationScale(@NotNull Vector3f vector) {\n vector.sub(1F, 1F, 1F);\n return vector;\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelOutliner.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonDeserializer;\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.data.blueprint.BlueprintElement;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.UUID;\nimport java.util.stream.Stream;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.filterIsInstance;\nimport static kr.toxicity.model.api.util.CollectionUtil.mapToList;\n\n/**\n * Represents the hierarchical structure (outliner) of a model.\n * \n * The outliner defines the parent-child relationships between groups and elements (cubes, locators, etc.).\n * It can be either a direct reference to an element (UUID string) or a tree node (Group) containing children.\n *
\n *\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic sealed interface ModelOutliner {\n\n /**\n * A JSON deserializer that parses the outliner structure.\n * \n * It distinguishes between leaf nodes (UUID strings) and branch nodes (Groups with children).\n *
\n * @since 1.15.2\n */\n JsonDeserializer PARSER = (json, _, context) -> {\n if (json.isJsonPrimitive()) return new Reference(json.getAsString());\n else if (json.isJsonObject()) {\n var children = json.getAsJsonObject().getAsJsonArray(\"children\");\n return new Tree(\n context.deserialize(json, ModelGroup.class),\n children.asList()\n .stream()\n .map(child -> (ModelOutliner) context.deserialize(child, ModelOutliner.class))\n .toList()\n );\n }\n else throw new RuntimeException();\n };\n\n /**\n * Converts this outliner node into a processed {@link BlueprintElement}.\n *\n * @param context the model loading context\n * @return the blueprint element\n * @since 1.15.2\n */\n @NotNull BlueprintElement toBlueprint(@NotNull ModelLoadContext context);\n\n /**\n * Flattens the outliner tree into a stream of all nodes.\n *\n * @return a stream of all outliner nodes\n * @since 1.15.2\n */\n @NotNull Stream flatten();\n\n /**\n * Returns the UUID of this outliner node.\n *\n * @return the UUID string\n * @since 1.15.2\n */\n @NotNull String uuid();\n\n /**\n * Represents a leaf node in the outliner, referencing a specific element by UUID.\n *\n * @param uuid the UUID of the referenced element\n * @since 1.15.2\n */\n record Reference(@NotNull String uuid) implements ModelOutliner {\n @Override\n public @NotNull BlueprintElement toBlueprint(@NotNull ModelLoadContext context) {\n return Objects.requireNonNull(context.elements.get(uuid())).toBlueprint();\n }\n\n @Override\n public @NotNull Stream flatten() {\n return Stream.of(this);\n }\n }\n\n /**\n * Represents a branch node (Group) in the outliner, containing child nodes.\n *\n * @param group the group definition\n * @param children the list of child outliner nodes\n * @since 1.15.2\n */\n record Tree(\n @NotNull ModelGroup group,\n @NotNull @Unmodifiable List children\n ) implements ModelOutliner {\n\n @Override\n public @NotNull BlueprintElement toBlueprint(@NotNull ModelLoadContext context) {\n var child = mapToList(children, c -> c.toBlueprint(context));\n var filtered = filterIsInstance(child, BlueprintElement.Cube.class).toList();\n var selectedGroup = context.groups.getOrDefault(uuid(), group);\n return new BlueprintElement.Group(\n UUID.fromString(selectedGroup.uuid()),\n BoneName.of(selectedGroup.name()),\n selectedGroup.origin(),\n selectedGroup.rotation().invertXZ(),\n child,\n filtered.isEmpty() ? selectedGroup.visibility() : filtered.stream().anyMatch(BlueprintElement.Cube::visibility)\n );\n }\n\n @Override\n public @NotNull Stream flatten() {\n return children.isEmpty() ? Stream.of(this) : Stream.concat(\n Stream.of(this),\n children.stream().flatMap(ModelOutliner::flatten)\n );\n }\n\n @Override\n public @NotNull String uuid() {\n return group.uuid();\n }\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelPlaceholder.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2025 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonDeserializer;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Arrays;\nimport java.util.Collections;\nimport java.util.Map;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.associate;\n\n/**\n * Represents animation variable placeholders defined in a model file.\n * \n * These placeholders allow for defining reusable values or expressions that can be referenced within Molang scripts in animations.\n *
\n *\n * @param variables a map of placeholder variable names to their string values\n * @since 1.15.2\n */\npublic record ModelPlaceholder(\n @NotNull @Unmodifiable Map variables\n) {\n /**\n * An empty placeholder instance with no variables.\n * @since 1.15.2\n */\n public static final ModelPlaceholder EMPTY = new ModelPlaceholder(Collections.emptyMap());\n\n /**\n * A JSON deserializer for parsing placeholders from a multi-line string.\n * @since 1.15.2\n */\n public static final JsonDeserializer PARSER = (json, _, _) -> new ModelPlaceholder(associate(\n Arrays.stream(json.getAsString().split(\"\\n\"))\n .map(line -> line.split(\"=\", 2))\n .filter(array -> array.length == 2),\n array -> array[0].trim(),\n array -> array[1].trim()\n ));\n\n /**\n * Replaces all placeholder variables in a given expression with their corresponding values.\n *\n * @param expression the expression containing placeholders\n * @return the expression with placeholders substituted\n * @since 1.15.2\n */\n public @NotNull String parseVariable(@NotNull String expression) {\n for (var entry : variables.entrySet()) {\n expression = expression.replace(entry.getKey(), entry.getValue());\n }\n return expression;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelResolution.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport org.jetbrains.annotations.ApiStatus;\n\n/**\n * Represents the texture resolution of a model.\n *\n * @param width the width of the texture in pixels\n * @param height the height of the texture in pixels\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelResolution(\n int width,\n int height\n) {\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelTexture.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.annotations.SerializedName;\nimport kr.toxicity.model.api.data.blueprint.BlueprintTexture;\nimport kr.toxicity.model.api.util.PackUtil;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\n\nimport java.util.Base64;\n\n/**\n * Represents a raw texture definition from a model file.\n * \n * This record contains the texture's metadata and its content encoded as a Base64 string.\n *
\n *\n * @param name the name of the texture file (e.g., \"texture.png\")\n * @param source the Base64-encoded content of the texture image\n * @param width the width of the texture in pixels\n * @param height the height of the texture in pixels\n * @param uvWidth the UV width of the texture\n * @param uvHeight the UV height of the texture\n * @param frameTime the frame time of the texture\n * @param frameInterpolate the interpolation flag of the texture\n * @since 1.15.2\n */\n@ApiStatus.Internal\npublic record ModelTexture(\n @NotNull String name,\n @NotNull String source,\n int width,\n int height,\n @SerializedName(\"uv_width\") int uvWidth,\n @SerializedName(\"uv_height\") int uvHeight,\n @SerializedName(\"frame_time\") int frameTime,\n @SerializedName(\"frame_interpolate\") boolean frameInterpolate\n) {\n\n /**\n * Converts this raw texture into a processed {@link BlueprintTexture}.\n * \n * This method decodes the Base64 source, generates a pack-compliant name, and determines if the texture should be included in the pack.\n *
\n *\n * @param context the model loading context\n * @return the blueprint texture\n * @since 1.15.2\n */\n public @NotNull BlueprintTexture toBlueprint(@NotNull ModelLoadContext context) {\n var name = nameWithoutExtension();\n return new BlueprintTexture(\n PackUtil.toPackName(name.startsWith(\"global_\") ? name : context.name + \"_\" + name),\n Base64.getDecoder().decode(source().substring(source().indexOf(',') + 1)),\n width(),\n height(),\n uvWidth(),\n uvHeight(),\n !name.startsWith(\"-\"),\n frameTime(),\n frameInterpolate()\n );\n }\n\n /**\n * Returns the texture name without its file extension.\n *\n * @return the name without extension\n * @since 1.15.2\n */\n public @NotNull String nameWithoutExtension() {\n var name = name();\n var nameIndex = name.lastIndexOf('.');\n return nameIndex >= 0 ? name.substring(0, nameIndex) : name;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/raw/ModelUV.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.raw;\n\nimport com.google.gson.JsonElement;\nimport com.google.gson.JsonObject;\nimport kr.toxicity.model.api.data.Float4;\nimport kr.toxicity.model.api.data.blueprint.BlueprintLoadContext;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\n\nimport java.util.Objects;\n\n/**\n * Represents the UV mapping data for a model face.\n * \n * This record holds the UV coordinates, rotation, and texture index for a specific face of a model element.\n *
\n *\n * @param uv the UV coordinates as a {@link Float4} (u1, v1, u2, v2)\n * @param rotation the rotation of the UV map in degrees (0, 90, 180, 270)\n * @param texture the JSON element representing the texture index, can be null\n * @since 1.15.2\n */\npublic record ModelUV(\n @NotNull Float4 uv,\n int rotation,\n @Nullable JsonElement texture\n) {\n\n /**\n * Checks if this UV mapping has a valid texture index.\n *\n * @return true if a texture is defined, false otherwise\n * @since 1.15.2\n */\n public boolean hasTexture() {\n return texture != null && texture.isJsonPrimitive() && texture.getAsJsonPrimitive().isNumber();\n }\n\n /**\n * Returns the texture index associated with this UV mapping.\n *\n * @return the texture index\n * @throws NullPointerException if no texture is defined\n * @since 1.15.2\n */\n public int textureIndex() {\n return Objects.requireNonNull(texture).getAsInt();\n }\n\n /**\n * Converts this UV data to a JSON object for the Minecraft model file.\n *\n * @param context the blueprint context, used for texture resolution\n * @param tint the tint index to apply\n * @return the generated JSON object\n * @since 1.15.2\n */\n public @Nullable JsonObject toJson(@NotNull BlueprintLoadContext context, int tint) {\n if (!hasTexture()) return null;\n var div = uv.div(context.texture(textureIndex()).resolution(context.resolution()));\n if (!div.isValid()) return null;\n var object = new JsonObject();\n object.add(\"uv\", div.toJson());\n if (rotation != 0) object.addProperty(\"rotation\", rotation);\n object.addProperty(\"tintindex\", tint);\n object.addProperty(\"texture\", \"#\" + texture);\n return object;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/renderer/ModelRenderer.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.renderer;\n\nimport kr.toxicity.model.api.bone.BoneName;\nimport kr.toxicity.model.api.bone.RenderedBone;\nimport kr.toxicity.model.api.data.blueprint.BlueprintAnimation;\nimport kr.toxicity.model.api.entity.BaseEntity;\nimport kr.toxicity.model.api.platform.PlatformEntity;\nimport kr.toxicity.model.api.platform.PlatformLocation;\nimport kr.toxicity.model.api.profile.ModelProfile;\nimport kr.toxicity.model.api.tracker.DummyTracker;\nimport kr.toxicity.model.api.tracker.EntityTracker;\nimport kr.toxicity.model.api.tracker.TrackerModifier;\nimport lombok.Getter;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\n\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.Optional;\nimport java.util.SequencedMap;\nimport java.util.function.Consumer;\nimport java.util.stream.Stream;\n\n/**\n * A blueprint renderer.\n *\n * @param name name\n * @param type type\n * @param rendererGroups group map\n * @param animations animations\n */\npublic record ModelRenderer(\n @NotNull String name,\n @NotNull Type type,\n @NotNull @Unmodifiable SequencedMap rendererGroups,\n @NotNull @Unmodifiable Map animations\n) {\n /**\n * Gets a renderer group by tree\n *\n * @param name part name\n * @return group or null\n */\n public @Nullable RendererGroup groupByTree(@NotNull BoneName name) {\n return groupByTree0(rendererGroups, name);\n }\n\n private static @Nullable RendererGroup groupByTree0(@NotNull Map map, @NotNull BoneName name) {\n if (map.isEmpty()) return null;\n var get = map.get(name);\n if (get != null) return get;\n else return map.values()\n .stream()\n .map(g -> groupByTree0(g.getChildren(), name))\n .filter(Objects::nonNull)\n .findFirst()\n .orElse(null);\n }\n\n /**\n * Gets flatten groups.\n * @return flatten groups\n */\n public @NotNull Stream flatten() {\n return rendererGroups.values().stream().flatMap(RendererGroup::flatten);\n }\n\n /**\n * Gets blueprint animation by name\n *\n * @param name name\n * @return optional animation\n */\n public @NotNull Optional animation(@NotNull String name) {\n return Optional.ofNullable(animations().get(name));\n }\n\n //----- Dummy -----\n\n /**\n * Creates tracker by location\n *\n * @param location location\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location) {\n return create(location, TrackerModifier.DEFAULT);\n }\n\n /**\n * Creates tracker by location\n *\n * @param location location\n * @param modifier modifier\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull TrackerModifier modifier) {\n return create(location, modifier, _ -> {\n });\n }\n\n /**\n * Creates tracker by location\n *\n * @param location location\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(location);\n return source.create(\n pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n /**\n * Creates tracker by location and completed profile\n *\n * @param location location\n * @param profile profile\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull ModelProfile profile) {\n return create(location, profile.asUncompleted());\n }\n\n /**\n * Creates tracker by location and completed profile\n *\n * @param location location\n * @param profile profile\n * @param modifier modifier\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, ModelProfile profile, @NotNull TrackerModifier modifier) {\n return create(location, profile.asUncompleted(), modifier);\n }\n\n /**\n * Creates tracker by location and completed profile\n *\n * @param location location\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return create(location, profile.asUncompleted(), modifier, preUpdateConsumer);\n }\n\n /**\n * Creates tracker by location and uncompleted profile\n *\n * @param location location\n * @param profile profile\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull ModelProfile.Uncompleted profile) {\n return create(location, profile, TrackerModifier.DEFAULT);\n }\n\n /**\n * Creates tracker by location and uncompleted profile\n *\n * @param location location\n * @param profile profile\n * @param modifier modifier\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier) {\n return create(location, profile, modifier, _ -> {\n });\n }\n\n /**\n * Creates tracker by location and uncompleted profile\n *\n * @param location location\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return empty tracker\n */\n public @NotNull DummyTracker create(@NotNull PlatformLocation location, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(location, profile);\n return source.create(\n pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n //----- Entity -----\n\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity) {\n return create(BaseEntity.of(entity));\n }\n\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity, @NotNull TrackerModifier modifier) {\n return create(BaseEntity.of(entity), modifier);\n }\n\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return create(BaseEntity.of(entity), modifier, preUpdateConsumer);\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile) {\n return create(BaseEntity.of(entity), profile);\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier) {\n return create(BaseEntity.of(entity), profile, modifier);\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile skin\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return create(BaseEntity.of(entity), profile, modifier, preUpdateConsumer);\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity) {\n return getOrCreate(BaseEntity.of(entity));\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull TrackerModifier modifier) {\n return getOrCreate(BaseEntity.of(entity), modifier);\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return getOrCreate(BaseEntity.of(entity), modifier, preUpdateConsumer);\n }\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile profile) {\n return getOrCreate(entity, profile.asUncompleted());\n }\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier) {\n return getOrCreate(entity, profile.asUncompleted(), modifier);\n }\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile skin\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return getOrCreate(entity, profile.asUncompleted(), modifier, preUpdateConsumer);\n }\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile) {\n return getOrCreate(BaseEntity.of(entity), profile);\n }\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier) {\n return getOrCreate(BaseEntity.of(entity), profile, modifier);\n }\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile skin\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull PlatformEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return getOrCreate(BaseEntity.of(entity), profile, modifier, preUpdateConsumer);\n }\n\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity) {\n return create(entity, TrackerModifier.DEFAULT);\n }\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull TrackerModifier modifier) {\n return create(entity, modifier, _ -> {\n });\n }\n\n /**\n * Creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(entity);\n return source.create(\n pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n /**\n * Creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile profile) {\n return create(entity, profile.asUncompleted());\n }\n\n /**\n * Creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier) {\n return create(entity, profile.asUncompleted(), modifier);\n }\n\n /**\n * Creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return create(entity, profile.asUncompleted(), modifier, preUpdateConsumer);\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile.Uncompleted profile) {\n return create(entity, profile, TrackerModifier.DEFAULT);\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier) {\n return create(entity, profile, modifier, _ -> {\n });\n }\n\n /**\n * Creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker create(@NotNull BaseEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(entity, profile);\n return source.create(\n pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity) {\n return getOrCreate(entity, TrackerModifier.DEFAULT);\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull TrackerModifier modifier) {\n return getOrCreate(entity, modifier, _ -> {\n });\n }\n\n /**\n * Gets or creates tracker by entity\n *\n * @param entity entity\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(entity);\n return source.getOrCreate(\n name(),\n () -> pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull ModelProfile profile) {\n return getOrCreate(entity, profile.asUncompleted());\n }\n\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, ModelProfile profile, @NotNull TrackerModifier modifier) {\n return getOrCreate(entity, profile.asUncompleted(), modifier);\n }\n\n /**\n * Gets or creates tracker by entity and completed profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull ModelProfile profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n return getOrCreate(entity, profile.asUncompleted(), modifier, preUpdateConsumer);\n }\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull ModelProfile.Uncompleted profile) {\n return getOrCreate(entity, profile, TrackerModifier.DEFAULT);\n }\n\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier) {\n return getOrCreate(entity, profile, modifier, _ -> {\n });\n }\n\n /**\n * Gets or creates tracker by entity and uncompleted profile\n *\n * @param entity entity\n * @param profile profile\n * @param modifier modifier\n * @param preUpdateConsumer task on pre-update\n * @return entity tracker\n */\n public @NotNull EntityTracker getOrCreate(@NotNull BaseEntity entity, @NotNull ModelProfile.Uncompleted profile, @NotNull TrackerModifier modifier, @NotNull Consumer preUpdateConsumer) {\n var source = RenderSource.of(entity, profile);\n return source.getOrCreate(\n name(),\n () -> pipeline(source),\n modifier,\n preUpdateConsumer\n );\n }\n\n private @NotNull RenderPipeline pipeline(@NotNull RenderSource source) {\n return new RenderPipeline(\n this,\n source,\n rendererGroups.values().stream().map(value -> value.create(source)).toArray(RenderedBone[]::new)\n );\n }\n\n /**\n * Renderer type\n */\n @RequiredArgsConstructor\n @Getter\n public enum Type {\n /**\n * General\n */\n GENERAL(true),\n /**\n * Player\n */\n PLAYER(false)\n ;\n private final boolean canBeSaved;\n }\n}\n"
},
{
"path": "api/src/main/java/kr/toxicity/model/api/data/renderer/RenderPipeline.java",
"content": "/*\n * This source file is part of BetterModel.\n * Copyright (c) 2024 toxicity188\n * Licensed under the MIT License.\n * See LICENSE.md file for full license text.\n */\n\npackage kr.toxicity.model.api.data.renderer;\n\nimport kr.toxicity.model.api.BetterModel;\nimport kr.toxicity.model.api.animation.AnimationOverrideState;\nimport kr.toxicity.model.api.animation.RunningAnimation;\nimport kr.toxicity.model.api.bone.*;\nimport kr.toxicity.model.api.nms.AnimationBundler;\nimport kr.toxicity.model.api.nms.HitBox;\nimport kr.toxicity.model.api.nms.PacketBundler;\nimport kr.toxicity.model.api.nms.PlayerChannelHandler;\nimport kr.toxicity.model.api.platform.PlatformPlayer;\nimport kr.toxicity.model.api.tracker.ModelRotation;\nimport kr.toxicity.model.api.util.FunctionUtil;\nimport kr.toxicity.model.api.util.function.BonePredicate;\nimport kr.toxicity.model.api.util.function.FloatSupplier;\nimport lombok.Getter;\nimport lombok.RequiredArgsConstructor;\nimport org.jetbrains.annotations.ApiStatus;\nimport org.jetbrains.annotations.NotNull;\nimport org.jetbrains.annotations.Nullable;\nimport org.jetbrains.annotations.Unmodifiable;\nimport org.joml.Quaternionf;\nimport org.joml.Vector3f;\n\nimport java.util.*;\nimport java.util.concurrent.ConcurrentHashMap;\nimport java.util.function.BiPredicate;\nimport java.util.function.Consumer;\nimport java.util.function.Function;\nimport java.util.function.Predicate;\nimport java.util.stream.Stream;\n\nimport static kr.toxicity.model.api.util.CollectionUtil.associate;\nimport static kr.toxicity.model.api.util.CollectionUtil.associateSequenced;\n\n/**\n * Represents the rendering pipeline for a specific model instance.\n * \n * This class manages the hierarchy of {@link RenderedBone}s, handles player visibility and packet bundling,\n * and coordinates animation updates and inverse kinematics (IK) solving.\n *
\n *\n * @since 1.15.2\n */\npublic final class RenderPipeline implements BoneEventHandler, Iterable {\n\n @Getter\n private final ModelRenderer parent;\n @Getter\n private final RenderSource source;\n\n private final RenderedBone[] bones;\n private final RenderedBone[] flattenBones;\n private final SequencedMap byIdMap;\n\n private final int displayAmount;\n private final Map