Skip to content

How To Create and Use a Custom Item Model

1.0.0 1.20.4 base mc mappings

Step 1: Create the 3D Model

You can Create the model, and it's subsequently needed texture and animations using Blockbench and the AzureLib plugin installed on it. There are many great Tutorials on this all over YouTube so i won't waste time by explaining this part in depth.

Warning

The AzureLib Plugin needs to be installed on Blockbench as it allow you to export to the proper format

Step 2: Create The needed Classes

Model

Note

The Model i am talking about here is not the same as The actual 3D Model, it's the Java Class used for finding the files for rendering

To Create the needed Model File you simply need to create a Class and extend the GeoModel Class, like so:

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class ExampleItemModel extends GeoModel {
// Models must be stored in assets/<modid>/geo with subfolders supported inside the geo folder
    private static final ResourceLocation model = new ResourceLocation("yournamespace", "geo/yourmodel.geo.json");
// Textures must be stored in assets/<modid>/textures with subfolders supported inside the textures folder
    private static final ResourceLocation texture = new ResourceLocation("yournamespace", "textures/<modeltype>/yourtexture.png");
// Animations must be stored in assets/<modid>/animations with subfolders supported inside the animations folder
    private static final ResourceLocation animation = new ResourceLocation("yournamespace", "animations/youranimation.animation.json");

    @Override
    public ResourceLocation getModelResource(GeoAnimatable animatable) {
        return this.model;
    }

    @Override
    public ResourceLocation getTextureResource(GeoAnimatable animatable) {
        return this.texture;
    }

    @Override
    public ResourceLocation getAnimationResource(GeoAnimatable animatable) {
        return this.animation;
    }
}

Item

Creating the Item Class is also a straight forward act as you need to extend the AzureItem Class and implement it's abstract methods, Like so:

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
public class ExampleItem extends AzureItem {

        public ExampleItem(Properties properties) {
            super(properties);
        }

        @Override
        public ICallBack getControllers() {
            return null;
        }

        @Override
        public Supplier<GeoModel<? extends AzureItem>> getModel() {
            return null;
        }
}

When implementing this you will notice that you have to create 2 extra function getControllers and getModel.

ICallBack getControllers()

1.0.0 1.20.4 This is a Required Function for Item's

This function return's a CallBack containing a List of animation Controllers for AzureLib to use

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
@Override
public ICallBack getControllers() {
List<AnimationController> controllerList = new ArrayList<>();

    //Creating the Animation controller
    controllerList.add(new AnimationController(this, "idleController", 0, event -> {
    return event.setAndContinue(RawAnimation.begin().thenLoop("idle"));
    }));

    //Returning the CallBack
    return (args)->controllerList;
}

Supplier<GeoModel<? extends AzureItem>> getModel()

1.0.0 1.20.4 This is a Required Function for Item's

This function return's a Supplier which creates a new instance of the Model that should be used for rendering this Item

Example 
1
2
3
4
@Override
public Supplier<GeoModel<? extends AzureItem>> getModel() {
    return ()->new ExampleItemModel();
}