https://github.com/imb11/loqui

Providing free, open-source, and community-driven translations for ALL Minecraft mods.
https://github.com/imb11/loqui

crowdin fabric fabricmc i18n minecraft modding translation

Last synced: about 1 month ago
JSON representation

Providing free, open-source, and community-driven translations for ALL Minecraft mods.

• Host: GitHub
• URL: https://github.com/imb11/loqui
• Owner: IMB11
• License: mit
• Created: 2024-04-06T15:34:53.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-05-30T09:34:13.000Z (6 months ago)
• Last Synced: 2024-05-30T11:10:32.690Z (6 months ago)
• Topics: crowdin, fabric, fabricmc, i18n, minecraft, modding, translation
• Language: TypeScript
• Homepage: https://loqui.imb11.dev/
• Size: 1.28 MB
• Stars: 20
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### **_Loqui depends on community contributions, please help us translate at [Loqui's Translation Project](https://loqui.imb11.dev/)_**

[![](/lokalise_badge.png)](https://lokalise.com/solutions/for-managers)

# Loqui

The goal of Loqui is to provide free, open-source, and community-driven translations for ALL Minecraft mods.

*A NeoForge port is planned, but the current goal is to smooth out any significant bugs and issues that may happen.*

## For Users

Simply drop Loqui into your mods folder, and it will download any translations you need from the Loqui API, it's that simple!

## For Modpack Developers

Again, include Loqui in your modpack and you can allow your users to play in their native language!

It's recommended you encourage your community to join the [Translation Project](https://loqui.imb11.dev/) in order to improve the quality and quantity of translations - the more the merrier!

## For Mod Developers

A system is currently being developed that will allow mod developers to download translations from the Loqui API and bundle them directly into their mods.

Loqui has an intelligent algorithm that allows translations to be accurate across versions, and ignore any existing translations your mod may provide!

## Benefits

- **Crowdsourced translations** - Get your mod translated by the community for free, all translations are moderated by verified proofreaders.

- **Automatic updates** - No need to manually update translations, Loqui will do it for you.

- **Ability to download translations** - You can download the translations from Crowdin and bundle them directly in your mod if you wish.

## Technical Explanation

- Loqui traverses your mods folder, gathering information on mods and what `en_us.json` files are present.

- It then sends this information to the Loqui API, which returns any translations that are available, and indexes any new unrecognized `en_us.json` files it recieves so that the community can translate them.

- Loqui then downloads these translations and places them in the correct location.

For more information, visit the [Loqui Website](https://loqui.imb11.dev/).

## Opt-out

Opting out can be useful if:

- You already provide crowd-sourced translations.

- You have a custom translation system.

- You don't want your mod to be translated.

If you wish to opt-out of Loqui, you can do so by adding a `noloqui.txt` file to your mod's resources directory.

Eg: `assets/namespace/noloqui.txt` would disable loqui for any language files within the `namespace` namespace.

If you wish to have your mod removed from Loqui entirely - including any `en_us.json` files that have been pre-indexed, please contact me directly.