mirror of
https://github.com/HMCL-dev/HMCL.git
synced 2024-11-27 06:10:08 +08:00
71 lines
4.3 KiB
Markdown
71 lines
4.3 KiB
Markdown
# ⛏ Hello Minecraft! Launcher 💎
|
||
|
||
[](https://ci.huangyuhui.net/job/HMCL)
|
||
|
||
|
||
[](https://discord.gg/jVvC7HfM6U)
|
||
[](https://docs.hmcl.net/groups.html)
|
||
|
||
[English](README.md) | [简体中文](README_cn.md) | **繁體中文**
|
||
|
||
## 簡介
|
||
|
||
HMCL 是一款開源、跨平臺的 Minecraft 啟動器，支援模組管理、遊戲自訂、遊戲自動安裝 (Forge、NeoForge、Fabric、Quilt、LiteLoader 和 OptiFine)、模組包建立、介面自訂等功能。
|
||
|
||
HMCL 有著強大的跨平臺能力。它不僅支援 Windows、Linux、macOS 等常見的作業系統，同時也支援 x86、ARM、MIPS 和 LoongArch 等不同的 CPU 架構。你可以使用 HMCL 在不同平臺上輕鬆地遊玩 Minecraft。
|
||
|
||
如果你想要了解 HMCL 對不同平臺的支援程度，請參見 [此表格](PLATFORM_tw.md)。
|
||
|
||
## 下載
|
||
|
||
請從 [HMCL 官網](https://hmcl.huangyuhui.net/download) 下載最新版本的 HMCL。
|
||
|
||
你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下載最新版本的 HMCL。
|
||
|
||
雖然並不強制，但仍建議透過 HMCL 官網下載啟動器。
|
||
|
||
## 開源協議
|
||
|
||
該程式在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 開源協議下發布，同時附有以下附加條款。
|
||
|
||
### 附加條款 (依據 GPLv3 開源協議第七條)
|
||
|
||
1. 當你分發該程式的修改版本時，你必須以一種合理的方式修改該程式的名稱或版本號，以示其與原始版本不同。(依據 [GPLv3, 7(c)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374))
|
||
|
||
該程式的名稱及版本號可在 [此處](https://github.com/HMCL-dev/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35) 修改。
|
||
|
||
2. 你不得移除該程式所顯示的版權宣告。(依據 [GPLv3, 7(b)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370))
|
||
|
||
## 貢獻
|
||
|
||
如果你想提交一個 Pull Request，必須遵守如下要求：
|
||
|
||
* IDE：IntelliJ IDEA
|
||
* 編譯器：Java 1.8 或 Java 11+
|
||
* **不要**修改 `gradle` 相關文件
|
||
|
||
### 編譯
|
||
|
||
於項目根目錄執行以下指令：
|
||
|
||
```bash
|
||
./gradlew clean build
|
||
```
|
||
|
||
請確保你至少安裝了含有 JavaFX 8 的 Java。建議使用 Liberica Full JDK 8 或更高版本。
|
||
|
||
## JVM 選項 (用於除錯)
|
||
|
||
| 參數 | 簡介 |
|
||
| -------------------------------------------- | -------------------------------------------------------------------- |
|
||
| `-Dhmcl.home=<path>` | 覆蓋 HMCL 使用者目錄 |
|
||
| `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時繞過本體完整性檢查 |
|
||
| `-Dhmcl.bmclapi.override=<url>` | 覆蓋 BMCLAPI 的 API Root，預設值為 `https://bmclapi2.bangbang93.com` |
|
||
| `-Dhmcl.font.override=<font family>` | 覆蓋字族 |
|
||
| `-Dhmcl.version.override=<version>` | 覆蓋版本號 |
|
||
| `-Dhmcl.update_source.override=<url>` | 覆蓋 HMCL 更新來源 |
|
||
| `-Dhmcl.authlibinjector.location=<path>` | 使用指定的 authlib-injector (而非下載一個) |
|
||
| `-Dhmcl.openjfx.repo=<maven repository url>` | 添加用於下載 OpenJFX 的自訂 Maven 倉庫 |
|
||
| `-Dhmcl.native.encoding=<encoding>` | 覆蓋原生編碼 |
|
||
| `-Dhmcl.microsoft.auth.id=<App ID>` | 覆蓋 Microsoft OAuth App ID |
|
||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | 覆蓋 Microsoft OAuth App 金鑰 | |