GeckoLib

https://wiki.geckolib.com
Admin
GeckoLib is a comprehensive animation and rendering library for Minecraft Java mods that enables...
Tokens:24,497
Snippets:375
Trust Score:6.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create the base entity class

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

Initial setup for a custom entity class extending PathfinderMob.

```java
public class ExampleEntity extends PathfinderMob {  

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

        super(entityType, level);  

    }  

}  
```

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

### Create base item class

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

Initial setup for a custom item class extending the base Item class.

```java
public class ExampleItem extends Item {  

    public ExampleItem(Properties properties) {  

        super(properties);  

    }  

}  
```

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

### Armor Renderer Implementation

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

Examples for simple renderer application and advanced custom renderer class extension.

```java
// Applying the renderer  

() -> new GeoArmorRenderer<>(ExampleArmorItem.this);  
```

```java
public class ExampleArmorRenderer<R extends HumanoidRenderState & GeoRenderState> extends GeoArmorRenderer<ExampleArmorItem, R> {  

    public ExampleArmorRenderer(Item item) {  

        super(item);  

    }  

}  
```

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

### Client Setup for Fabric

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

Initializes the GeoRenderProvider during the Fabric client initialization phase.

```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();  

        }  

    });  

}  
```

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

### Client Setup for Forge and NeoForge

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

Registers the GeoRenderProvider using the RegisterRenderers event.

```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<>(ExampleItem.this));  

  

        @Override  

        public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

            return this.renderer.get();  

        }  

    });  

}  
```

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

### Create Base Armor Item Class

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

Initial setup for the armor item class extending the base Item class.

```java
public class ExampleArmorItem extends Item {  

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

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

    }  

}  
```

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

### Handle Stateless Animations in Tick

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

Example of triggering animations based on entity movement within the tick method.

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

    //...  

  

    @Override  

    public void tick() {  

        super.tick();  

  

        // Preference the client side unless you need the server side for some reason. The code is the same either way.  

        if (level().isClientSide()) {  

            // Just play the living animation all the time  

            playAnimation(DefaultAnimations.LIVING);  

  

            if (getDeltaMovement().horizontalDistanceSqr() > 0.01) {  

                // Play the walking animation if we're moving, and stop the idle animation  

                playAnimation(DefaultAnimations.WALK);  

                stopAnimation(DefaultAnimations.IDLE);  

            }  

            else {  

                // Play the idle animation if we're not moving, and stop the walking animation  

                playAnimation(DefaultAnimations.IDLE);  

                stopAnimation(DefaultAnimations.WALK);  

            }  

        }  

    }  

}
```

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

### Register GeoRenderProvider in Client Setup

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

Set the geoRenderProvider value during client initialization or renderer registration events.

```java
@Override  

public void onInitializeClient() {  

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

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

  

        @Override  

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

            return this.renderer.get();  

        }  

    });  

}  
```

```java
@SubscribeEvent  

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

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

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

  

        @Override  

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

            return this.renderer.get();  

        }  

    });  

}  
```

```java
@SubscribeEvent  

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

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

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

  

        @Override  

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

            return this.renderer.get();  

        }  

    });  

}  
```

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

### Defining a custom GeoEntityRenderer with RenderState

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

Example of extending GeoEntityRenderer while explicitly defining the required RenderState generic type.

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

    // Note the generic type  ^  

}  
```

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

### Basic .mcmeta file structure

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

Template for creating an animated texture configuration file. Save this as [texture_name].png.mcmeta in the same directory as your texture.

```json
{

  "animation": {

  

  }

}
```

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

### Implementing Animation Transitions with Triggerable Animations

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

Demonstrates using triggerable animations to disguise transitions between primary animation states like walking and sitting.

```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'  

}  
```

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

### Implement Library from Version Catalog

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

Use the defined library in your build.gradle dependencies block.

```groovy
modImplementation libs.geckolib  
```

```kotlin
modImplementation(libs.geckolib)  
```

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

### Apply Simple Armor Renderer

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

Use this approach when no custom rendering logic is required.

```java
// Applying the renderer  

() -> new GeoArmorRenderer<>(ExampleArmorItem.this);  
```

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

### Create a repositories block

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

Use this structure if a repositories block does not already exist in your build.gradle file.

```groovy
repositories {  

  

}  
```

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

### Create the base block class

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

Define the initial block class structure with a standard constructor.

```java
public class ExampleBlock extends Block {  

    public ExampleBlock(BlockBehaviour.Properties properties) {  

        super(properties);  

    }  

}  
```

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

### Implement Library Dependency

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

Use the defined library in your build.gradle file.

```groovy
implementation libs.geckolib  
```

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

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

### Molang Queries for Animation

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

Retrieving in-game values using queries to drive animation behavior.

```molang
math.cos(query.anim_time)
```

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

### Register Simple Renderer

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

Use these snippets to register a basic renderer without custom handling for different modloaders.

```java
// Registering the renderer  

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

```java
// Registering the renderer  

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

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

### Registering a walking animation controller

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

Uses setAndContinue to play a walk animation while the entity is moving, otherwise stops the animation.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

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

        if (test.isMoving())  

            return test.setAndContinue(DefaultAnimations.WALK);  

  

        return PlayState.STOP;  

    }));  

}  
```

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

### Add Interface Injections (Version Catalog)

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

Optional configuration for ModDevGradle users using the version catalog.

```groovy
interfaceInjectionData libs.geckolib
```

```kotlin
interfaceInjectionData(libs.geckolib)
```

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

### Define the Item Display JSON

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

Place this file in assets/<modid>/models/item/ using the item's registered ID as the filename.

```json
{

  "parent": "builtin/entity",

  "textures": {

    "particle": "<modid>:item/<item_id>"

  }

}
```

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

### Add Constructor for Forge/NeoForge

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

Constructor implementation for Forge and NeoForge platforms.

```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) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  



```

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

### Define Library in libs.versions.toml

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

Define the library in the [libraries] section of your version catalog file.

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

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

### Add GeckoLib maven repository

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

Add the GeckoLib maven repository to your build.gradle file using either Groovy or Kotlin DSL.

```groovy
repositories {  

    exclusiveContent {  

        forRepository {  

            maven {  

                name = 'GeckoLib'  

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

            }  

        }  

        filter { includeGroupAndSubgroups('com.geckolib') }  

    }  

}  
```

```kotlin
repositories {  

    exclusiveContent {  

        forRepository {  

            maven {  

                name = "GeckoLib"  

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

            }  

        }  

        filter { includeGroupAndSubgroups("com.geckolib") }  

    }  

}  
```

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

### Create Advanced Renderer Class

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

Step-by-step implementation of a custom renderer class extending GeoItemRenderer.

```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);  

    }  

}
```

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

### Define GeckoLib Version

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

Set the GeckoLib version in your project configuration files.

```properties
geckolibVersion=  
```

```toml
geckolib =  
```

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

### Registering a spawning animation controller

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

Plays a specific animation during the entity's initial spawn period based on tickCount.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

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

        if (MyEntity.this.tickCount <= 100)  

            return test.setAndContinue(MY_SPAWN_ANIMATION);  

  

        return PlayState.STOP;  

    }));  

}  
```

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

### Registering Controllers with Priority

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

Registers a walk/idle controller before an attack controller to ensure the attack animation takes priority over arm movements.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

    controllers.add(  

            DefaultAnimations.genericWalkIdleController(),  

            DefaultAnimations.genericAttackController(this));  

}  
```

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

### Create Advanced Armor Renderer Class

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

Step-by-step implementation of a custom armor renderer class extending GeoArmorRenderer.

```java
public class ExampleArmorRenderer extends GeoArmorRenderer {  

  

}
```

```java
public class ExampleArmorRenderer<R extends HumanoidRenderState & GeoRenderState> extends GeoArmorRenderer<ExampleArmorItem, R> {  

  

}
```

```java
public class ExampleArmorRenderer<R extends HumanoidRenderState & GeoRenderState> extends GeoArmorRenderer<ExampleArmorItem, R> {  

    public ExampleArmorRenderer(Item item) {  

        super(item);  

    }  

}
```

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

### Implement the constructor

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

Add the constructor to pass the asset identifier to the superclass.

```java
public class ExampleReplacedEntityGeoModel extends DefaultedEntityGeoModel<ExampleReplacedEntity> {  

    public ExampleReplacedEntityGeoModel() {  

        super(Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "example_replaced_entity"));  

    }  

}  
```

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

### Define the Item JSON

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

Place this file in assets/<modid>/items/ using the item's registered ID as the filename.

```json
{

  "model": {

    "type": "minecraft:special",

    "base": "<modid>:item/<item_id>",

    "model": {

      "type": "geckolib:geckolib"

    }

  }

}
```

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

### Implement GeoItem Armor Class

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

Templates for creating an armor item class that implements GeoItem, showing both combined and split source patterns.

```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;  

    }  

}  
```

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

    public final MutableObject<GeoRenderProvider> 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<GeoRenderProvider> consumer) {  

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

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

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

### Create Base BlockEntity Class

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

Initial definition of the BlockEntity class.

```java

public class ExampleBlockEntity extends BlockEntity {  

  

}  



```

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

### Create a DataTicket with generics

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

Define a static DataTicket instance for complex types using a TypeToken.

```java
public static final DataTicket<EnumMap<Direction>> EXAMPLE_DIRECTIONS_TICKET = DataTicket.create("example_directions", EnumMap.class, new TypeToken<>() {});
```

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

### Implement GeoEntity Class

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

Standard implementation of a PathfinderMob using the GeoEntity interface.

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

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

  

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

        super(entityType, level);  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

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

### Add Interface Injections (Direct)

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

Optional configuration for ModDevGradle users to add interface injection data.

```groovy
interfaceInjectionData "com.geckolib:geckolib-neoforge-${minecraftVersion}:${geckolibVersion}"
```

```kotlin
interfaceInjectionData("com.geckolib:geckolib-neoforge-${minecraftVersion}:${geckolibVersion}")
```

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

### Implement GeoItem with Combined Sources

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

Uses a memoized supplier within the item class to handle the GeoItemRenderer directly.

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

    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<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

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

  

            @Override  

            public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

                return this.renderer.get();  

            }  

        });  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

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

### Interface Injection Library

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

Use the library reference for interface injection in your build.gradle file.

```groovy
interfaceInjectionData libs.geckolib  
```

```kotlin
interfaceInjectionData(libs.geckolib)  
```

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

### Implement GeoEntity interface

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

Add the GeoEntity interface and override required animation methods.

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

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

        super(entityType, level);  

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return null;  

    }  

}  
```

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

### Implementing GeoItemRenderer

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

A step-by-step implementation of the createGeoRenderer method to provide a cached GeoItemRenderer instance.

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

  

    }  

}  
```

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

  

        });  

    }  

}  
```

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

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

  

  

        });  

    }  

}  
```

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

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

  

            @Override  

            public @Nullable GeoItemRenderer<ExampleItem> getGeoItemRenderer() {  

                return this.renderer.get();  

            }  

        });  

    }  

}  
```

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

### Registering an Additive Controller

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

Configures a controller to act additively by calling the additiveAnimations method, allowing its transformations to be added to existing values.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

    controllers.add(  

            DefaultAnimations.genericWalkIdleController(),  

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

}  
```

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

### Define Library in Version Catalog

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

Define the GeckoLib library in your libs.versions.toml file.

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

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

### Apply Simple GeoItemRenderer

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

Use this approach when no custom rendering logic is required for the item.

```java
// Applying the renderer  

() -> new GeoItemRenderer<>(ExampleItem.this);  
```

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

### Register a Sound Keyframe Handler

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

Manually handle sound playback by registering a custom KeyframeEventHandler to an AnimationController.

```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);  

        }));  

}  
```

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

### Implementing GeoItem Renderer Registration

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

A step-by-step implementation of the createGeoRenderer method to provide a cached GeoArmorRenderer instance.

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

  

    }  

}  
```

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

  

        });  

    }  

}  
```

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

  

    // ...  

  

    @Override  

    public void createGeoRenderer(Consumer<GeoRenderProvider> consumer) {  

        consumer.accept(new GeoRenderProvider() {  

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

  

  

        });  

    }  

}  
```

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

  

    // ...  

  

    @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();  

            }  

        });  

    }  

}  
```

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

### Implement GeoItem with Split Sources

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

Uses a MutableObject to hold the GeoRenderProvider, allowing for external initialization.

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

    public final MutableObject<GeoRenderProvider> 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<GeoRenderProvider> consumer) {  

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

    }  

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

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

### Blockstate JSON Configuration

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

Standard blockstate JSON file for a GeckoLib block.

```json
{

    "variants": {

        "": {

            "model": "examplemod:block/example_block"

        }

    }

}  
```

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

### Add Constructor for Fabric

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

Constructor implementation for the Fabric platform.

```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) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  



```

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

### Register an AutoPlayingSoundKeyframeHandler

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

Use the built-in handler to automatically play sounds defined in animation JSON files without manual boilerplate.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

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

        .setSoundKeyframeHandler(new AutoPlayingSoundKeyframeHandler()));  

}  
```

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

### Define a Block Model JSON

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

Create this file in the assets/<modid>/models/block folder to define the block's textures.

```json
{

  "textures": {

    "particle": "examplemod:block/example_block"

  }

}
```

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

### Implement a basic GeoModel class

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

Extends the GeoModel class to define custom resource paths for models, animations, and textures. Caches Identifiers as class fields to avoid constant re-creation.

```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, "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;  

    }  

}  
```

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

### Define a BlockState JSON

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

Create this file in the assets/<modid>/blockstates folder to map the block to its model.

```json
{

  "variants": {

    "": {

      "model": "examplemod:block/example_block"

    }

  }

}
```

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

### Implement Block Class

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

Standard implementation of a block class that implements EntityBlock for GeckoLib integration.

```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);  

    }  

}  
```

```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);  

    }  

}  
```

```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);  

    }  

}  
```

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

### Basic Molang Mathematical Expressions

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

Simple arithmetic expressions used to define animation keyframe values.

```molang
5 * 4
```

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

### Initialize AnimatableInstanceCache

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

Adding the cache field and returning it within the getAnimatableInstanceCache method.

```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;  

    }  

}  
```

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

### Add Version Catalog Dependency in build.gradle

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

Reference the defined library in your build.gradle dependencies block.

```groovy
modImplementation libs.geckolib
```

```kotlin
modImplementation(libs.geckolib)
```

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

### Registering a walk or idle animation controller

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

Switches between walking and idle animations based on the entity's movement state.

```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);  

    }));  

}  
```

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

### Create a DataTicket without generics

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

Define a static DataTicket instance for non-generic data types.

```java
public static final DataTicket<Boolean> EXAMPLE_BOOLEAN_TICKET = DataTicket.create("example_boolean", Boolean.class);
```

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

### Set GeckoLib version in libs.versions.toml

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

Add the geckolib version entry to the [versions] section of your version catalog file.

```toml
geckolib =  
```

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

### Define Advanced Renderer Class

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

Step-by-step implementation of a custom renderer class extending GeoEntityRenderer.

```java
public class ExampleEntityRenderer extends GeoEntityRenderer {  

  

}  
```

```java
public class ExampleEntityRenderer<R extends EntityRenderState & GeoRenderState> extends GeoEntityRenderer<ExampleEntity, R> {  

  

}  
```

```java
public class ExampleEntityRenderer<R extends EntityRenderState & GeoRenderState> extends GeoEntityRenderer<ExampleEntity, R> {  

    public ExampleEntityRenderer(EntityRendererProvider.Context context, EntityType<ExampleEntity> entityType) {  

        super(context, entityType);  

    }  

}  
```

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

### Define the Renderer Class

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

Initial class definition extending GeoReplacedEntityRenderer.

```java
public class ExampleReplacedEntityRenderer extends GeoReplacedEntityRenderer {  

  

}  
```

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

### Block Model JSON Configuration

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

Standard block model JSON file for a GeckoLib block.

```json
{

    "textures": {

        "particle": "examplemod:block/example_block"

    }

}  
```

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

### Implement Advanced BlockEntity Renderer

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

Implementation for an advanced block entity renderer extending GeoBlockRenderer.

```java
public class ExampleBlockRenderer<R extends BlockEntityRenderState & GeoRenderState> extends GeoBlockRenderer<ExampleBlockEntity, R> {  

    public ExampleBlockRenderer(BlockEntityType<ExampleBlockEntity> blockEntityType) {  

        super(blockEntityType);  

    }  

}  
```

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

### Implement Advanced GeoItemRenderer

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

Implement a custom renderer class for Fabric, Forge, or NeoForge. Note the difference in registry access between loaders.

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

    public ExampleItemRenderer() {  

        super(ItemRegistry.EXAMPLE_ITEM);  

    }  

}
```

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

    public ExampleItemRenderer() {  

        super(ItemRegistry.EXAMPLE_ITEM.get());  

    }  

}
```

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

### Implement GeoItem Interface

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

Adding the GeoItem interface and required override methods to the armor class.

```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;  

    }  

}  
```

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

### Register Entity Renderer

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

Boilerplate for registering a GeoEntityRenderer, varying by platform registry access.

```java
// Registering the renderer  

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

```java
// Registering the renderer  

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

```java
// Registering the renderer  

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

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

### Adding a BonePositionListener

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

Registers a listener to a RenderPassInfo instance to receive world, model, and local position updates for a specific bone.

```java
renderPassInfo.addBonePositionListener("MyBoneName", (worldPos, modelPos, localPos) -> {  

    //...  

});  
```

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

### Registering an attacking animation controller

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

Triggers an attack animation based on the entity's swinging state.

```java
@Override  

public void registerControllers(AnimatableManager.ControllerRegistrar controllers) {  

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

        if (MyEntity.this.swinging)  

            return test.setAndContinue(DefaultAnimations.ATTACK_SWING);  

  

        return PlayState.STOP;  

    }));  

}  
```

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

### Implement GeoReplacedEntity Class

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

Basic implementation of the GeoReplacedEntity interface required for custom entity animation.

```java
public class ExampleReplacedEntity implements GeoReplacedEntity {  

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

  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return this.geoCache;  

    }  

}  
```

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

### Legacy GeoModel Asset Path Definition

Source: https://wiki.geckolib.com/docs/geckolib5/updating/noteworthy/geomodel-asset-paths

The traditional approach required specifying the full path including prefixes and file extensions.

```java
@Override  

public ResourceLocation getModelResource(GeoRenderState renderState) {  

    return ResourceLocation.fromNamespaceAndPath(ExampleMod.MOD_ID, "geckolib/animations/my_model.geo.json");  

}  
```

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

### Molang Mathematical Functions

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

Using built-in mathematical functions like cosine to calculate animation values.

```molang
math.cos(5)
```

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

### Client-Side Renderer Registration

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

Boilerplate for registering armor renderers on the client side for different mod loaders.

```java
@Override  

public void onInitializeClient() {  

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

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

  

        @Override  

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

            return this.renderer.get();  

        }  

    });  

}  
```

```java
@SubscribeEvent  

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

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

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

  

        @Override  

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

            return this.renderer.get();  

        }  

    });  

}  
```

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

### Set GeckoLib version in gradle.properties

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

Add the geckolibVersion property to your gradle.properties file in the project root.

```properties
geckolibVersion=  
```

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

### Apply Simple GeoItemRenderer

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

Use this lambda expression to register a simple item renderer.

```java
() -> new GeoItemRenderer<>(ExampleItem.this);
```

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

### Implement GeoBlockEntity Interface

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

Add the GeoBlockEntity interface and required method overrides.

```java

public class ExampleBlockEntity extends BlockEntity implements GeoBlockEntity {  

    @Override  

    public void registerControllers(final AnimatableManager.ControllerRegistrar controllers) {  

        // We can fill this in later  

    }  

  

    @Override  

    public AnimatableInstanceCache getAnimatableInstanceCache() {  

        return null;  

    }  

}  



```

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

### Implement BlockEntity Class

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

Standard implementation of a BlockEntity class using AnimatableInstanceCache.

```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;  

    }  

}  
```

```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;  

    }  

}  
```

```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;  

    }  

}  
```

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

### DefaultedItemGeoModel Usage

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

Instantiate a DefaultedItemGeoModel using a mod ID and item path.

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