vmtu wiki

.vitepress/config/index.js

@@ -10,7 +10,7 @@ export default defineConfig({
     root: { label: '简体中文', ...zh },
     tw: { label: '繁體中文', ...tw }
   },
-  srcExclude: ['**/readme.md', '**/LICENSE', '**/.gitignore'],
+  srcExclude: ['**/README.md', '**/LICENSE', '**/.gitignore'],
 
   lastUpdated: true,
   cleanUrls: true,

.vitepress/config/tw.js

@@ -24,6 +24,7 @@ export const tw = defineConfig({
     sidebar: {
       '/modpacks/': { base: '/modpacks/', items: sidebarModpacks() },
       '/tw/map/': { base: '/tw/map/', items: sidebarMap() },
+      '/tw/others/vmtu/': { base: '/tw/others/vmtu/', items: sidebarVMTU() },
       '/tw/': { base: '/tw/map/', items: sidebar() }
     },
 
@@ -153,6 +154,21 @@ function sidebarMap(){
   ]
 }
 
+function sidebarVMTU(){
+  return [
+    { text: 'VM翻譯組', base: '/', link: 'index' },
+    {
+      text: '入門',
+      collapsed: false,
+      items: [
+        { text: '功能介紹', base: '/', link: 'others/vmtu/' },
+        { text: '使用與設定檔', base: '/', link: 'others/vmtu/config' },
+        { text: '支援版本', base: '/', link: 'others/vmtu/support' },
+      ]
+    }
+  ]
+}
+
 function sidebar(){
   return [
     { text: '返回首頁', base: '/', link: 'tw' },

.vitepress/config/zh.js

@@ -23,6 +23,7 @@ export const zh = defineConfig({
     sidebar: {
       '/modpacks/': { base: '/modpacks/', items: sidebarModpacks() },
       '/map/': { base: '/map/', items: sidebarMap() },
+      '/others/vmtu/': { base: '/others/vmtu/', items: sidebarVMTU() },
       '/': { base: '/', items: sidebar() }
     },
 
@@ -165,6 +166,21 @@ function sidebarMap(){
   ]
 }
 
+function sidebarVMTU(){
+  return [
+    { text: 'VM汉化组', base: '/', link: 'index' },
+    {
+      text: '入门',
+      collapsed: false,
+      items: [
+        { text: '功能介绍', base: '/', link: 'others/vmtu/' },
+        { text: '使用与配置文件', base: '/', link: 'others/vmtu/config' },
+        { text: '支持版本', base: '/', link: 'others/vmtu/support' },
+      ]
+    }
+  ]
+}
+
 function sidebar(){
   return [
     { text: '返回首页', base: '/', link: 'index' },

others/vmtu/config.md

@@ -0,0 +1,18 @@
+模组会在`.minecraft/<mcversion>/config/`文件夹创建名为`vmtranslationupdate`的配置文件（1.12.2后缀是.cfg，其他版本为.toml）。
+
+配置项如下：
+1. 自动根据切换语言（`autoSwitchLanguage`）：默认禁用，在安装了[Stenographer](https://modrinth.com/mod/stenographer)模组后将禁用。
+2. 自动检测整合包汉化版本更新（`checkModPackTranslationUpdate`）：默认启用，在每次玩家进入世界后检查整合包汉化更新。
+3. 自动下载VM汉化资源包（`autoDownloadVMTranslationPack`）：默认启用，在每次加载游戏时下载VM汉化资源包。
+4. 自动安装VM汉化资源包（`autoInstallVMTranslationPack`）：默认启用，在每次加载游戏时安装VM汉化资源包。前置为自动下载VM汉化资源包（`autoDownloadVMTranslationPack`）必须开启。
+5. 显示小提示（`displayTips`）：默认启用，在玩家进入存档后每25分钟（可配置）在聊天栏发送一条知识。
+6. 检测玩家名称彩蛋（`playerNameCheck`）：默认启用，在特定玩家进入存档后用于称呼的玩家英文名称将改为定义的专属称呼。
+7. 选择切换语言为（`switchLanguage`）：默认为`zh_cn`, 选择要切换的语言（当自动根据切换语言被打开时在每次游戏启动时生效），此处应填语言代码。
+8. 更新检测链接（`modPackTranslationUpdateCheckUrl`）：只能填写指向一个txt文件的链接，链接的txt文件只能有此整合包翻译版本号。如：`https://vmct-cn.top/modpacks/example/update.txt`
+9. 下载链接（`modPackTranslationUrl`）：填写一个指向整合包下载页的链接。如：`https://vmct-cn.top/modpacks/example/`
+10. 获取知识内容的链接（`tipsUrl`）：前置为显示小提示（`displayTips`）必须开启。用于知识显示功能，此链接必须指向一个txt文件。
+11. 整合包翻译版本（`modPackTranslationVersion`）：整合包汉化本地版本号。
+12. 发送知识的时间间隔（分钟）（`tipsMinutes`）：用于知识显示功能，可配置显示的时间间隔，单位为分钟。
+13. 下载资源包的链接（`translationPackUrl`）：填写一个汉化资源包下载链接，但不包括文件名及其后缀。如：`https://cdn.modrinth.com/data/IDWIdXwS/versions/V5YtW17O/VM汉化组模组汉化包1.20.zip` 你只需要填写 `https://cdn.modrinth.com/data/IDWIdXwS/versions/V5YtW17O/`
+14. 资源包的文件名（`translationPackName`）：填写汉化资源包名称，不要带文件名后缀。如：VM汉化组模组汉化包1.20
+15. 玩家对应称呼的链接（`nameUrl`）：前置为检测玩家名称彩蛋（`playerNameCheck`）必须开启。用于定义称呼玩家的名称，必须为一个指向json文件的链接。如：`https://vmct-cn.top/name.json`。格式为`"玩家名": "称呼"`

others/vmtu/index.md

@@ -0,0 +1,23 @@
+<div align="center"> 
+   <img height="128px" width="128px" alt="logo" src="https://cdn.modrinth.com/data/wvCSIW08/c6d47a463a59dd38faf9777c17c634f514fa5b1e.png"/> 
+   <h1>VM汉化更新模组文档</h1>
+</div> 
+
+## 功能
+1. 在汉化发布新版本时会在游戏里通知玩家去下载更新。
+2. 可配置默认每25分钟在聊天栏发送一条知识。内容包括但不限于汉化组冷知识，汉字易错读音和MC冷知识等。
+3. 可配置每次启动时自动下载并启用VM汉化组通用模组汉化资源包。
+4. 如果玩家已经下载资源包且发生错误未启用，会在聊天框提示玩家在选项->资源包中手动启用。
+5. 如果玩家名是Zi__Min，会在每次进入世界时发送`欢迎来到籽岷的Minecraft游戏世界！`，且称呼改为岷叔。
+6. 可配置自动修改游戏语言，当安装[Stenographer](https://modrinth.com/mod/stenographer)模组后将禁用。
+
+## 支持版本
+见[支持版本](support)
+
+## 使用文档
+见[使用与配置文件](config)
+
+## 其他
+特别感谢TexTrue跨加载器重构，以及Lichiiiiiii修复部分bug！
+
+本模组使用MIT许可证

others/vmtu/support.md

@@ -0,0 +1,9 @@
+| 模组加载器        | 支持的Minecraft版本                    |
+| ---------------- | ------------------------------------- |
+| Forge            | 1.12/1.16.5/1.18~1.20.4①              |
+| NeoForge         | 1.20~1.20.6                           |
+| Fabric/Quilt②    | 1.16.5~1.20.6                         |
+
+注①：对于Forge在1.20.5及以上，由于模组依赖Cloth config API已不支持，故本模组也不支持。
+
+注②：我们不提供专门的代码支持，但可以在Quilt上正常工作。

package.json

@@ -7,8 +7,8 @@
     "build": "vitepress build --minify"
   },
   "dependencies": {
-    "@vueuse/core": "^10.9.0",
-    "vitepress": "^1.2.2",
+    "@vueuse/core": "^10.10.0",
+    "vitepress": "^1.2.3",
     "vue": "^3.4.27"
   }
 }