An open API service indexing awesome lists of open source software.

https://github.com/skyeye-fast/key_language_pack

A resource pack for displaying translation keys in Minecraft: Java Edition.
https://github.com/skyeye-fast/key_language_pack

language minecraft python resource-pack translation

Last synced: about 1 month ago
JSON representation

A resource pack for displaying translation keys in Minecraft: Java Edition.

Awesome Lists containing this project

README

          

# Minecraft Translation Key Language Resource Pack

- **[English](README.md) | [中文](README_zh.md)**

----

This project provides a resource pack replacing the content of Minecraft: Java Edition language files with translation keys.

It is recommended to use this resource pack with the mods [Language Reload](https://modrinth.com/mod/language-reload) and [Untranslated Items](https://www.curseforge.com/minecraft/mc-mods/untranslated-items).

## Download

- [**Download the latest version**](https://github.com/SkyEye-FAST/key_language_pack/releases/latest/download/key_language_pack.zip)
- [View previous versions](https://github.com/SkyEye-FAST/key_language_pack/releases/)

> [!TIP]
> Since all versions of language files after 1.19.2 can be used universally, you do not necessarily need to select the tag of the corresponding version, just select the latest version.

## Description

### Obtaining Language Files

This repository automatically checks for updates to Minecraft: Java Edition language file (`en_us.json`) every day at 🕧00:30 (UTC+8, equivalent to 🕟UTC 16:30) and updates the resource pack accordingly. This is done using the script [`source.py`](source.py) (requires `requests`). The obtained language files are stored in the `source` folder, which is at the same level as the script.

### Resource Pack

> [!IMPORTANT]
> This project ignores all translation keys starting with `translation.` because they are used to test whether in-game strings can be displayed correctly. Additionally, they are too complex and are not likely to occur in regular strings. For resource packs that replace these keys, refer to [Nickid2018/TranslationKeyPack](https://github.com/Nickid2018/TranslationKeyPack) and [bilintsui/keypack](https://github.com/bilintsui/keypack).

The resource pack is generated using [`pack.py`](pack.py). The language files generated by the script are [`key.json`](key.json) and [`key_arg.json`](key_arg.json), which are packed together with [`pack.mcmeta`](pack.mcmeta) into `key_language_pack.zip`.

The resource pack adds a language called "Translation (Keys)" to the game. Upon selection, all strings will be replaced with translation keys.

Additionally, the resource pack provides a language named "Translation (Keys with Arguments)", similar to MediaWiki's `qqx` language. Upon selection, strings will be replaced with translation keys and original arguments will be enclosed in parentheses.

The effect of selecting "Translation (Keys)" is shown in the images below:
![Sample](sample/1.png)
![Sample](sample/2.png)
![Sample](sample/3.png)
![Sample](sample/4.png)
![Sample](sample/5.png)

## License

The resource pack is released under the [Apache 2.0 license](LICENSE).

``` text
Copyright 2024-2025 SkyEye_FAST

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

## Feedback

Please feel free to raise issues for any problems encountered or feature suggestions.

Pull requests are welcome.