[1.21.3] Expose vanilla model generators for modded usages #1696

ApexModder · 2024-11-22T00:37:55Z

This PR allows modders to make use of the vanilla model generators and all the helpers/utilities that come with them.
This is done by adding methods which modders must override in each of the main data providers, failing to override these methods will result in vanilla models being generated.

Various ResourceLocation.withDefaultNamespace calls have also been patched to now call ResourceLocation.parse, this is to support passing in paths with modded namespaces.

With 1.21.4 and all of its model changes, this is intended as a stepping point towards using the vanilla generators. Rather than having to patch and potentially rewrite ours to support all these changes.

TODO

Add ExistingFileHelper support, validate referenced textures and parent models exist
Expand ModelBuilder to pass its output to ItemModelOutput, allowing modders to build custom models
Support our RenderType and face data extensions when using template models
- Unsure if mutating face data is possible using model templates
Generate texture animation mcmeta files?
Validate that added ATs are still needed after recent changes.

_{Original conversation can be found in NeoCord}

…rovider

Expose everything from ItemModelGenerators and BlockModelGenerators

Support modded paths in ModelTemplate.create

…utput

neoforged-pr-publishing · 2024-11-22T00:38:09Z

Publish PR to GitHub Packages

Last commit published: 7f75f6c00501a40a6b4ce62e6b8aab83884d98f6.

PR Publishing

The artifacts published by this PR:

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1696' // https://github.com/neoforged/NeoForge/pull/1696
        url 'https://prmaven.neoforged.net/NeoForge/pr1696'
        content {
            includeModule('net.neoforged', 'testframework')
            includeModule('net.neoforged', 'neoforge')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1696.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1696
cd NeoForge-pr1696
curl -L https://prmaven.neoforged.net/NeoForge/pr1696/net/neoforged/neoforge/21.3.62-beta-pr-1696-pr-vanilla-data-gen/mdk-pr1696.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

…ilders rather then ResLoc

Allow setting render types for model templates

Allow setting custom data from TexturedModel

Allow specifying render typed by strings (defaulting to "minecraft" namespace) Add mod and minecraft model path helpers Fix block models generating empty content

XFactHD · 2024-11-23T21:31:26Z

patches/net/minecraft/data/models/model/ModelTemplate.java.patch

         JsonObject jsonobject = new JsonObject();
-         this.model.ifPresent(p_176461_ -> jsonobject.addProperty("parent", p_176461_.toString()));
+-        this.model.ifPresent(p_176461_ -> jsonobject.addProperty("parent", p_176461_.toString()));


Instead of modifying the two lambdas, I would do the two checks at the top of the method:

if (fileHelper != null) { this.model.ifPresent(parent -> Preconditions.checkState(fileHelper.exists(parent, ModelProvider.MODEL), "Model at %s does not exist", parent)); p_266912_.forEach((slot, name) -> Preconditions.checkState(fileHelper.exists(name, ModelProvider.TEXTURE), "Texture %s does not exist in any known resource pack", name)); }

XFactHD · 2024-11-23T21:39:21Z

src/main/java/net/neoforged/neoforge/common/extensions/IBlockModelGenerators.java

+        // ExistingFileHelper is nullable for backwards compat with vanilla data gen
+        // should never/rarely ever be null in modded data gen
+        var fileHelper = Objects.requireNonNull(self().fileHelper, "Looking up models requires a nonnull ExistingFileHelper");
+        return new ModelFile.ExistingModelFile(modelPath.withPath(IBlockModelGenerators::appendBlockFolder), fileHelper);


Suggested change

return new ModelFile.ExistingModelFile(modelPath.withPath(IBlockModelGenerators::appendBlockFolder), fileHelper);

ModelFile model = new ModelFile.ExistingModelFile(modelPath.withPath(IBlockModelGenerators::appendBlockFolder), fileHelper);

model.assertExistence();

return model;

XFactHD · 2024-11-23T21:41:23Z

src/main/java/net/neoforged/neoforge/common/extensions/IItemModelGenerators.java

+        // ExistingFileHelper is nullable for backwards compat with vanilla data gen
+        // should never/rarely ever be null in modded data gen
+        var fileHelper = Objects.requireNonNull(self().fileHelper, "Looking up models requires a nonnull ExistingFileHelper");
+        return new ModelFile.ExistingModelFile(modelPath.withPath(IItemModelGenerators::appendItemFolder), fileHelper);


Suggested change

return new ModelFile.ExistingModelFile(modelPath.withPath(IItemModelGenerators::appendItemFolder), fileHelper);

ModelFile model = new ModelFile.ExistingModelFile(modelPath.withPath(IItemModelGenerators::appendItemFolder), fileHelper);

model.assertExistence();

return model;

XFactHD · 2024-11-23T21:42:09Z

src/main/java/net/neoforged/neoforge/common/extensions/IModelProviderExtension.java

+        // ExistingFileHelper is nullable for backwards compat with vanilla data gen
+        // should never/rarely ever be null in modded data gen
+        var fileHelper = Objects.requireNonNull(self().fileHelper, "Looking up models requires a nonnull ExistingFileHelper");
+        return new ModelFile.ExistingModelFile(modelPath, fileHelper);


Suggested change

return new ModelFile.ExistingModelFile(modelPath, fileHelper);

ModelFile model = new ModelFile.ExistingModelFile(modelPath, fileHelper);

model.assertExistence();

return model;

XFactHD · 2024-11-23T21:42:27Z

src/main/java/net/neoforged/neoforge/common/extensions/IModelTemplateExtension.java

-    default ResourceLocation create(Block block, TextureMapping textures, BiConsumer<ResourceLocation, Supplier<JsonElement>> modelOutput, @Nullable ExistingFileHelper fileHelper) {
-        return create(ModelLocationUtils.getModelLocation(block, self().suffix.orElse("")), textures, modelOutput, fileHelper);
+    default ModelTemplate withRenderType(String renderType) {
+        return withRenderType(ResourceLocation.withDefaultNamespace(renderType));


Suggested change

return withRenderType(ResourceLocation.withDefaultNamespace(renderType));

return withRenderType(ResourceLocation.parse(renderType));

XFactHD · 2024-11-23T21:47:08Z

src/main/java/net/neoforged/neoforge/common/data/vanilla/ModelTemplateWithCustomData.java

        return json;
    }

    @Override
    public JsonObject createBaseTemplate(ResourceLocation modelPath, Map<TextureSlot, ResourceLocation> textureMap) {
        return createBaseTemplate(modelPath, textureMap, null);
    }
+
+    public static JsonObject toJson(ItemTransform transform) {


The toJson() methods need distinct names

XFactHD · 2024-11-23T21:47:49Z

patches/net/minecraft/data/models/ModelProvider.java.patch

-+    private final String modId;
-+    @org.jetbrains.annotations.Nullable private final net.neoforged.neoforge.common.data.ExistingFileHelper fileHelper;
+    public final String modId;
+    @org.jetbrains.annotations.Nullable public final net.neoforged.neoforge.common.data.ExistingFileHelper fileHelper;

 -    public ModelProvider(PackOutput p_252226_) {
 +    public ModelProvider(PackOutput p_252226_, String modId, @org.jetbrains.annotations.Nullable net.neoforged.neoforge.common.data.ExistingFileHelper fileHelper) {


Switch around the order of the constructors to make the patch a bit more readable

XFactHD · 2024-11-23T21:47:54Z

patches/net/minecraft/data/models/ItemModelGenerators.java.patch

         new ItemModelGenerators.TrimModelData("amethyst", 1.0F, Map.of())
     );
     public final BiConsumer<ResourceLocation, Supplier<JsonElement>> output;
 +    @org.jetbrains.annotations.Nullable public final net.neoforged.neoforge.common.data.ExistingFileHelper fileHelper;
+    public final String modId;

 -    public ItemModelGenerators(BiConsumer<ResourceLocation, Supplier<JsonElement>> p_125082_) {


Switch around the order of the constructors to make the patch a bit more readable

XFactHD · 2024-11-23T21:48:04Z

patches/net/minecraft/data/models/BlockModelGenerators.java.patch

@@ -64,23 +64,25 @@
 +    }
 +
 +    @org.jetbrains.annotations.Nullable public final net.neoforged.neoforge.common.data.ExistingFileHelper fileHelper;
+    public final String modId;
 +
     public BlockModelGenerators(
 -        Consumer<BlockStateGenerator> p_124481_, BiConsumer<ResourceLocation, Supplier<JsonElement>> p_124482_, Consumer<Item> p_124483_


Switch around the order of the constructors to make the patch a bit more readable

XFactHD · 2024-11-23T21:50:06Z

patches/net/minecraft/data/models/blockstates/VariantProperties.java.patch

+
+    // Neo: Allow passing model builders into block state variants
+    // Not to be used in conjunction with 'MODEL'
+    public static final VariantProperty<net.neoforged.neoforge.client.model.generators.BlockModelBuilder> MODEL_BUILDER = new VariantProperty<>("model", model -> new JsonPrimitive(model.getLocation().toString()));


I'm not sure this is particularly useful. The variant stuff is already pretty verbose, so it's unlikely someone would nest an entire model builder chain in that code, and pulling the location from a builder to pass to the vanilla VariantProperties.MODEL is trivial

ApexModder added 8 commits November 21, 2024 22:13

Allow modders to generate custom EquipentModels using EquipmentModelP…

225eed8

…rovider

Expose helpers EquipmentModels

7cd92c7

Allow modders to use ModelProvider

84105b3

Expose everything from ItemModelGenerators and BlockModelGenerators

Support modded paths in ModelLocationUtils

de85e78

Expose more helpers

83def4b

Support modded paths in ModelTemplate.create

Fix model provider not filtering for mod specific blocks/items

95f407d

Added test mod to validate ModelProvider and EquipmentModelProvider o…

a24b39a

…utput

Add note to ModelProvider

4c21d3d

ApexModder added the 1.21.3 Targeted at Minecraft 1.21.3 label Nov 22, 2024

ApexModder added 14 commits November 22, 2024 00:48

Add missing AT for record constructor

f8ae4b9

Validate model and texture information using ExistingFileHelper

a86c1c1

Fix typo in parameter name

edecdd1

Allow using vanilla texture slots in neos model builders

0193144

Add custom VariantProperty allowing modders to specify block model bu…

253e5c3

…ilders rather then ResLoc

Allow generating custom model files using vanilla model providers

b4230f1

Allow setting custom properties onto model templates

611832a

Allow setting render types for model templates

Fix typo with block state model builder generation

c7b5dff

Allow looking up existing model files

9465ad3

Always construct new model template when assigning custom data

d943508

Merge overloaded methods into vanilla code

500f631

Add more custom data to model templates

58d1c5a

Allow setting custom data from TexturedModel

Prepend model folders and append namespaces when missing

c9cc89b

Allow specifying render typed by strings (defaulting to "minecraft" namespace) Add mod and minecraft model path helpers Fix block models generating empty content

Support setting item transforms on model templates

b54fff3

ApexModder added 1.21.4 Targeted at Minecraft 1.21.4 and removed 1.21.3 Targeted at Minecraft 1.21.3 labels Nov 23, 2024

Fix model being generated into incorrect location

7f75f6c

XFactHD requested changes Nov 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[1.21.3] Expose vanilla model generators for modded usages #1696

[1.21.3] Expose vanilla model generators for modded usages #1696

ApexModder commented Nov 22, 2024 •

edited

Loading

neoforged-pr-publishing bot commented Nov 22, 2024 •

edited

Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

XFactHD Nov 23, 2024

-        return new ModelFile.ExistingModelFile(modelPath.withPath(IBlockModelGenerators::appendBlockFolder), fileHelper);
+        ModelFile model = new ModelFile.ExistingModelFile(modelPath.withPath(IBlockModelGenerators::appendBlockFolder), fileHelper);
+        model.assertExistence();
+        return model;

	return withRenderType(ResourceLocation.withDefaultNamespace(renderType));
	return withRenderType(ResourceLocation.parse(renderType));

[1.21.3] Expose vanilla model generators for modded usages #1696

Are you sure you want to change the base?

[1.21.3] Expose vanilla model generators for modded usages #1696

Conversation

ApexModder commented Nov 22, 2024 • edited Loading

neoforged-pr-publishing bot commented Nov 22, 2024 • edited Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ApexModder commented Nov 22, 2024 •

edited

Loading

neoforged-pr-publishing bot commented Nov 22, 2024 •

edited

Loading