https://github.com/deftu/textualizer
An extension upon Textile which has it’s own custom I18n implementation.
https://github.com/deftu/textualizer
Last synced: 7 days ago
JSON representation
An extension upon Textile which has it’s own custom I18n implementation.
- Host: GitHub
- URL: https://github.com/deftu/textualizer
- Owner: Deftu
- License: lgpl-3.0
- Created: 2024-07-04T21:18:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-21T15:19:25.000Z (4 months ago)
- Last Synced: 2025-04-05T18:56:14.613Z (3 months ago)
- Language: Kotlin
- Size: 179 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Textualizer
A simple localization management library.
Features a Minecraft-specific implementation for mod developers, wrapping around Minecraft's own localization system.
---
[](https://s.deftu.dev/discord)
[](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:")
}
```
Replace `` 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-specific implementation](/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--:")
}
```
Of course, replace `` with the version of Minecraft you are developing for, `` with the mod loader you are developing for, and `` 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://bisecthosting.com/deftu)
---
**This project is licensed under [LGPL-3.0][lgpl3].**
**© 2024 Deftu**
[lgpl3]: https://www.gnu.org/licenses/lgpl-3.0.en.html