Default item/block models

[hohserg1]

Summary

Require only textures to have models of item/block

Goals

• Simplify development of item/block regular texture-based models
  • Reduce amount of boilerplate json
  • Reduce mistake probability by reducing necessary parts

Non Goals

• Replace json/baked models system

Motivation

I hate json modding, want to minimize hand writing of json

Description

Most frequently used case of item model in mods is just a regular item model based on texture generated by ItemLayerModel.getQuadsForSprite.
However, you need to always put a few files in special locations:
/assets/modid/models/item/registry_name.json
/assets/modid/textures/items/registry_name.png
But only the second is providing a visual sense of the item.
First file is always boilerplate like:

{
    "parent": "minecraft:item/generated",
    "textures": {
        "layer0": "modid:items/registry_name"
    }
}

It would be nice if you only had to provide the texture.
To solve it, I frequently use code like follow:

public static ModelResourceLocation getModelLocation(Item item) {
    return new ModelResourceLocation(item.getRegistryName(), "inventory");
}

public static String getSpriteName(Item item) {
    return "modid:items/"+item.getRegistryName().getPath();
}

@SubscribeEvent
public static void registerModels(ModelRegistryEvent event) {
    for(Item item: ALL_MY_ITEMS) {
        ModelLoader.setCustomModelResourceLocation(item, 0, getModelLocation(item));
    }
}

@SubscribeEvent
public static void registerSprites(TextureStitchEvent.Pre event) {
    for(Item item: ALL_MY_ITEMS) {
        event.getMap().registerSprite(new ResourceLocation(getSpriteName(item)));
    }    
}

@SubscribeEvent
public static void replaceModels(ModelBakeEvent event) {
    for(Item item: ALL_MY_ITEMS) {
        setModelIfMissed(event, getModelLocation(item), new TextureBasedItemModel(item));
    }
}

    private static void setModelIfMissed(ModelBakeEvent event, ModelResourceLocation mrl, IBakedModel model) {
        if (isMissingModel(event, mrl)) {
            event.getModelRegistry().putObject(mrl, model);
        }
    }

    private static boolean isMissingModel(ModelBakeEvent event, ModelResourceLocation mrl) {
        IBakedModel existedModel = event.getModelRegistry().getObject(mrl);
        return existedModel == null ||
            existedModel == event.getModelManager().getMissingModel() ||
            existedModel.getClass().getName().equals("net.minecraftforge.client.model.FancyMissingModel$BakedModel");
    }


public class TextureBasedItemModel implements IBakedModel {
    private final List<BakedQuad> quads;
    TextureBasedItemModel(Item item){
        TextureAtlasSprite sprite = Minecraft.getMinecraft().getTextureMapBlocks().getAtlasSprite(getSpriteName(item));
        quads = ItemLayerModel.getQuadsForSprite(1, sprite, DefaultVertexFormats.ITEM, Optional.empty());
    }
    @Override
    public List<BakedQuad> getQuads(@Nullable IBlockState state, @Nullable EnumFacing side, long rand) {
        return quads;
    }
}

And this feels really good.
This example is simplified, but can be extended to support blocks/fluids/metadata.
Also the user can still provide regular json model or coded model if its need to override default model.
Kinda such commonly used default behavior should be in the framework but not in the user space.

Dependencies

No response

References

No response

Guidelines

• I have and will continue to adhere to the guidelines