blockbench import library

This library significantly simplifies the process of integrating Blockbench models (both standard ones and those created using the AnimatedJava plugin) into your Fabric mods. It automates the creation of item models and textures, using resource packs in combination with item display entities for client-side integration, eliminating the need for players to install additional mods.

The library provides full animation support, including Molang expressions for keyframes, as well as compatibility with various Blockbench features and additional support for the AnimatedJava plugin.

Key Features

• Animation Support: Import models with pre-rendered animations and use Molang expressions (currently only q.anim_time and q.life_time) for dynamic animation control.
• CustomModelData and Item Displays: Uses CustomModelData and item display entities to represent models with minimal server impact through "virtual" entities. Item display transformations are updated asynchronously for smooth performance.
• Large Bone Support: Overcomes vanilla game limitations, allowing the use of bones that exceed the standard 3x3x3 size restriction.
• Blockbench Feature Compatibility: Ensures operation with various Blockbench features, including effect keyframes (commands and sound effects), animation loop modes, interpolations, and more.
• AnimatedJava Extensions: Provides additional functionality for AnimatedJava, including variant support, bone blacklisting, conditional effects, and locator support.
• Vanilla Mob Feature Integration: Ready support for many vanilla mob features such as accurate hitboxes (visible in F3+B), ridability, name tags, invisibility, glowing, fire animations, particle effects, leashes, death animations, smooth collisions, dynamic hitboxes/scale, and entity-specific ticking for optimized performance.

Setup

repositories {
    maven { url "https://maven.tomalbrc.de" }
}

dependencies {
    modImplementation include("de.tomalbrc:blockbench-import-library:[TAG]")
}

Usage

Documentation is available at: https://tomalbrc.de/projects/bil/docs

Commands

• /bil model create id<.ajmodel>|filepath <model>

  Creates a model in the game based on a mob identifier or file path (from the server root folder) to the model JSON file. These models are not saved and are primarily intended for testing. If you want to load an .ajmodel file, make sure to add .ajmodel to either the identifier or file path.

• /bil model <targets> animation|variant|scale <args>

  Modifies the model of any selected entity in that has a custom model. Allows temporary changes to model scale, updating variants, and playing/pausing/stopping animations. This is also mainly intended for testing and experimenting with models.

Development Roadmap

Version 1.x

• Bone modifier for more dynamic animations
• Handling pre/post values for keyframes
• mcmeta generation for animated textures
• Bezier support for keyframes

Version 2.x

• Dynamic animations for dynamic animation speed, currently all animations are pre-rendered during import
• Per-player animations; Show animations to only a single player or group of players. Currently all animations play globally, visible to all players
• Multiple riders (for entities), currently only 1 is supported
• Multiple hitboxes (requires the same changes as multiple rider support)
• Particle effects (?)

Test Server

Join the test server with a 1.20.5-1.21+ client on

mc.tomalbrc.de:25565

to test this mod and my other mods + upcoming, unreleased mods and features!