From a8692c3893ab13d48056634ee9b9bbf937db0d6f Mon Sep 17 00:00:00 2001 From: 3gf8jv4dv <3gf8jv4dv@gmail.com> Date: Tue, 3 Feb 2026 20:34:15 +0800 Subject: [PATCH] docs: add tradchinese variant to contribution guide (#5401) --- docs/Contributing.md | 2 +- docs/Contributing_zh.md | 2 +- docs/Contributing_zh_Hant.md | 105 +++++++++++++++++++++++++++++++++++ docs/README_lzh.md | 6 +- docs/README_zh_Hant.md | 6 +- 5 files changed, 113 insertions(+), 8 deletions(-) create mode 100644 docs/Contributing_zh_Hant.md diff --git a/docs/Contributing.md b/docs/Contributing.md index ddf2b0ead..cd4a8bfcc 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -1,7 +1,7 @@ # Contributing Guide -**English** | [中文](Contributing_zh.md) +**English** | 中文 ([简体](Contributing_zh.md), [繁體](Contributing_zh_Hant.md)) ## Build HMCL diff --git a/docs/Contributing_zh.md b/docs/Contributing_zh.md index 825865956..d549b9cd2 100644 --- a/docs/Contributing_zh.md +++ b/docs/Contributing_zh.md @@ -1,7 +1,7 @@ # 贡献指南 -[English](Contributing.md) | **中文** +[English](Contributing.md) | **中文** (**简体**, [繁體](Contributing_zh_Hant.md)) ## 构建 HMCL diff --git a/docs/Contributing_zh_Hant.md b/docs/Contributing_zh_Hant.md new file mode 100644 index 000000000..200a81461 --- /dev/null +++ b/docs/Contributing_zh_Hant.md @@ -0,0 +1,105 @@ +# 貢獻指南 + + +[English](Contributing.md) | **中文** ([简体](Contributing_zh.md), **繁體**) + + +## 構建 HMCL + +### 環境需求 + +構建 HMCL 啟動器需要安裝 JDK 17 (或更高版本)。你可以從此處下載它: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts)。 + +在安裝 JDK 後，請確保 `JAVA_HOME` 環境變數指向符合需求的 JDK 目錄。 +你可以這樣查看 `JAVA_HOME` 指向的 JDK 版本: + +
+Windows + +PowerShell: +``` +PS > & "$env:JAVA_HOME/bin/java.exe" -version +openjdk version "25" 2025-09-16 LTS +OpenJDK Runtime Environment (build 25+37-LTS) +OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing) +``` + +
+ +
+Linux/FreeBSD + +``` +> $JAVA_HOME/bin/java -version +openjdk version "25" 2025-09-16 LTS +OpenJDK Runtime Environment (build 25+37-LTS) +OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing) +``` + +
+ +
+macOS + +``` +> /usr/libexec/java_home --exec java -version +openjdk version "25" 2025-09-16 LTS +OpenJDK Runtime Environment (build 25+37-LTS) +OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing) +``` + +
+ +### 獲取 HMCL 原始碼 + +- 透過 [Git](https://git-scm.com/downloads) 可以獲取最新原始碼: + ```shell + git clone https://github.com/HMCL-dev/HMCL.git + cd HMCL + ``` +- 從 [GitHub Release 頁面](https://github.com/HMCL-dev/HMCL/releases)可以手動下載特定版本的原始碼。 + +### 構建 HMCL + +想要構建 HMCL，請切換到 HMCL 專案的根目錄下，並執行以下指令: + +```shell +./gradlew clean makeExecutables +``` + +構建出的 HMCL 程式檔位於根目錄下的 `HMCL/build/libs` 子目錄中。 + +## 除錯選項 + +> [!WARNING] +> 本文介紹的是 HMCL 的內部功能，我們不保證這些功能的穩定性，並且隨時可能修改或刪除這些功能。 +> +> 使用這些功能時請務必小心，錯誤地使用這些功能可能會導致 HMCL 行為異常甚至崩潰。 + +HMCL 提供了一系列除錯選項，用於控制啟動器的行為。 + +這些選項可以透過環境變數或 JVM 參數設定。如果兩者同時存在，那麼 JVM 參數會覆蓋環境變數的設定。 + +| 環境變數 | JVM 參數 | 功能 | 預設值 | 額外說明 | +|-----------------------------|----------------------------------------------|--------------------------------|-------------------------------------------------------------------------------------------------------------|--------------| +| `HMCL_JAVA_HOME` | | 設定用於開啟 HMCL 的 Java | | 僅對 exe/sh 生效 | +| `HMCL_JAVA_OPTS` | | 設定開啟 HMCL 時的預設 JVM 參數 | | 僅對 exe/sh 生效 | +| `HMCL_FORCE_GPU` | | 設定是否強制使用 GPU 加速繪製 | `false` | +| `HMCL_ANIMATION_FRAME_RATE` | | 設定 HMCL 的動畫幀率 | `60` | | +| `HMCL_LANGUAGE` | | 設定 HMCL 的預設語言 | 使用系統預設語言 | +| | `-Dhmcl.dir=` | 設定 HMCL 的目前資料存放位置 | `./.hmcl` | | +| | `-Dhmcl.home=` | 設定 HMCL 的使用者資料存放位置 | Windows: `%APPDATA%\.hmcl`
Linux/BSD: `$XDG_DATA_HOME/hmcl`
macOS: `~Library/Application Support/hmcl` | | +| | `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時不檢查程式完整性 | | | +| | `-Dhmcl.bmclapi.override=` | 設定 BMCLAPI 的 API Root | `https://bmclapi2.bangbang93.com` | | +| | `-Dhmcl.discoapi.override=` | 設定 foojay Disco API 的 API Root | `https://api.foojay.io/disco/v3.0` | +| `HMCL_FONT` | `-Dhmcl.font.override=` | 設定 HMCL 預設字體 | 使用系統預設字體 | | +| | `-Dhmcl.update_source.override=` | 設定 HMCL 更新來源 | `https://hmcl.huangyuhui.net/api/update_link` | | +| | `-Dhmcl.authlibinjector.location=` | 設定 authlib-injector JAR 檔的位置 | 使用 HMCL 內置的 authlib-injector | | +| | `-Dhmcl.openjfx.repo=` | 添加用於下載 OpenJFX 的自訂 Maven 倉庫 | | | +| | `-Dhmcl.native.encoding=` | 設定原生編碼 | 使用系統的本機編碼 | | +| | `-Dhmcl.microsoft.auth.id=` | 設定 Microsoft OAuth App ID | 使用 HMCL 內建的 Microsoft OAuth App ID | | +| | `-Dhmcl.microsoft.auth.secret=` | 設定 Microsoft OAuth App 金鑰 | 使用 HMCL 內建的 Microsoft OAuth App 金鑰 | | +| | `-Dhmcl.curseforge.apikey=` | 設定 CurseForge API 金鑰 | 使用 HMCL 內建的 CurseForge API 金鑰 | | +| | `-Dhmcl.native.backend=` | 設定 HMCL 使用的本機後端 | `auto` | +| | `-Dhmcl.hardware.fastfetch=` | 設定是否使用 fastfetch 檢測硬體資訊 | `true` | + diff --git a/docs/README_lzh.md b/docs/README_lzh.md index 743905b67..27a5720df 100644 --- a/docs/README_lzh.md +++ b/docs/README_lzh.md @@ -54,10 +54,10 @@ HMCL 為社群所驅之開源計畫，迎諸君貢獻其碼，或建言於此。 - 於 GitHub 上[創建 Issue](https://github.com/HMCL-dev/HMCL/issues/new/choose)，以報告謬誤，或請求功能。 - 於 GitHub 上 Fork 倉庫，並[提交 Pull Request](https://github.com/HMCL-dev/HMCL/compare)，以貢獻其碼。 -參與貢獻之前，請閱[貢獻指南](./Contributing_zh.md)，其中載有如下： +參與貢獻之前，請閱[貢獻指南](./Contributing_zh_Hant.md)，其中載有如下： -- [如何自源碼構建並運行 HMCL](./Contributing_zh.md#构建-hmcl) -- [以調試選項調整 HMCL 之行為](./Contributing_zh.md#调试选项) +- [如何自源碼構建並運行 HMCL](./Contributing_zh_Hant.md#構建-hmcl) +- [以調試選項調整 HMCL 之行為](./Contributing_zh_Hant.md#除錯選項) ## 貢獻者 diff --git a/docs/README_zh_Hant.md b/docs/README_zh_Hant.md index 453262f79..2a082bf2d 100644 --- a/docs/README_zh_Hant.md +++ b/docs/README_zh_Hant.md @@ -53,10 +53,10 @@ HMCL 是一個社區驅動的開源項目，歡迎任何人參與貢獻程式碼 - 通過在 GitHub 上[創建 Issue](https://github.com/HMCL-dev/HMCL/issues/new/choose) 來報告 Bug 或提出功能請求。 - 通過在 GitHub 上 Fork 倉庫並[提交 Pull Request](https://github.com/HMCL-dev/HMCL/compare) 來貢獻程式碼。 -在參與貢獻前，請閱讀[貢獻指南](./Contributing_zh.md)，其中包含以下內容： +在參與貢獻前，請閱讀[貢獻指南](./Contributing_zh_Hant.md)，其中包含以下內容： -- [如何從原始碼構建並運行 HMCL](./Contributing_zh.md#构建-hmcl) -- [通過調試選項調整 HMCL 的行為](./Contributing_zh.md#调试选项) +- [如何從原始碼構建並運行 HMCL](./Contributing_zh_Hant.md#構建-hmcl) +- [通過調試選項調整 HMCL 的行為](./Contributing_zh_Hant.md#除錯選項) ## 貢獻者