diff --git a/.vitepress/locales/zh/sidebar.js b/.vitepress/locales/zh/sidebar.js index 733fbd45..207cbbee 100644 --- a/.vitepress/locales/zh/sidebar.js +++ b/.vitepress/locales/zh/sidebar.js @@ -130,16 +130,17 @@ const sidebar = { "/vmtu": [ { text: "VM汉化组", link: "index" }, { - text: "入门", + text: "VM汉化更新模组配置文档", collapsed: false, items: [ - { text: "功能介绍", link: "/vmtu/" }, - { text: "使用与配置文件", link: "/vmtu/config" }, - { text: "自动切换语言详解", link: "/vmtu/language" }, - { text: "模组安装检测提示", link: "/vmtu/mod-check" }, - { text: "资源包下载功能详解", link: "/vmtu/resource-pack" }, - { text: "更新检测配置", link: "/vmtu/update" }, - { text: "版本支持概况", link: "/vmtu/version" }, + { text: "Mod简介", link: "/vmtu/" }, + { text: "配置文件", link: "/vmtu/config" }, + { text: "自动切换语言", link: "/vmtu/language" }, + { text: "模组安装检测", link: "/vmtu/mod-check" }, + { text: "资源包", link: "/vmtu/resourcepack" }, + { text: "汉化更新检测", link: "/vmtu/translation-update" }, + { text: "支持的ModLoader和版本", link: "/vmtu/supported-version" }, + { text: "VM Metadata", link: "/vmtu/metadata" } ], }, ], diff --git a/src/public/imgs/vmtu/config.png b/src/public/imgs/vmtu/config.png deleted file mode 100644 index 095a9842..00000000 Binary files a/src/public/imgs/vmtu/config.png and /dev/null differ diff --git a/src/public/imgs/vmtu/config2.png b/src/public/imgs/vmtu/config2.png deleted file mode 100644 index dfaf0cca..00000000 Binary files a/src/public/imgs/vmtu/config2.png and /dev/null differ diff --git a/src/zh/vmtu/config.md b/src/zh/vmtu/config.md index 679d9e79..31353219 100644 --- a/src/zh/vmtu/config.md +++ b/src/zh/vmtu/config.md @@ -1,66 +1,79 @@ --- layout: doc -title: 使用与配置文件 +title: 配置文件 + --- ## 配置文件说明 -本模组会在首次启动且未找到相关配置文件时自动生成两个配置文件： - -1. **功能配置文件** - `config/vmtranslationupdate.toml` - （1.12.2版本为`.cfg`后缀） - 用于控制模组核心功能的开关 +本模组会在首次启动且未找到相关配置文件时自动生成两个文件： -2. **整合包汉化信息文件** - `/modpackinfo.json` - 用于定义汉化补丁的版本信息和更新检测配置 - ---- +1. Mod配置文件：用于控制模组核心功能的开关 +2. `modpackinfo.json`：用于定义汉化补丁的版本信息和更新检测配置 -## 功能配置详解 +## Mod配置 文件位于游戏的`config/vmtranslationupdate.toml`，用于设置具体模组功能的开关， -实现具体功能的配置位于下文的`modpackinfo.json`。 ```toml -autoSwitchLanguage = true # 自动切换语言 -autoDownloadVMTranslationPack = false # 默认不自动下载VM汉化资源包 -translationPackSource = "GITEE" # 汉化资源包下载源 -checkModPackTranslationUpdate = true # 默认检查汉化更新 -i18nUpdateModCheck = true # 默认检查是否安装i18nUpdateMod模组 -vaultPatcherCheck = false # 默认不检查是否安装Vault Patch模组 -testMode = false # 供开发者使用的测试模式，会有更多日志，并在聊天栏打印整合包信息 +devMode = false # 供开发者使用的测试模式，会有更多日志，并在聊天栏打印整合包信息 +autoSwitchLanguage = true # 自动切换语言（默认启用） +autoDownloadVMTranslationPack = false # 自动下载VM汉化资源包 +checkModPackTranslationUpdate = true # 检查整合包汉化更新 +autoLoadExtraTranslationPack = false # 自动加载扩展汉化资源包 +resourcePackIndex = DEFAULT # 资源包在资源包列表中的位置 +extraPackName = "" # 扩展汉化资源包名称（包括扩展名） +extraPackCustomIndex = 0 # 自定义扩展翻译资源包在资源包列表中的位置 +i18nUpdateModCheck = true # 默认检查是否安装i18nUpdateMod模组（默认启用） +vaultPatcherCheck = false # 默认不检查是否安装Vault Patch模组 ``` -为了方便使用，本配置文件的所有内容均可在游戏内的模组配置界面进行修改。 +为了方便使用，本配置文件的所有内容均可在游戏内的模组配置界面进行修改。[^1] -![](/imgs/vmtu/config.png) +## `modpackinfo.json` -![](/imgs/vmtu/config2.png) +`modpackinfo.json`是用于标记整合包信息以及汉化包配置的文件，此文件主要用于让VMTU基于此文件向VM Metadata查询汉化包更新。 -对于 Fabric 版本，需安装可选的 Modmenu 模组后才能看到模组页面。 +`modpackinfo.json`内各字段解释如下： ---- +### `modpack` + +`modpack.name`：整合包名称 + +`modpack.version`：汉化适配的整合包版本 + +#### `modpack.translation` -## 汉化补丁配置说明 +`modpack.translation.id`：用于向vm-meta查询汉化的id（要与vm-meta的一致） + +`modpack.translation.url`：在官网的汉化发布页面 + +`modpack.translation.language`：默认语言，用于语言切换功能 + +`modpack.translation.version`：汉化补丁包版本号，用于设定当前汉化补丁版本 + +`modpack.translation.resourcePackName`：VM汉化资源包名称，用于下载汉化资源包 + +:::details `modpackinfo.json` 示例 ```json { "modpack": { - // 整合包基础信息 - "name": "ExampleModpack", // 整合包名称 - "version": "0.1.0", // 汉化适配的整合包版本 - // 汉化配置核心参数 + "name": "ExampleModpack", + "version": "0.1.0", "translation": { - "id": "example", // 用于汉化检测的 meta id - "url": "https://vmct-cn.top/modpacks/example/", // 汉化页面官网 - "language": "zh_cn", // 默认语言，用于语言切换功能 - "version": "1.0.0", // 当前汉化版本号，用于检测汉化更新 - "resourcePackName": "VM汉化组模组汉化包1.19及以上" // 基础汉化资源包名称 + "id": "example", + "url": "https://vmct-cn.top/modpacks/example/", + "language": "zh_cn", + "version": "1.0.0", + "resourcePackName": "VM汉化组模组汉化包1.19及以上" } } } ``` -> 注：基础汉化资源包名称指的是需要下载的基础汉化资源包文件名 +::: + + + +[^1]: 对于 Fabric 版本，需安装可选的 Modmenu 模组后才能看到模组页面。 diff --git a/src/zh/vmtu/index.md b/src/zh/vmtu/index.md index 3aaeaab8..4e54dbf5 100644 --- a/src/zh/vmtu/index.md +++ b/src/zh/vmtu/index.md @@ -1,16 +1,16 @@ --- layout: doc -title: VM汉化更新模组文档 4.1.0 +title: VM汉化更新模组文档 --- -
- logo -

VM汉化更新模组文档 4.1.0

-
+# VM汉化更新模组文档 VM汉化更新是一个为 Minecraft 整合包汉化补丁设计的自动化汉化管理工具，涵盖了绝大部分汉化相关的使用场景。 目前主要为VM汉化组内部使用。 +> [!IMPORTANT] +> 本文档所有内容基于VMTU 4.1.0版本编写 + [!IMPORTANT] +> VM Metadata v1 已经弃用，VMTU 后续可能会删除此兼容，建议使用 VM Metadata v2 ！ + +VM Metadata v1 使用txt作为存储版本的文件，文件结构如下所示： + +```txt +1.0.0 +``` + +VM Metadata v1只有存储汉化补丁版本的功能 + +### VM Metadata v2 + +VM Metadata v2 重写了版本检测逻辑，使用json作为存储版本的文件，文件结构如下所示： + +:::details `vm-meta.json` 示例 +```json +{ + "metaVersion": "v2", + "modpacks": { + "example": { + "translationVersion": "1.1.0", + "modpackVersion": "1.0.2" + }, + "example2": { + "translationVersion": "1.4.0", + "modpackVersion": "1.2.1" + } + } +} +``` + +`metaVersion` ：VM Metadata当前版本 + +`modpacks.[id]` ：整合包id，对应`modpackinfo.json`的`modpack.translation.id` + +`modpacks.[id].translationVersion` ：整合包汉化补丁最新版本，对应`modpackinfo.json`的`modpack.translation.version` + +`modpacks.[id].modpackVersion` ：整合包最新版本，对应`modpackinfo.json`的`modpack.version` +::: + diff --git a/src/zh/vmtu/mod-check.md b/src/zh/vmtu/mod-check.md index 30fdb96a..65160d55 100644 --- a/src/zh/vmtu/mod-check.md +++ b/src/zh/vmtu/mod-check.md @@ -1,14 +1,9 @@ --- layout: doc -title: 模组安装检测提示 +title: 模组安装检测 --- -当配置文件中的下列两项启用至少一项时，VMTU 将会检测其启用检测的模组是否安装 - -```toml -i18nUpdateModCheck = true # 默认检查是否安装i18nUpdateMod模组 -vaultPatcherCheck = false # 默认不检查是否安装Vault Patch模组 -``` +当配置文件中的`i18nUpdateModCheck`或`vaultPatcherCheck`启用至少一项时，VMTU 将会检测其启用检测的模组是否安装。 如相应模组均已安装，则不会出现任何提示； diff --git a/src/zh/vmtu/resource-pack.md b/src/zh/vmtu/resource-pack.md deleted file mode 100644 index fdb99232..00000000 --- a/src/zh/vmtu/resource-pack.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: doc -title: 资源包下载功能详解 ---- - -当配置文件中的下方条目启用时，VMTU 将会自动下载并应用 VM 汉化资源包 - -```toml -autoDownloadVMTranslationPack = false # 默认不自动下载VM汉化资源包 -``` - -未完成 diff --git a/src/zh/vmtu/resourcepack.md b/src/zh/vmtu/resourcepack.md new file mode 100644 index 00000000..d22b093b --- /dev/null +++ b/src/zh/vmtu/resourcepack.md @@ -0,0 +1,34 @@ +--- +layout: doc +title: 资源包 +--- + +## 自动下载汉化资源包 + +当配置文件中的`autoDownloadVMTranslationPack`启用时，VMTU 将会自动下载并应用 VM 汉化资源包 + +你可以在 `modpackinfo.json` 中设置 VM 汉化资源包。汉化资源包名称及其支持版本如下表： + +| 汉化资源包名称 | 支持的Minecraft版本 | +| ---------- | --------------------------------- | +| VM汉化组模组汉化包1.19及以上 | 1.19~ | +| VM汉化组模组汉化包1.18 | 1.18.x | +| VM汉化组模组汉化包1.16 | 1.16.x | +| VM汉化组模组汉化包1.12 | 1.12.2 | + +## 扩展资源包 + +当配置文件中的`autoLoadExtraTranslationPack`启用时，VMTU 将会自动应用扩展汉化资源包 + +你可以在配置文件中的`extraPackName`设置扩展汉化资源包名称（包括扩展名）。 + +`extraPackCustomIndex`用于设置扩展资源包在资源包列表的顺序。此项更多内容将在自定义资源包顺序讲解。 + +## 自定义资源包顺序 + +自定义资源包顺序`resourcePackIndex`可以设定为以下状态： + +`DEFAULT` ：在资源包列表中插入汉化资源包时，不调整插入顺序 +`TOP_OF_CFPA` ：在资源包列表中插入汉化资源包时，先将CFPA资源包置顶再将汉化资源包插入CFPA资源包上面 +`BOTTOM_OF_CFPA` ：在资源包列表中插入汉化资源包时，先将CFPA资源包置顶再将汉化资源包插入CFPA资源包下面 +`CUSTOM_INDEX` ：在资源包列表中插入汉化资源包时，使用自定义顺序插入到列表中 \ No newline at end of file diff --git a/src/zh/vmtu/version.md b/src/zh/vmtu/supported-version.md similarity index 85% rename from src/zh/vmtu/version.md rename to src/zh/vmtu/supported-version.md index b6509ab9..d07a74b2 100644 --- a/src/zh/vmtu/version.md +++ b/src/zh/vmtu/supported-version.md @@ -1,13 +1,13 @@ --- layout: doc -title: 版本支持概况 +title: 支持的ModLoader和版本 --- 本模组需要Cloth Config API作为前置（1.12.2版本除外），支持三大主流模组加载器： ![](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/forge_vector.svg) ![](https://raw.githubusercontent.com/KessokuTeaTime/Badges-Extra/main/assets/cozy/supported/neoforge_vector.svg) ![](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg) -VMTU在3.2.0版本开始，同时支持和维护以下的全版本，以下是本模组支持的Minecraft版本表格： +VMTU目前同时支持和维护以下的全版本，以下是支持版本列表： | 模组加载器 | 支持的Minecraft版本 | | ---------- | --------------------------------- | diff --git a/src/zh/vmtu/update.md b/src/zh/vmtu/translation-update.md similarity index 52% rename from src/zh/vmtu/update.md rename to src/zh/vmtu/translation-update.md index 299c806e..cdc43006 100644 --- a/src/zh/vmtu/update.md +++ b/src/zh/vmtu/translation-update.md @@ -1,12 +1,12 @@ --- layout: doc -title: 更新检测配置 +title: 汉化更新检测 --- -在上一节的[汉化补丁配置说明](./config)中，我们介绍了`modpackinfo.json`中的各项功能。 +在上一节的[`modpackinfo.json`](./config#`modpackinfo.json`)中，我们介绍了这个文件中的各项功能。 现在，我们按照该文件内的功能逐一详细的介绍使用方法。 -整合包更新检测功能是VMTU模组核心的功能之一，其行为由以下的3项配置共同决定： +整合包更新检测功能是VMTU模组核心的功能之一，其行为由`modpackinfo.json`内的3项配置决定： ```json { @@ -24,15 +24,15 @@ title: 更新检测配置 } ``` -未完成 +当使用`modpackinfo.json`的`modpack.translation.id`和`modpack.translation.version`向VM Metadata查询到更新时，VMTU会在玩家进入世界后在聊天栏显示如下内容： ![](/imgs/vmtu/zh_cn.png) -当玩家在中文环境下（简中、繁中、港中），且未完成 +当玩家在中文环境下（简中、繁中、港中），但是游戏语言不是所设置的支持语言（`modpackinfo.json`的`modpack.translation.language`）时会显示如下内容： ![](/imgs/vmtu/zh_tw.png) -另外，从 4.0.0 版本开始，VMTU 添加了一条客户端指令 `/vmtu check`，用于手动触发汉化更新检测。 +另外，VMTU 添加了一条客户端指令 `/vmtu check`，用于手动触发汉化更新检测。 该指令会忽略配置文件中的`checkModPackTranslationUpdate`选项，强制进行更新检测。 并且所有游戏语言都可以使用该指令。