Translation Generation 1.21.11

A guide to setting up translation generation with datagen.

WARNING

This page is written for version 1.21.11. Documentation for older versions may be incomplete.

PREREQUISITES

Make sure you've completed the datagen setup process first.

Setup

First, we'll make our provider. Remember, providers are what actually generate data for us. Create a class that extends FabricLanguageProvider and fill out the base methods:

public class ExampleModEnglishLangProvider extends FabricLanguageProvider {
	protected ExampleModEnglishLangProvider(FabricDataOutput dataOutput, CompletableFuture<HolderLookup.Provider> registryLookup) {
		// Specifying en_us is optional, as it's the default language code
		super(dataOutput, "en_us", registryLookup);
	}

	@Override
	public void generateTranslations(HolderLookup.Provider holderLookup, TranslationBuilder translationBuilder) {
	}
}

TIP

You will need a different provider for each language you want to generate (eg. one ExampleEnglishLangProvider and one ExamplePirateLangProvider).

To finish setup, add this provider to your DataGeneratorEntrypoint within the onInitializeDataGenerator method.

pack.addProvider(ExampleModEnglishLangProvider::new);

Creating Translations

Along with creating raw translations, translations from Identifiers, and copying them from an already existing file (by passing a Path), there are helper methods for translating items, blocks, tags, stats, entities, mob effects, creative tabs, entity attributes, and enchantments. Simply call add on the translationBuilder with what you want to translate and what it should translate to:

translationBuilder.add("text.example-mod.greeting", "Hello there!");

Using Translations

Generated translations take the place of a lot of translations added in other tutorials, but you can also use them anywhere you use a Component object. In our example, if we wanted to allow resource packs to translate our greeting, we use Component.translatable instead of Component.literal:

ChatComponent chatHud = Minecraft.getInstance().gui.getChat();
chatHud.addMessage(Component.literal("Hello there!")); 
chatHud.addMessage(Component.translatable("text.example-mod.greeting"));