VMTU Documentation

website·Indexed 31 days ago

https://docs.vmct-cn.top

Documentation for VMTU, an automated localization management tool designed for Minecraft modpack translation patches. It includes guides on configuration files like modpackinfo.json and VM Metadata, resource pack automation, mod detection, and localization guidelines for the VM translation group.

Tokens
8.8K
Snippets
29
Records
58
Agent score
51%

What's inside VMTU

  1. Overview of VMTU translation management tool

    VMTU is an automated translation management tool designed for Minecraft modpack translation patches. It allows players to receive translation resource packs and enables translation groups to provide a better localization experience. Key features include:

    • Automatic detection and notification of translation updates.
    • Automatic downloading and activation of translation resource packs.
    • Automatic switching of game language.
    • Support for modpack-specific translation strategies via configuration files.
    • Control over resource pack loading order.
    • Dependency checks for I18nUpdateMod, Vault Patcher, and Texture Locale Redirector, with guidance for missing installations.
  2. Overview of VMTU translation management tool

    VMTU is an automated translation management tool designed for Minecraft modpack translation patches. It allows players to receive additional mod resource pack translations and enables translation groups to provide a better localization experience. Key features include:

    • Automatic detection of translation updates with in-game notifications.
    • Automatic downloading and activation of translation resource packs.
    • Automatic game language switching.
    • Support for specific modpack configuration files with individual translation strategies.
    • Control over resource pack loading order.
    • Dependency checks for I18nUpdateMod, Vault Patcher, and Texture Locale Redirector, with guidance pages if they are missing.
  3. Translate Minecraft mod names and item groups

    When translating mod names, ensure you have played the mod to understand its style. For clear meanings or professional terms, use direct translations. For 'Create' add-ons, use the format Main Mod: Sub Mod. For mods with multiple ItemGroups, use the format Mod Name丨Category Name (using the Chinese character 丨). If a mod name is a coined word and no suitable translation exists, keep the original text until community consensus is reached.
    Example Mod Name -> 林业 (Forestry)
    Create: Steam 'n' Rails -> 机械动力:汽鸣铁道
    Forestry Apiculture -> 林业丨养蜂
  4. Translate signs and item descriptions in game maps

    Follow these specific formatting rules for map elements:

    • Signs: Adhere to strict character and line limits. Test the layout in-game to ensure the text fits and is aesthetically pleasing.
    • Item Descriptions: Translate the full sentence first, then break it into lines. Ensure line lengths are roughly equal, avoid empty lines, break lines at the end of complete words, and do not place punctuation at the start of a line. Maintain the original line count for specially formatted text.
  5. Manage translator attribution in language files

    Do not add translator signatures or credits anywhere within the language files unless the author has provided a specific designated field for signatures. This is especially critical when the author requires a CLA (Contributor License Agreement).
  6. Translate real-world flora, fauna, and minerals

    Follow these rules for real-world entities:

    • Plants/Animals: Use formal translations for binomial/Latin names. If none exist, translate based on Latin roots (transliterating people/places). For common names, prioritize widely used domestic translations, otherwise translate literally.
    • Minerals: Use terminology from 'TermOnline' (术语在线). When combining a mineral term with 'ore', do not remove the 'mineral' part of the term (e.g., pyrite ore becomes 黄铁矿矿石).
    pyrite ore -> 黄铁矿矿石
    raw pyrite -> 粗黄铁矿
  7. Ensure consistency in map terminology and slang

    Maintain consistency for vanilla Minecraft terms and common map terminology. Refer to the official wiki for uncertain terms (e.g., 'Leather Tunic' -> '皮革外套', 'Monument' -> '纪念碑').

    For coined words, slang, or community memes, use the following resources:

    • ETYM: For etymology and roots.
    • Wiktionary: For word origins and affixes.
    • Urban Dictionary: For modern slang.
  8. Prerequisites for installing modpack translation patches

    Before installing translation patches, ensure you have the following tools:

    • A decompression software (e.g., 7-Zip, Bandizip, WinRAR, or 360 Compression).
    • A current version of a Minecraft launcher (HMCL and PCL2 are recommended).
  9. Install VMTU and its dependencies

    VMTU supports Forge, NeoForge, and Fabric loaders. It requires Cloth Config API as a prerequisite for all versions except Minecraft 1.12.2.

    Supported Versions:

    • Forge: 1.12.2, 1.16.5, 1.18 through 1.20.4. (Note: Forge 1.20.5+ is not supported because Cloth Config API is no longer supported for those versions).
    • NeoForge: 1.20 through 26.2.
    • Fabric: 1.16.5 through 26.2.

    Important Version Note: For Minecraft 1.12.2, the configuration file uses the .cfg format, which differs significantly from the .toml format used in newer versions.

  10. Format tree-related terminology based on context

    Tree names should be adjusted based on the item type to ensure natural phrasing in Chinese:

    • Single-character terms (e.g., Oak/橡): Add '树' for saplings/leaves, and '木' for logs/planks/products.
    • Multi-character terms not ending in 'wood' (e.g., Spruce/云杉): Keep the term as is for saplings/leaves; add '-木' for wood products.
    • Terms already ending in 'wood' (e.g., Mahogany/桃花心木): Do not remove the '木' suffix; use it consistently across all item types.
    // Single-character example (Oak)
    Oak Sapling -> 橡树树苗
    Oak Log -> 橡木原木
    Oak Stairs -> 橡木楼梯
    
    // Multi-character example (Spruce)
    Spruce Sapling -> 云杉树苗
    Spruce Log -> 云杉原木
    Spruce Stairs -> 云杉木楼梯
    
    // 'Wood' suffix example (Mahogany)
    Mahogany Sapling -> 桃花心木树苗
    Mahogany Log -> 桃花心木原木
    Mahogany Stairs -> 桃花心木楼梯
  11. General principles for Minecraft mod translation

    When translating Minecraft mods, follow these core principles to ensure quality and accuracy:

    • Source Fidelity: Play the mod first to understand the context, style, and item functions. Do not rely solely on machine translation or LLMs without personal verification. Ensure no critical information or code is omitted.
    • Natural Language: Adapt translations to Chinese linguistic habits. Convert dates, currency, and measurements to Chinese standards. Adjust passive voice and relative clauses to fit Chinese word order.
    • Consistency: Maintain strict consistency for items, blocks, and entity names. Use Translation Memory (TM) and Glossaries/Termbases (TB) to ensure recurring phrases and terms are translated identically.
    • Handling Incomplete Work: If submitting a partial translation, remove untranslated content (except for content that must remain in the original language).
    • Encoding: Language files should generally be encoded as UTF-8 without BOM (UTF-8).
    • Source Language: If the mod author is not a native English speaker and provides a native language file, use that as the primary source for translation.
  12. Install translation patches via manual file replacement

    This method is compatible with all translation patches. If you are a server owner, you must apply the patch to both the server-side and the client-side, otherwise players will be unable to join the game.

    Steps:

    1. Download the VM translation patch zip file.
    2. Extract the zip file to the current folder.
    3. Locate your modpack folder using your launcher (HMCL, PCL2, or PrismLauncher/MultiMC).
    4. Open the extracted patch folder. Ensure you see multiple files inside.
    5. Select all files (Ctrl+A on Windows, Command+A on Mac) and drag them into the modpack folder.
    6. When prompted to 'Replace or Skip files', select 'Replace files in the destination'.
    7. Launch the game. If the text is still in English, go to Options -> Language and switch to Simplified Chinese.