[1.21.4] Expose vanilla model generators for modded usages #1725

ApexModder · 2024-12-03T15:05:01Z

Updated version of #1696 for 1.21.4.

While the vanilla providers have been exposed for modded usage, and can be used for more simpler model generation. This is still highly WIP and requires more patches to support our model extensions and generating a model from scratch.

neoforged-pr-publishing · 2024-12-03T15:05:18Z

Publish PR to GitHub Packages

Last commit published: c351c859d1d2faa560c3fd4a85830b69b4cb8cb4.

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 #1725' // https://github.com/neoforged/NeoForge/pull/1725
        url 'https://prmaven.neoforged.net/NeoForge/pr1725'
        content {
            includeModule('net.neoforged', 'neoforge')
            includeModule('net.neoforged', 'testframework')
        }
    }
}

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-pr1725.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1725
cd NeoForge-pr1725
curl -L https://prmaven.neoforged.net/NeoForge/pr1725/net/neoforged/neoforge/21.4.93-beta-pr-1725-pr-vanilla-datagen-21.4/mdk-pr1725.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.

neoforged-automation · 2024-12-03T18:44:52Z

@ApexModder, this pull request has conflicts, please resolve them for this PR to move forward.

ApexModder · 2024-12-03T18:55:36Z

Merged in @XFactHD fork, everything should be exposed and usable. Test mod datagen just needs rewriting to now use vanilla model providers.

neoforged-compatibility-checks · 2024-12-03T23:56:22Z

@ApexModder, this PR introduces breaking changes.
Fortunately, this project is currently accepting breaking changes, but if they are not intentional, please revert them.
Last checked commit: c351c859d1d2faa560c3fd4a85830b69b4cb8cb4.

Compatibility checks

`neoforge (:neoforge)`

net/neoforged/neoforge/client/model/generators/MultiPartBlockStateBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$ElementBuilder$RotationBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/BlockModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelFile
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ConfiguredModel$Builder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$ElementBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$ElementBuilder$FaceBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/loaders/ObjModelBuilder
- ❗ Class missing superclass of net/neoforged/neoforge/client/model/generators/CustomLoaderBuilder
- begin(Lnet/neoforged/neoforge/client/model/generators/ModelBuilder;Lnet/neoforged/neoforge/common/data/ExistingFileHelper;)Lnet/neoforged/neoforge/client/model/generators/loaders/ObjModelBuilder;: ❗ API method was removed
- <init>(Lnet/neoforged/neoforge/client/model/generators/ModelBuilder;Lnet/neoforged/neoforge/common/data/ExistingFileHelper;)V: ❗ API method was removed
net/neoforged/neoforge/client/model/generators/ModelBuilder$RootTransformsBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/loaders/SeparateTransformsModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/BlockModelProvider
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/loaders/DynamicFluidContainerModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/MultiPartBlockStateBuilder$PartBuilder$ConditionGroup
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$TransformsBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/MultiPartBlockStateBuilder$PartBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/loaders/CompositeModelBuilder
- ❗ Class missing superclass of net/neoforged/neoforge/client/model/generators/CustomLoaderBuilder
- child(Ljava/lang/String;Lnet/neoforged/neoforge/client/model/generators/ModelFile;)Lnet/neoforged/neoforge/client/model/generators/loaders/CompositeModelBuilder;: ❗ API method was removed
- <init>(Lnet/neoforged/neoforge/client/model/generators/ModelBuilder;Lnet/neoforged/neoforge/common/data/ExistingFileHelper;)V: ❗ API method was removed
- begin(Lnet/neoforged/neoforge/client/model/generators/ModelBuilder;Lnet/neoforged/neoforge/common/data/ExistingFileHelper;)Lnet/neoforged/neoforge/client/model/generators/loaders/CompositeModelBuilder;: ❗ API method was removed
net/neoforged/neoforge/client/model/generators/loaders/ItemLayerModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ItemModelProvider
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelFile$UncheckedModelFile
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/CustomLoaderBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/VariantBlockStateBuilder$PartialBlockstate
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ConfiguredModel
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/VariantBlockStateBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ItemModelBuilder$OverrideBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/BlockStateProvider
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelFile$ExistingModelFile
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelProvider
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ItemModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/IGeneratedBlockState
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$TransformsBuilder$TransformVecBuilder
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/BlockStateProvider$ConfiguredModelList
- ❗ API class no longer exists
net/neoforged/neoforge/client/model/generators/ModelBuilder$FaceRotation
- ❗ API class no longer exists

ApexModder · 2024-12-07T01:17:50Z

This PR should now be ready for view but important note ExtendedModelTemplate.Builder may still get some major reworking to lessen the amount of nesting/.end calls.
Thinking of refactoring into lambda style rather than builder style.

Meaning that the following
ExtendedModelTemplate.builder().element().end()

would change to something like so
ExtendedModelTemplate.builder().element(element -> { })

neoforged-automation · 2024-12-09T09:39:43Z

@ApexModder, this pull request has conflicts, please resolve them for this PR to move forward.

neoforged-automation · 2024-12-11T02:56:14Z

@ApexModder, this pull request has conflicts, please resolve them for this PR to move forward.

neoforged-automation · 2024-12-12T18:14:48Z

@ApexModder, this pull request has conflicts, please resolve them for this PR to move forward.

XFactHD

A couple more comments, primarily about documentation.
When these are adressed, this PR is good to go from my end. The approval and merge has to be done by someone else as this PR adds code I wrote.

XFactHD · 2024-12-13T23:40:27Z

patches/net/minecraft/client/data/models/ItemModelOutput.java.patch

+
+     void copy(Item p_387316_, Item p_387995_);
+
+    default void register(Item item, net.minecraft.client.renderer.item.ClientItem clientItem) {


This should have a comment mentioning that Neo pulls this up into the interface to allow mods to control the entire ClientItem for an item and not just the ItemModel.Unbaked it uses.

Please provide JDoc on what this method does or is supposed to do after it now has been pulled up.

We can not expect tools like Parchment to provide this to modders so we should be libraral here with the explanation even if that increases the patch size.

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

...main/java/net/neoforged/neoforge/client/model/generators/template/RootTransformsBuilder.java

src/main/java/net/neoforged/neoforge/client/model/generators/template/RotationBuilder.java

src/main/java/net/neoforged/neoforge/client/model/generators/template/TransformVecBuilder.java

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

src/main/java/net/neoforged/neoforge/client/model/generators/template/TransformVecBuilder.java

patches/net/minecraft/client/data/models/ItemModelOutput.java.patch

…with it

ApexModder · 2024-12-16T08:56:02Z

PR should be ready for review and merge, only unresolved comment should be xfacts one about ModelTemplate#extend but we are both unsure of a more fitting name.

marchermans · 2024-12-19T11:35:19Z

patches/net/minecraft/client/data/models/ItemModelOutput.java.patch

+
+     void copy(Item p_387316_, Item p_387995_);
+
+    default void register(Item item, net.minecraft.client.renderer.item.ClientItem clientItem) {


Please provide JDoc on what this method does or is supposed to do after it now has been pulled up.

We can not expect tools like Parchment to provide this to modders so we should be libraral here with the explanation even if that increases the patch size.

marchermans · 2024-12-19T12:08:49Z

src/main/java/net/neoforged/neoforge/client/extensions/IBlockModelGeneratorsExtension.java

+import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.state.properties.BlockStateProperties;
+
+public interface IBlockModelGeneratorsExtension {


This extension is not strictly necessary.
It is possible to create a custom BlockFamily that is incomplete and use it to perform these generations

Please remove it.

src/main/java/net/neoforged/neoforge/common/data/ExistingFileHelper.java

ChampionAsh5357

A few minor things excluding what Orion said. I also removed my comments about the ExistingFileHelper if we are planning to strip it out.

ChampionAsh5357 · 2024-12-19T13:27:00Z

patches/net/minecraft/client/data/models/ItemModelOutput.java.patch

+
+     void copy(Item p_387316_, Item p_387995_);
+
+    // Neo: Pulled up from 'ModelProvider.ItemInfoCollector' to give modders full control over the 'ClientItem' instead of just the 'ItemModel.Unbacked' in '#accept'


Suggested change

+ // Neo: Pulled up from 'ModelProvider.ItemInfoCollector' to give modders full control over the 'ClientItem' instead of just the 'ItemModel.Unbacked' in '#accept'

+ // Neo: Pulled up from 'ModelProvider.ItemInfoCollector' to give modders full control over the 'ClientItem' instead of just the 'ItemModel.Unbaked' in '#accept'

ChampionAsh5357 · 2024-12-19T13:35:09Z

src/main/java/net/neoforged/neoforge/client/extensions/ITexturedModelExtension.java

+    default TexturedModel updateTemplate(UnaryOperator<ModelTemplate> modifier) {
+        return new TexturedModel(self().getMapping(), modifier.apply(self().getTemplate()));
+    }


I feel like this needs some documentation to explain why updateTemplate makes sense, since the additional data used by the custom loaders is set on the template itself rather than the textures slots.

ChampionAsh5357 · 2024-12-19T13:40:25Z

...et/neoforged/neoforge/client/model/generators/loaders/DynamicFluidContainerModelBuilder.java

I feel like this could be moved to an extension method on ItemModelGenerators rather than being outright removed as it still is a neoforge-added item model.

The only reason custom model loaders have builders is because they aren't reversible and therefore not serializable. The dynamic fluid container model is a custom ItemModel now though and the associated ItemModel.Unbaked can just be instantiated and passed to ItemModelOutput#register().

I understand. I just figured it would probably be easier to have a convenience method to create them, similar to all the methods in the model generator.

ChampionAsh5357 · 2024-12-19T13:41:30Z

src/main/java/net/neoforged/neoforge/client/model/generators/template/CustomLoaderBuilder.java

+    protected static void serializeNestedTemplate(ModelTemplate template, TextureMapping textures, Consumer<JsonElement> consumer) {
+        template.create(DUMMY, textures, (id, jsonSup) -> consumer.accept(jsonSup.get()));
+    }


Documentation? I don't know what this would be for.

Method was unused and thus has been removed, was told its better practice to now reference external files rather than inlining models like we used to, which this was used for in the past.

Completed

ApexModder added the 1.21.4 Targeted at Minecraft 1.21.4 label Dec 3, 2024

ApexModder force-pushed the pr/vanilla-datagen-21.4 branch from 408ec8a to 41e1c12 Compare December 3, 2024 18:44

neoforged-automation bot added the needs rebase label Dec 3, 2024

ApexModder force-pushed the pr/vanilla-datagen-21.4 branch from 41e1c12 to 3d04267 Compare December 3, 2024 18:47

ApexModder changed the base branch from port/1.21.4 to 1.21.x December 3, 2024 18:48

neoforged-automation bot removed the needs rebase label Dec 3, 2024

ApexModder mentioned this pull request Dec 3, 2024

Move custom models to extended template ApexModder/NeoForge#1

Closed

ApexModder mentioned this pull request Dec 4, 2024

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

Closed

5 tasks

XFactHD mentioned this pull request Dec 5, 2024

[1.21.4] Missing json files when generating Item Models #1742

Open

ApexModder linked an issue Dec 5, 2024 that may be closed by this pull request

[1.21.4] Missing json files when generating Item Models #1742

Open

ApexModder marked this pull request as ready for review December 7, 2024 01:17

neoforged-automation bot added the needs rebase label Dec 9, 2024

ApexModder force-pushed the pr/vanilla-datagen-21.4 branch from 4e6095e to b910484 Compare December 9, 2024 21:54

neoforged-automation bot removed the needs rebase label Dec 9, 2024

ApexModder requested a review from XFactHD December 9, 2024 21:55

neoforged-automation bot added the needs rebase label Dec 11, 2024

ApexModder force-pushed the pr/vanilla-datagen-21.4 branch from dced55d to 0e4ac40 Compare December 11, 2024 03:35

neoforged-automation bot added needs rebase and removed needs rebase labels Dec 11, 2024

ApexModder force-pushed the pr/vanilla-datagen-21.4 branch from 943368e to 916a5e2 Compare December 12, 2024 18:35

neoforged-automation bot removed the needs rebase label Dec 12, 2024

XFactHD requested changes Dec 14, 2024

View reviewed changes

Add additional javadocs to ExtendedModelTemplateBuilder

965528e

ApexModder requested review from XFactHD and Matyrobbrt December 15, 2024 21:02

ChampionAsh5357 mentioned this pull request Dec 16, 2024

Update to 1.21.4 neoforged/Documentation#211

Draft

22 tasks

XFactHD previously requested changes Dec 16, 2024

View reviewed changes

ApexModder added 4 commits December 16, 2024 05:28

Fix silly formatting mistake in ModelProvider patch

9b0ded8

Remove extra is from javadoc

9d17c36

Update comment in ItemModelOutput

3b0c47e

Add javadoc to RotationBuilder#rescale

93e87be

ApexModder requested a review from XFactHD December 16, 2024 05:45

ApexModder added 4 commits December 16, 2024 08:07

Fix more formatting issues in ModelProvider patch

f96308d

Fix typos in javadoc

a0b5f09

Reword javadoc

1cb8c4c

Add comment to ModelTemplate#extend describing what modders can do …

28e4b76

…with it

marchermans requested changes Dec 19, 2024

View reviewed changes

ChampionAsh5357 requested changes Dec 19, 2024

View reviewed changes

ApexModder added 6 commits December 19, 2024 17:03

Convert comment to jdoc

123b980

Tear out BlockFamily wrapper extension methods

e0ea5aa

Remove IBlockModelGeneratorsExtension

ee3f504

Mark ExistingFileHelper for removal

86b5106

Add jdocs to ITexturedModelExtension#updateTemplate

d79c8cc

Nuke unused method and field

f9eb871

ApexModder requested review from marchermans and ChampionAsh5357 December 19, 2024 17:36

XFactHD removed their request for review December 19, 2024 17:38

Add method to allow generating family models for existing blocks

bc5f055

ApexModder added the keep rebased Add this label to a PR to keep it rebased continuously automatically label Dec 20, 2024

Merge branch '1.21.x' into pr/vanilla-datagen-21.4

c351c85

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[1.21.4] Expose vanilla model generators for modded usages #1725

[1.21.4] Expose vanilla model generators for modded usages #1725

ApexModder commented Dec 3, 2024

neoforged-pr-publishing bot commented Dec 3, 2024 •

edited

Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

neoforged-automation bot commented Dec 3, 2024

ApexModder commented Dec 3, 2024 •

edited

Loading

neoforged-compatibility-checks bot commented Dec 3, 2024 •

edited

Loading

`neoforge (:neoforge)`

ApexModder commented Dec 7, 2024

neoforged-automation bot commented Dec 9, 2024

neoforged-automation bot commented Dec 11, 2024

neoforged-automation bot commented Dec 12, 2024

XFactHD left a comment

XFactHD Dec 13, 2024

marchermans Dec 19, 2024

ApexModder commented Dec 16, 2024

marchermans Dec 19, 2024

marchermans Dec 19, 2024

marchermans Dec 19, 2024

ChampionAsh5357 left a comment

ChampionAsh5357 Dec 19, 2024

ChampionAsh5357 Dec 19, 2024

ChampionAsh5357 Dec 19, 2024

XFactHD Dec 19, 2024

ChampionAsh5357 Dec 19, 2024

ChampionAsh5357 Dec 19, 2024

ApexModder Dec 19, 2024

	+ // Neo: Pulled up from 'ModelProvider.ItemInfoCollector' to give modders full control over the 'ClientItem' instead of just the 'ItemModel.Unbacked' in '#accept'
	+ // Neo: Pulled up from 'ModelProvider.ItemInfoCollector' to give modders full control over the 'ClientItem' instead of just the 'ItemModel.Unbaked' in '#accept'

[1.21.4] Expose vanilla model generators for modded usages #1725

Are you sure you want to change the base?

[1.21.4] Expose vanilla model generators for modded usages #1725

Conversation

ApexModder commented Dec 3, 2024

neoforged-pr-publishing bot commented Dec 3, 2024 • edited Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

neoforged-automation bot commented Dec 3, 2024

ApexModder commented Dec 3, 2024 • edited Loading

neoforged-compatibility-checks bot commented Dec 3, 2024 • edited Loading

neoforge (:neoforge)

ApexModder commented Dec 7, 2024

neoforged-automation bot commented Dec 9, 2024

neoforged-automation bot commented Dec 11, 2024

neoforged-automation bot commented Dec 12, 2024

XFactHD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ApexModder commented Dec 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChampionAsh5357 left a 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

neoforged-pr-publishing bot commented Dec 3, 2024 •

edited

Loading

ApexModder commented Dec 3, 2024 •

edited

Loading

neoforged-compatibility-checks bot commented Dec 3, 2024 •

edited

Loading

`neoforge (:neoforge)`