GeckoLib

https://wiki.geckolib.com/docs/geckolib5
Admin
GeckoLib is a powerful animation library for Minecraft modding, allowing developers to create...
Tokens:47,353
Snippets:541
Trust Score:6.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Client Setup (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/armor/copy-paste-templates

Fabric client initialization that sets the geoRenderProvider for the armor item, using a memoized GeoArmorRenderer supplier.

```java
@Override  

public void onInitializeClient() {  

    ItemRegistry.EXAMPLE_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  

        private final Supplier<GeoArmorRenderer<ExampleItem, HumanoidRenderState>> renderer = Suppliers.memoize(() -> new GeoArmorRenderer<>(ItemRegistry.EXAMPLE_ARMOR_ITEM));  

  

        @Override  

        public @Nullable GeoArmorRenderer<?, ?> getGeoArmorRenderer(ItemStack itemStack, EquipmentSlot equipmentSlot) {  

            return this.renderer.get();  

        }  

    });  

}  
```

--------------------------------

### Client Setup (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/items/copy-paste-templates

Fabric client initialization that sets the geoRenderProvider on the item registry entry. Uses onInitializeClient and a memoized GeoItemRenderer.

```java
@Override  

public void onInitializeClient() {  

    ItemRegistry.EXAMPLE_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  

        private final Supplier<GeoItemRenderer<ExampleItem>> renderer = Suppliers.memoize(() -> new GeoItemRenderer<>(ExampleItem.this));  

  

        @Override  

        public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

            return this.renderer.get();  

        }  

    });  

}  
```

--------------------------------

### Create base item class with constructor

Source: https://wiki.geckolib.com/docs/geckolib5/items/the-item-class

Start by creating a class that extends Item and implements the base constructor.

```java
public class ExampleItem extends Item {  

    public ExampleItem(Properties properties) {  

        super(properties);  

    }  

}  

```

--------------------------------

### Create ExampleArmorItem with GeoItem and AnimatableInstanceCache

Source: https://wiki.geckolib.com/docs/geckolib5/armor/the-item-class

Step-by-step construction of the ExampleArmorItem class: start with the base Item constructor, then implement GeoItem with placeholder methods, and finally add the AnimatableInstanceCache field and return it from getAnimatableInstanceCache.

```java
public class ExampleArmorItem extends Item {  

    public ExampleArmorItem(ArmorMaterial material, ArmorType type, Properties properties) {  

        super(properties.humanoidArmor(material, type));  

    }  

}  
```

```java
public class ExampleArmorItem extends Item implements GeoItem {  

    public ExampleArmorItem(ArmorMaterial material, ArmorType type, Properties properties) {  

        super(properties.humanoidArmor(material, type));  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return null;  

    }  

}  
```

```java
public class ExampleArmorItem extends Item implements GeoItem {  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleArmorItem(ArmorMaterial material, ArmorType type, Properties properties) {  

        super(properties.humanoidArmor(material, type));  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Client Setup (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/armor/copy-paste-templates

Forge event handler that registers the armor renderer by setting the geoRenderProvider on the item, using a memoized GeoArmorRenderer supplier.

```java
@SubscribeEvent  

public static void registerRenderers(final EntityRenderersEvent.RegisterRenderers event) {  

    ItemRegistry.EXAMPLE_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  

        private final Supplier<GeoArmorRenderer<ExampleItem, HumanoidRenderState>> renderer = Suppliers.memoize(() -> new GeoArmorRenderer<>(ItemRegistry.EXAMPLE_ARMOR_ITEM.get()));  

  

        @Override  

        public @Nullable GeoArmorRenderer<?, ?> getGeoArmorRenderer(ItemStack itemStack, EquipmentSlot equipmentSlot) {  

            return this.renderer.get();  

        }  

    });  

}  
```

--------------------------------

### Create base entity class extending PathfinderMob

Source: https://wiki.geckolib.com/docs/geckolib5/entities/the-entity-class

Start with a simple entity class that extends PathfinderMob. This is the foundation for a GeckoLib entity.

```java
public class ExampleEntity extends PathfinderMob {  

    public ExampleEntity(EntityType<? extends PathfinderMob> entityType, Level level) {  

        super(entityType, level);  

    }  

}  
```

--------------------------------

### Animate bone rotation using BoneSnapshots

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geobones/bone-snapshots

Example of animating a bone named "MyBoneName" by rotating it 45 degrees. Uses snapshots.ifPresent to get the bone snapshot and setRotX with Mth.DEG_TO_RAD. Note: manual bone manipulation is generally discouraged; prefer Molang variables and JSON animations.

```java
@Override  

public void adjustModelBonesForRender(RenderPassInfo<R> renderPassInfo, BoneSnapshots snapshots) {  

    snapshots.ifPresent("MyBoneName", boneSnapshot -> {  

        boneSnapshot.setRotX(45 * Mth.DEG_TO_RAD);  

    });  

}
```

--------------------------------

### ExampleBlockEntity class (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Forge block entity class with GeckoLib animation cache and controller registration, using get() for the registry.

```java
public class ExampleBlockEntity extends BlockEntity {  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleBlockEntity(BlockPos pos, BlockState state) {  

        super(BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY.get(), pos, state);  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Create advanced renderer class (step 1)

Source: https://wiki.geckolib.com/docs/geckolib5/entities/the-entity-renderer

Starts an advanced renderer class by extending GeoEntityRenderer. This is the first step in creating a standalone renderer class that can override methods for additional handling.

```java
public class ExampleEntityRenderer extends GeoEntityRenderer {  

  

}  
```

--------------------------------

### ExampleBlock class (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Forge implementation of a block that implements EntityBlock, returning a block entity from the registry using get().

```java
public class ExampleBlock extends Block implements EntityBlock {  

    public ExampleBlock(BlockBehaviour.Properties properties) {  

        super(properties);  

    }  

  

    @Nullable  

    @Override  

    public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {  

        return BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY.get().create(pos, state);  

    }  

}  
```

--------------------------------

### Create base block class with constructor

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/the-block-class

Defines the ExampleBlock class extending Block with a constructor that takes BlockBehaviour.Properties. This is the starting point for a GeckoLib block.

```java
public class ExampleBlock extends Block {  

    public ExampleBlock(BlockBehaviour.Properties properties) {  

        super(properties);  

    }  

}  

```

--------------------------------

### Walk/Idle animation StateHandler

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/animation/controller/statehandler

Extends the walk example to switch to an idle animation when the entity isn't walking, using setAndContinue for both states.

```java
@Override

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {

    controllers.add(new AnimationController<>(test -> {

        if (test.isMoving())

            return test.setAndContinue(DefaultAnimations.WALK);



        return test.setAndContinue(DefaultAnimations.IDLE);

    }));

}

```

--------------------------------

### Item Class (Split Sources)

Source: https://wiki.geckolib.com/docs/geckolib5/armor/copy-paste-templates

ExampleArmorItem class with a public MutableObject geoRenderProvider field, intended for use with separate client setup classes. Includes commented line to enable triggered animations.

```java
public class ExampleArmorItem extends Item implements GeoItem {  

    public final MutableObject<Object> geoRenderProvider = new MutableObject<>();  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleArmorItem(ArmorMaterial material, ArmorType type, Properties properties) {  

        super(properties.humanoidArmor(material, type));  

  

        // Uncomment the below line to enable triggered animations  

        //GeoItem.registerSyncedAnimatable(this);  

    }  

  

    @Override  

    public void createGeoRenderer(Consumer consumer) {  

        consumer.accept(this.geoRenderProvider.getValue());  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Fabric client setup for GeoRenderProvider

Source: https://wiki.geckolib.com/docs/geckolib5/items/applying-the-item-renderer

Sets the geoRenderProvider field in the onInitializeClient method for Fabric, using a memoized supplier to create the GeoItemRenderer.

```java
@Override  

public void onInitializeClient() {  

    ItemRegistry.EXAMPLE_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  

        private final Supplier<GeoItemRenderer<ExampleItem>> renderer = Suppliers.memoize(() -> new GeoItemRenderer<>(ItemRegistry.EXAMPLE_ITEM));  

  

        @Override  

        public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

            return this.renderer.get();  

        }  

    });  

}  

```

--------------------------------

### Animation transition controller with triggerable animations

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/triggerable-animations

Registers an AnimationController that switches between sitting, walking, and idle states, and adds triggerable animations 'Sit' and 'Stand' to disguise transitions. The checkIsSitting() method is a placeholder for this example.

```java
@Override

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

    controllers.add(new AnimationController(animTest -> {  

        // This check is made up for this example, to simplify it  

        // Be in sitting pose if sitting  

        if (checkIsSitting())  

            return animTest.setAndContinue(MY_SITTING_ANIM);  

  

        // Walk or idle if not sitting  

        return animTest.isMoving() ? animTest.setAndContinue(DefaultAnimations.WALK) : animTest.setAndContinue(DefaultAnimations.IDLE);  

    }).triggerableAnim("Sit", SIT_DOWN_ANIM) // Triggerable anim to 'stand up'  

        .triggerableAnim("Stand", STAND_UP_ANIM)) // Triggerable anim to 'sit down'  

}  

```

--------------------------------

### Compound expression example with semicolon delimiter

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/animation/molang

Shows a compound Molang expression that sets a local variable and returns a value. The first part sets v.is_animating_walk to 1, and the last expression returns math.sin(query.anim_time).

```molang
v.is_animating_walk = 1;math.sin(query.anim_time)
```

--------------------------------

### BlockEntity Renderer registration (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Forge registration of a GeoBlockRenderer for the example block entity, using get().

```java
// Registering the renderer  

context -> new GeoBlockRenderer<>(context, BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY.get());  
```

--------------------------------

### Forge Client Setup: Set geoRenderProvider

Source: https://wiki.geckolib.com/docs/geckolib5/armor/applying-the-armor-renderer

In the Forge client setup, sets the geoRenderProvider on the item instance with a memoized GeoArmorRenderer.

```java
@SubscribeEvent  
public static void registerRenderers(final EntityRenderersEvent.RegisterRenderers event) {  
    ItemRegistry.EXAMPLE_ARMOR_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  
        private final Supplier<GeoArmorRenderer<ExampleItem, HumanoidRenderState>> renderer = Suppliers.memoize(() -> new GeoArmorRenderer<>(ItemRegistry.EXAMPLE_ARMOR_ITEM.get()));  

  

        @Override  
        public @Nullable GeoArmorRenderer<?, ?> getGeoArmorRenderer(ItemStack itemStack, EquipmentSlot equipmentSlot) {  
            return this.renderer.get();  
        }  
    });  
}  
```

--------------------------------

### BlockEntity Renderer registration (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Fabric registration of a GeoBlockRenderer for the example block entity.

```java
// Registering the renderer  

context -> new GeoBlockRenderer<>(context, BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY);  
```

--------------------------------

### Quick-Copy .mcmeta template for animated textures

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/animated-textures

Copy-paste this into a new .png.mcmeta file named after your texture (e.g., my_texture.png.mcmeta for my_texture.png). The animation section is empty by default; add width and height keys if your texture is not square.

```json
{
  "animation": {
  }
}
```

--------------------------------

### Create ExampleReplacedEntityRenderer extending GeoReplacedEntityRenderer

Source: https://wiki.geckolib.com/docs/geckolib5/entities/replaced-entities/creating-the-renderer

Step-by-step construction of a renderer class extending GeoReplacedEntityRenderer. First create the class, then add generic types (R extends CreeperRenderState & GeoRenderState, and the entity classes), then add a constructor passing the GeoModel and GeoReplacedEntity instance. The final constructor call uses new ExampleReplacedEntity() with a missing closing parenthesis in the source.

```java
public class ExampleReplacedEntityRenderer extends GeoReplacedEntityRenderer {  

}  
```

```java
public class ExampleReplacedEntityRenderer<R extends CreeperRenderState & GeoRenderState> extends GeoEntityRenderer<ExampleReplacedEntity, Creeper, R> {  

}  
```

```java
public class ExampleReplacedEntityRenderer<R extends CreeperRenderState & GeoRenderState> extends GeoEntityRenderer<ExampleReplacedEntity, Creeper, R> {  

    public ExampleReplacedEntityRenderer(EntityRendererProvider.Context context) {  
        super(context, new ExampleReplacedEntityGeoModel(), new ExampleReplacedEntity();  
    }  
}  
```

--------------------------------

### Provide GeoRenderProvider to Consumer

Source: https://wiki.geckolib.com/docs/geckolib5/armor/applying-the-armor-renderer

Second step: provide the Consumer with a new GeoRenderProvider instance. The provider is empty at this stage.

```java
public class ExampleArmorItem extends Item implements GeoItem {  

    // ...  

    @Override  
    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  
        consumer.accept(new GeoRenderProvider() {  

        });  
    }  
}  
```

--------------------------------

### Create a custom GeoItemRenderer class

Source: https://wiki.geckolib.com/docs/geckolib5/items/the-item-renderer

These steps build a custom renderer class that extends GeoItemRenderer. First create the class, then add the generic type (ExampleItem), and finally add a constructor that passes the item registry entry to super to automatically create the GeoModel.

```java
public class ExampleItemRenderer extends GeoItemRenderer {  

  

}  


```

```java
public class ExampleItemRenderer extends GeoItemRenderer<ExampleItem> {  

  

}  


```

```java
public class ExampleItemRenderer extends GeoItemRenderer<ExampleItem> {  

    public ExampleItemRenderer() {  

        super(ItemRegistry.EXAMPLE_ITEM);  

    }  

}  


```

--------------------------------

### Forge client setup for GeoRenderProvider

Source: https://wiki.geckolib.com/docs/geckolib5/items/applying-the-item-renderer

Sets the geoRenderProvider field in a registerRenderers event handler for Forge, using a memoized supplier to create the GeoItemRenderer.

```java
@SubscribeEvent  

public static void registerRenderers(final EntityRenderersEvent.RegisterRenderers event) {  

    ItemRegistry.EXAMPLE_ITEM.geoRenderProvider.setValue(new GeoRenderProvider() {  

        private final Supplier<GeoItemRenderer<ExampleItem>> renderer = Suppliers.memoize(() -> new GeoItemRenderer<>(ItemRegistry.EXAMPLE_ITEM.get()));  

  

        @Override  

        public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

            return this.renderer.get();  

        }  

    });  

}  

```

--------------------------------

### Add GeckoLib Maven repository (Groovy DSL)

Source: https://wiki.geckolib.com/docs/geckolib5/setup/neoforge/adding-the-repository

Add this inside the repositories block to use GeckoLib. The Maven URL is not browsable and will return a 404 if accessed directly.

```groovy
repositories {  

    exclusiveContent {  

        forRepository {  

            maven {  

                name = 'GeckoLib'  

                url = 'https://dl.cloudsmith.io/public/geckolib3/geckolib/maven/'  

            }  

        }  

        filter { includeGroupAndSubgroups('com.geckolib') }  

    }  

}  

```

--------------------------------

### Item Class (Combined Sources)

Source: https://wiki.geckolib.com/docs/geckolib5/armor/copy-paste-templates

Full ExampleArmorItem class implementing GeoItem with a GeoRenderProvider that supplies a GeoArmorRenderer. Includes commented line to enable triggered animations.

```java
public class ExampleArmorItem extends Item implements GeoItem {  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleArmorItem(ArmorMaterial material, ArmorType type, Properties properties) {  

        super(properties.humanoidArmor(material, type));  

  

        // Uncomment the below line to enable triggered animations  

        //GeoItem.registerSyncedAnimatable(this);  

    }  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

            private final Supplier<GeoArmorRenderer<ExampleArmorItem>> renderer = Suppliers.memoize(() -> new GeoArmorRenderer<>(ExampleArmorItem.this));  

  

            @Override  

            public @Nullable GeoArmorRenderer<?, ?> getGeoArmorRenderer(ItemStack itemStack, EquipmentSlot equipmentSlot) {  

                return this.renderer.get();  

            }  

        });  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Add AutoGlowingGeoLayer to EntityRenderer (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/glowmasks

Adds an AutoGlowingGeoLayer instance in the renderer constructor to enable emissive rendering. This example is for Forge, using ModEntities.EXAMPLE_ENTITY.get().

```java
public class ExampleEntityRenderer extends EntityRenderer<ExampleEntity> {  

    public ExampleEntityRenderer(EntityRendererFactory.Context context) {  

        super(context, ModEntities.EXAMPLE_ENTITY.get());  

  

        withRenderLayer(new AutoGlowingGeoLayer(this));  

    }  

}  
```

--------------------------------

### Add GeckoLib Maven repository (Kotlin DSL)

Source: https://wiki.geckolib.com/docs/geckolib5/setup/neoforge/adding-the-repository

Kotlin DSL version of the repository configuration. Use this in build.gradle.kts files. The Maven URL is not browsable and will return a 404 if accessed directly.

```kotlin
repositories {  

    exclusiveContent {  

        forRepository {  

            maven {  

                name = "GeckoLib"  

                url = uri("https://dl.cloudsmith.io/public/geckolib3/geckolib/maven/")  

            }  

        }  

        filter { includeGroupAndSubgroups("com.geckolib") }  

    }  

}  

```

--------------------------------

### Create custom armor renderer class

Source: https://wiki.geckolib.com/docs/geckolib5/armor/the-armor-renderer

Start of the advanced renderer class that extends GeoArmorRenderer. This is the first step in building a custom renderer.

```java
public class ExampleArmorRenderer extends GeoArmorRenderer {  

}  
```

--------------------------------

### ExampleBlockEntity class (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Fabric block entity class with GeckoLib animation cache and controller registration.

```java
public class ExampleBlockEntity extends BlockEntity {  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleBlockEntity(BlockPos pos, BlockState state) {  

        super(BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY, pos, state);  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Add AutoGlowingGeoLayer to EntityRenderer (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/glowmasks

Adds an AutoGlowingGeoLayer instance in the renderer constructor to enable emissive rendering. This example is for Fabric, using ModEntities.EXAMPLE_ENTITY without .get().

```java
public class ExampleEntityRenderer extends EntityRenderer<ExampleEntity> {  

    public ExampleEntityRenderer(EntityRendererFactory.Context context) {  

        super(context, ModEntities.EXAMPLE_ENTITY);  

  

        withRenderLayer(new AutoGlowingGeoLayer(this));  

    }  

}  
```

--------------------------------

### Use GeckoLib library from version catalog in build.gradle (Groovy)

Source: https://wiki.geckolib.com/docs/geckolib5/setup/neoforge/quick-reference

Adds the GeckoLib dependency using the version catalog reference.

```groovy
implementation libs.geckolib  
```

--------------------------------

### ExampleBlock class (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/copy-paste-templates

Fabric implementation of a block that implements EntityBlock, returning a block entity from the registry.

```java
public class ExampleBlock extends Block implements EntityBlock {  

    public ExampleBlock(BlockBehaviour.Properties properties) {  

        super(properties);  

    }  

  

    @Override  

    public @Nullable BlockEntity newBlockEntity(BlockPos pos, BlockState state) {  

        return BlockEntityRegistry.EXAMPLE_BLOCK_ENTITY.create(pos, state);  

    }  

}  
```

--------------------------------

### Add GeckoLib to libs.versions.toml

Source: https://wiki.geckolib.com/docs/geckolib5/setup/forge/adding-the-dependency

Add this line to the [libraries] section of your libs.versions.toml file. Change 26.1 to your intended Minecraft version.

```toml
geckolib = { group = "com.geckolib", name = "geckolib-forge-26.1", version.ref = "geckolib" }
```

--------------------------------

### Retrieve data from render state in adjustModelBonesForRender

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/rendering/renderstates

Override adjustModelBonesForRender to retrieve data stored in the render state using the RenderPassInfo. This example retrieves the IS_TAMED data ticket and uses it to adjust model bones.

```java
@Override

public void adjustModelBonesForRender(RenderPassInfo<R> renderPassInfo, BoneSnapshots snapshots) {

    final boolean isTamed = renderPassInfo.getGeckolibData(ModDataTickets.IS_TAMED);

    //...

}
```

--------------------------------

### Use GeckoLib library from version catalog in build.gradle (Kotlin)

Source: https://wiki.geckolib.com/docs/geckolib5/setup/neoforge/quick-reference

Adds the GeckoLib dependency using the version catalog reference.

```kotlin
implementation(libs.geckolib)  
```

--------------------------------

### Item Class (Split Sources)

Source: https://wiki.geckolib.com/docs/geckolib5/items/copy-paste-templates

Item class variant that stores the render provider in a MutableObject field, allowing the render provider to be set from a separate client setup class. Includes a commented line to enable triggered animations.

```java
public class ExampleItem extends Item implements GeoItem {  

    public final MutableObject<Object> geoRenderProvider = new MutableObject<>();  

    private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);  

  

    public ExampleItem(Properties properties) {  

        super(properties);  

  

        // Uncomment the below line to enable triggered animations  

        //GeoItem.registerSyncedAnimatable(this);  

    }  

  

    @Override  

    public void createGeoRenderer(Consumer consumer) {  

        consumer.accept(this.geoRenderProvider.getValue());  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

--------------------------------

### Blockstate JSON template

Source: https://wiki.geckolib.com/docs/geckolib5/blocks/the-block-asset-files

Create a JSON file in assets/<modid>/blockstates with the same name as your registered Block. Replace examplemod with your mod id and example_block with your block's registered id.

```json
{
  "variants": {
    "": {
      "model": "examplemod:block/example_block"
    }
  }
}
```

--------------------------------

### Register a sound keyframe handler with setSoundKeyframeHandler

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/keyframe-markers

Adds a KeyframeEventHandler to an AnimationController via setSoundKeyframeHandler to handle sound keyframe callbacks. The example plays a sound on the client player, using a helper method to avoid client-code in common classes.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

    controllers.add(new AnimationController<>(animTest -> PlayState.STOP)  

        .setSoundKeyframeHandler(state -> {  

            // Use helper method to avoid client-code in common class  

            Player player = ClientUtil.getClientPlayer();  

  

            if (player != null)  

                player.playSound(SoundRegistry.EXAMPLE_SOUND.get(), 1, 1);  

        }));  

}  

```

--------------------------------

### Define RenderState generic type in GeoEntityRenderer subclass

Source: https://wiki.geckolib.com/docs/geckolib5/updating/important/generic-types

When creating a new GeoEntityRenderer class in GeckoLib 5.0, you must explicitly define the RenderState generic type. The example shows a class extending GeoEntityRenderer with the generic type R bounded by LivingEntityRenderState and GeoRenderState.

```java
public class MyEntityRenderer<R extends LivingEntityRenderState & GeoRenderState> extends GeoEntityRenderer<MyEntity, R> {  

    // Note the generic type  ^  

}  
```

--------------------------------

### Create DefaultedEntityGeoModel

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geomodels/defaulted-geomodel

Creates a DefaultedEntityGeoModel using a namespace and path identifier. The identifier automatically generates asset paths under /assets/examplemod/geckolib/models/entity/animal/, /assets/examplemod/geckolib/animations/entity/animal/, and /assets/examplemod/textures/entity/animal/.

```java
new DefaultedEntityGeoModel(Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "animal/example_animal"));
```

--------------------------------

### Create automatic entity GeoModel with GeoEntityRenderer

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geomodels/automatic-geomodel

Pass a registered entity object to the GeoEntityRenderer constructor to automatically generate a DefaultedEntityGeoModel. Assets are looked up using the registry ID, e.g., examplemod:example_entity, with model at /assets/examplemod/geckolib/models/entity/example_entity.geo.json, animations at /assets/examplemod/geckolib/animations/entity/example_entity.animation.json, and texture at /assets/examplemod/textures/entity/example_entity.png.

```java
new GeoEntityRenderer(context, EntityRegistry.EXAMPLE_ENTITY);
```

--------------------------------

### Create GeoReplacedEntity class replacing vanilla CREEPER

Source: https://wiki.geckolib.com/docs/geckolib5/entities/replaced-entities/creating-the-entity-class

First step in making a GeckoLib replaced entity: create a class implementing GeoReplacedEntity. The example replaces the vanilla CREEPER entity, so replace it with the EntityType you are replacing. Subsequent snippets in this section add onto this class step by step.

```java
public class ReplacedCreeperEntity implements GeoReplacedEntity {
    private AnimatableInstanceCache cache = GeckoLibUtil.createInstanceCache(this);

    @Override
    public EntityType<?> getReplacingEntityType() {
        return EntityType.CREEPER;
    }

    @Override
    public AnimatableInstanceCache getAnimatableInstanceCache() {
        return this.cache;
    }

    @Override
    public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {
        controllers.add(new AnimationController<>(this, 
```

--------------------------------

### Create DefaultedItemGeoModel

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geomodels/defaulted-geomodel

Creates a DefaultedItemGeoModel using a namespace and path identifier. The identifier automatically generates asset paths under /assets/examplemod/geckolib/models/item/, /assets/examplemod/geckolib/animations/item/, and /assets/examplemod/textures/item/.

```java
new DefaultedItemGeoModel(Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "example_item"));
```

--------------------------------

### Basic GeoModel class with cached resource paths

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geomodels/basic-geomodel

Extends GeoModel and implements the three required methods: getModelResource, getAnimationResource, and getTextureResource. Caches Identifier paths for model, animation, and texture files to avoid re-creation. The model and animation paths are relative to the 'models' and 'animations' folders respectively, while the texture path starts with 'textures'.

```java
public class ExampleGeoModel extends GeoModel<ExampleEntity> {  

    // Looks for a model file at '/assets/examplemod/geckolib/models/example_entity.geo.json'  

    private final Identifier modelPath = Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "example_entity");  

    // Looks for an animations file at '/assets/examplemod/geckolib/animations/example_entity.animation.json'  

    private final Identifier animationsPath = Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "example_entity");  

    // Looks for a texture file at '/assets/examplemod/textures/example_entity.png'  

    private final Identifier texturePath = Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "textures/example_entity.png");  

  

    @Override  

    public Identifier getModelResource(GeoRenderState renderState) {  

        return this.modelPath;  

    }  

  

    @Override  

    public Identifier getAnimationResource(ExampleEntity animatable) {  

        return this.animationsPath;  

    }  

  

    @Override  

    public Identifier getTextureResource(GeoRenderState renderState) {  

        return this.texturePath;  

    }  

}  
```

--------------------------------

### Add geckolib to libs.versions.toml [versions] section

Source: https://wiki.geckolib.com/docs/geckolib5/setup/fabric/setting-the-version

Add this line in the [versions] section of your libs.versions.toml file, replacing the placeholder with your GeckoLib version number.

```toml
geckolib =  
```

--------------------------------

### Entity Renderer Registration (Forge)

Source: https://wiki.geckolib.com/docs/geckolib5/entities/copy-paste-templates

Registers the entity renderer for Forge. Uses EntityRegistry.EXAMPLE_ENTITY.get() to obtain the entity type.

```java
// Registering the renderer  

context -> new GeoEntityRenderer<>(context, EntityRegistry.EXAMPLE_ENTITY.get());  
```

--------------------------------

### Entity Renderer Registration (Fabric)

Source: https://wiki.geckolib.com/docs/geckolib5/entities/copy-paste-templates

Registers the entity renderer for Fabric. Uses EntityRegistry.EXAMPLE_ENTITY directly.

```java
// Registering the renderer  

context -> new GeoEntityRenderer<>(context, EntityRegistry.EXAMPLE_ENTITY);  
```

--------------------------------

### Make a controller additive with additiveAnimations()

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/animation/controller/ordering

Registers a walk/idle controller and an attack controller that is additive, so the attack animation adds its values to the existing animation instead of overwriting.

```java
@Override

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {

    controllers.add(

            DefaultAnimations.genericWalkIdleController(),

            DefaultAnimations.genericAttackController(this).additiveAnimations());

}

```

--------------------------------

### Create automatic item GeoModel with GeoItemRenderer

Source: https://wiki.geckolib.com/docs/geckolib5/concepts/geomodels/automatic-geomodel

Pass a registered item object to the GeoItemRenderer constructor to automatically generate a DefaultedItemGeoModel. Assets are looked up using the registry ID, e.g., examplemod:example_item, with model at /assets/examplemod/geckolib/models/item/example_item.geo.json, animations at /assets/examplemod/geckolib/animations/item/example_item.animation.json, and texture at /assets/examplemod/textures/item/example_item.png.

```java
new GeoItemRenderer(context, ItemRegistry.EXAMPLE_ITEM);
```

--------------------------------

### Implement StatelessGeoEntity in a custom entity class

Source: https://wiki.geckolib.com/docs/geckolib5/miscellaneous/stateless-animations

Shows the minimal implementation of the StatelessGeoEntity interface on a PathfinderMob subclass. This is the required first step to use stateless animations.

```java
public class ExampleEntity extends PathfinderMob implements StatelessGeoEntity {  

    //...  

}  
```
Tokens:
Raw