Datageneration - Revision history

ChampionAsh5357: 37.0.91 fix, advancement providers now work

2021-10-15T18:20:24Z

37.0.91 fix, advancement providers now work

ChampionAsh5357: I can't read, now updated

2021-07-31T22:55:53Z

I can't read, now updated

ChampionAsh5357: Update to 1.17

2021-07-31T22:53:25Z

Update to 1.17

ShrimpBot: Categorize with Category:Data Generation by SizableShrimp#0755

2021-05-19T00:59:33Z

Categorize with Category:Data Generation by SizableShrimp#0755

SciWhiz12: cleanup some style, reword and restructure the first paragraphs

2021-01-02T04:29:11Z

cleanup some style, reword and restructure the first paragraphs

Unbekannt: Intial Import dokuwiki

2020-10-25T10:50:46Z

Intial Import dokuwiki

New page

Data generators are a way to programmatically generate the assets and data of mods. It allows the definition of the contents of these files in the code and their automatic generation, without worrying about the specifics.

The data generator system is loaded by the main class <code>net.minecraft.data.Main</code>. Different command-line arguments can be passed to customize which mods’ data are gathered, what existing files are considered, etc. The class responsible for data generation is <code>net.minecraft.data.DataGenerator</code>.

The default configurations in the MDK <code>build.gradle</code> adds the <code>runData</code> task for running the data generators.

== Generator Modes ==
The data generator can be configured to run 4 different data generations, which are configured from the command-line parameters, and can be checked from <code><nowiki>GatherDataEvent#include()</nowiki></code> methods.
* <code>Client Assets</code>
** Generates client-only files in <code>assets</code>: <code>block</code>/<code>item</code> models, <code>blockstate JSON</code>s, language files, etc.
** <code><nowiki>--client</nowiki></code>, <code><nowiki>includeClient()</nowiki></code>
* <code>Server Data</code>
** Generates server-only files in <code>data</code>: <code>recipes</code>, <code>advancements</code>, <code>tags</code>, etc.
** <code><nowiki>--server</nowiki></code>, <code><nowiki>includeServer()</nowiki></code>
* <code>Development Tools</code>
** Runs some development tools: converting SNBT to NBT and vice-versa, etc.
** <code><nowiki>--dev</nowiki></code>, <code>includeDev()</code>
* <code>Reports</code>
** Dumps all registered blocks, items, commands, etc.
** <code><nowiki>--reports</nowiki></code>, <code>includeReports()</code>

== Data Providers ==
Data providers are the classes that actually define what data will be generated and provided. All data providers implement <code>IDataProvider</code>. Minecraft has abstract implementations for most assets and data, so modders need only to extend and override the specified method.

The <code>GatherDataEvent</code> is fired on the mod event bus when the data generator is being created, and the <code>DataGenerator</code> can be obtained from the event. Create and register data providers using <code><nowiki>DataGenerator#addProvider</nowiki></code>.
=== Client Assets ===
* <code>net.minecraftforge.common.data.LanguageProvider</code> - for language strings; override <code><nowiki>#addTranslations</nowiki></code>
* <code><nowiki>ModelProvider<?></nowiki></code> - base class for all model providers
** ''These classes are under the <code>net.minecraftforge.client.model.generators</code> package''
*** <code>ItemModelProvider</code> - for item models; override <code>#registerModels</code>
*** <code>BlockStateProvider</code> - for blockstates and their block and item models; override <code>#registerStatesAndModels</code>
*** <code>BlockModelProvider</code> - for block models; override <code>#registerModels</code>

=== Server Data ===
* ''These classes are under the <code>net.minecraft.data</code> package''
* <code>LootTableProvider</code> - for loot tables; override <code>#getTables</code>
* <code>RecipeProvider</code> - for recipes and their unlocking advancements; override <code>#registerRecipes</code>
* <code>TagsProvider</code> - for tags; override <code>#registerTags</code>

{{Colored box|title=Tip|content=An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}

@@ Line 46: / Line 46: @@
 * <code>TagsProvider</code> - for tags; override <code>#addTags</code>
 * <code>GlobalLootModifierProvider</code> - for global loot modifiers; override <code>#start</code>
+* <code>AdvancementProvider</code> - for advancements; override <code>#registerAdvancements</code>
 [[Category:Data Generation]]

← Older revision		Revision as of 00:59, 19 May 2021
Line 46:		Line 46:

	{{Tip\|An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}		{{Tip\|An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}
		+
		+
		+	[[Category:Data Generation]]

@@ Line 43: / Line 43: @@
 * ''These classes are under the <code>net.minecraft.data</code> package''
 * <code>LootTableProvider</code> - for loot tables; override <code>#getTables</code>
-* <code>RecipeProvider</code> - for recipes and their unlocking advancements; override <code>#registerRecipes</code>
+* <code>RecipeProvider</code> - for recipes and their unlocking advancements; override <code>#buildCraftingRecipes</code>
-* <code>TagsProvider</code> - for tags; override <code>#registerTags</code>
+* <code>TagsProvider</code> - for tags; override <code>#addTags</code>
 * <code>GlobalLootModifierProvider</code> - for global loot modifiers; override <code>#start</code>

@@ Line 27: / Line 27: @@
 == Data Providers ==
-'''Data providers''' are the classes that define the resources data to be generated. All data providers implement <code>IDataProvider</code>. Minecraft has abstract implementations for most assets and data, so mod developers only need to extend those abstract classes and override the specified method.
+'''Data providers''' are the classes that define the resources data to be generated. All data providers implement <code>DataProvider</code>. Minecraft has abstract implementations for most assets and data, so mod developers only need to extend those abstract classes and override the specified method.
 The <code>GatherDataEvent</code> is fired on the mod event bus when the data generator is being created, and the <code>DataGenerator</code> can be obtained from the event. Create and register data providers using <code><nowiki>DataGenerator#addProvider</nowiki></code>.
@@ Line 38: / Line 38: @@
 *** <code>BlockStateProvider</code> - for blockstates and their block and item models; override <code>#registerStatesAndModels</code>
 *** <code>BlockModelProvider</code> -  for block models; override <code>#registerModels</code>
 === Server Data ===
@@ Line 44: / Line 45: @@
 * <code>RecipeProvider</code> - for recipes and their unlocking advancements; override <code>#registerRecipes</code>
 * <code>TagsProvider</code> - for tags; override <code>#registerTags</code>
 {{Tip|An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}

@@ Line 1: / Line 1: @@
-Data generators are a way to programmatically generate the assets and data of mods. It allows the definition of the contents of these files in the code and their automatic generation, without worrying about the specifics.
+'''Data generation''' (AKA '''datagen''') is a builtin system in Minecraft and Forge that allows mod developers to write code to programmatically generate the [[Using Resources|assets and data]] files of mods.
-The data generator system is loaded by the main class <code>net.minecraft.data.Main</code>. Different command-line arguments can be passed to customize which mods’ data are gathered, what existing files are considered, etc. The class responsible for data generation is <code>net.minecraft.data.DataGenerator</code>.
+Using datageneration offers some notable benefits:
 The default configurations in the MDK <code>build.gradle</code> adds the <code>runData</code> task for running the data generators.
@@ Line 7: / Line 13: @@
 == Generator Modes ==
 The data generator can be configured to run 4 different data generations, which are configured from the command-line parameters, and can be checked from <code><nowiki>GatherDataEvent#include()</nowiki></code> methods.
-* <code>Client Assets</code>
+* '''Client Assets'''
-** Generates client-only files in <code>assets</code>: <code>block</code>/<code>item</code> models, <code>blockstate JSON</code>s, language files, etc.
+** Generates client-only files in <tt>assets</tt>: [[Introduction to Models|block/item models]], [[BlockState JSONs|blockstate JSONs]], [[Datageneration/I18n|language files]], etc.
 ** <code><nowiki>--client</nowiki></code>, <code><nowiki>includeClient()</nowiki></code>
-* <code>Server Data</code>
+* '''Server Data'''
-** Generates server-only files in <code>data</code>: <code>recipes</code>, <code>advancements</code>, <code>tags</code>, etc.
+** Generates server-only files in <tt>data</tt>: [[Datageneration/Recipes|recipes]], advancements, [[Datageneration/Tags|tags]], etc.
 ** <code><nowiki>--server</nowiki></code>, <code><nowiki>includeServer()</nowiki></code>
-* <code>Development Tools</code>
+* '''Development Tools'''
 ** Runs some development tools: converting SNBT to NBT and vice-versa, etc.
 ** <code><nowiki>--dev</nowiki></code>, <code>includeDev()</code>
-* <code>Reports</code>
+* '''Reports'''
 ** Dumps all registered blocks, items, commands, etc.
 ** <code><nowiki>--reports</nowiki></code>, <code>includeReports()</code>
 == Data Providers ==
-Data providers are the classes that actually define what data will be generated and provided. All data providers implement <code>IDataProvider</code>. Minecraft has abstract implementations for most assets and data, so modders need only to extend and override the specified method.
+'''Data providers''' are the classes that define the resources data to be generated. All data providers implement <code>IDataProvider</code>. Minecraft has abstract implementations for most assets and data, so mod developers only need to extend those abstract classes and override the specified method.
 The <code>GatherDataEvent</code> is fired on the mod event bus when the data generator is being created, and the <code>DataGenerator</code> can be obtained from the event. Create and register data providers using <code><nowiki>DataGenerator#addProvider</nowiki></code>.
 === Client Assets ===
 * <code>net.minecraftforge.common.data.LanguageProvider</code> - for language strings; override <code><nowiki>#addTranslations</nowiki></code>
@@ Line 38: / Line 45: @@
 * <code>TagsProvider</code> - for tags; override <code>#registerTags</code>
-{{Colored box|title=Tip|content=An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}
+{{Tip|An <code>AdvancementProvider</code> class does exists, however it is hardcoded for only the vanilla advancements.}}