Textualizer

# Textualizer A simple localization management library. Features a Minecraft-specific implementation for mod developers, wrapping around Minecraft's own localization system. --- (https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/cozy/social/discord-singular_64h.png)](https://s.deftu.dev/discord) (https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/cozy/donate/kofi-singular_64h.png)](https://s.deftu.dev/kofi) --- # For developers ## Setup You need to add it as a dependency in your `build.gradle(.kts)` file. ```kt repositories { maven("https://maven.deftu.dev/releases") } dependencies { modImplementation("dev.deftu:textualizer:<VERSION>") } ``` Replace `<VERSION>` with the version of the library you want to use. ## Usage You'll need to implement `Language`, `LocalizationContext`, and `Localization` in your project. This means you need to handle language metadata, translation loading, translation retrieval, placeholder replacement, and language switching. Refer to the (/minecraft/src/main/kotlin/dev/deftu/textualizer/minecraft) for an example of how to do this. --- # For Minecraft mod users ## Why do I need this? Minecraft's (and Forge's) language management system is very buggy and inconsistent across several Minecraft versions. This library aims to provide a consistent and reliable way to manage translations in your mods. ## Is it going to affect my FPS / performance? No. The library doesn't add anything which would affect performance outside the initial loading of the translations and language switching. --- # For Minecraft mod developers ## Setup You need to add it as a dependency in your `build.gradle(.kts)` file. ```kt repositories { maven("https://maven.deftu.dev/releases") } dependencies { modImplementation("dev.deftu:textualizer-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>") } ``` Of course, replace `<MINECRAFT VERSION>` with the version of Minecraft you are developing for, `<MOD LOADER>` with the mod loader you are developing for, and `<VERSION>` with the version of the library you want to use. ## Usage Getting the current (selected in-game) language's context can be done like so: ```java import dev.deftu.textualizer.minecraft.MCLocalization; LocalizationContext context = MCLocalization.current(); ``` To obtain a translated string, you can use ```java import dev.deftu.textualizer.minecraft.MCLocalization; LocalizationContext context = MCLocalization.current(); String text = context.get("com.example"); ``` To obtain a translated string and replace your placeholders, you can use ```java import dev.deftu.textualizer.MCLocalization; int number = 10; LocalizationContext context = MCLocalization.current(); String text = context.get("com.example", number); ``` --- (https://www.bisecthosting.com/partners/custom-banners/8fb6621b-811a-473b-9087-c8c42b50e74c.png)](https://bisecthosting.com/deftu) --- **This project is licensed under .** **&copy; 2024 Deftu** : https://www.gnu.org/licenses/lgpl-3.0.en.html