mirror of
https://github.com/HMCL-dev/HMCL.git
synced 2024-12-21 07:00:22 +08:00
64 lines
4.7 KiB
Markdown
64 lines
4.7 KiB
Markdown
# ⛏ Hello Minecraft! Launcher 💎
|
|
[](https://ci.huangyuhui.net/job/HMCL)
|
|
|
|
|
|
[](https://discord.gg/jVvC7HfM6U)
|
|
[](https://kook.top/Kx7n3t)
|
|
|
|
[English](README.md) | 中文
|
|
|
|
## 简介
|
|
HMCL 是一款跨平台 Minecraft 启动器, 支持 Mod 管理, 游戏自定义, 游戏自动安装 (Forge, Fabric, Quilt, LiteLoader 与 OptiFine), 模组包创建, 界面自定义等功能.
|
|
|
|
HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS 等常见的操作系统，同时也支持 x86、ARM、MIPS 和 LoongArch 等不同的 CPU 架构。
|
|
您可以使用 HMCL 在不同平台上轻松的游玩 Minecraft。
|
|
|
|
如果您想要了解 HMCL 对不同平台的支持程度，请参见[此表格](PLATFORM.md)。
|
|
|
|
## 下载
|
|
请从 [HMCL 官网](https://hmcl.huangyuhui.net/download)下载最新版本的 HMCL.
|
|
|
|
注: 在 GitHub 发布的最新版 HMCL 为测试版, 与官网上发布的正式版相比, 它们包含额外的测试功能. 但是, 它们相较于正式版更不稳定, 您更有可能在使用测试版的过程中遇到 Bug 或意外问题.
|
|
|
|
虽然并不强制, 但仍建议通过 HMCL 官网下载启动器.
|
|
|
|
## 开源协议
|
|
该程序在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 开源协议下发布, 同时附有附加条款.
|
|
|
|
### 附加条款 (依据 GPLv3 开源协议第七条)
|
|
1. 当您分发该程序的修改版本时, 您必须以一种合理的方式修改该程序的名称或版本号, 以示其与原始版本不同. (依据 [GPLv3, 7(c)](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374))
|
|
|
|
该程序的名称及版本号可在[此处](https://github.com/huanghongxun/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35)修改.
|
|
|
|
2. 您不得移除该程序所显示的版权声明. (依据 [GPLv3, 7(b)](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370))
|
|
|
|
## 贡献
|
|
如果您想提交一个 Pull Request, 必须遵守如下要求:
|
|
* IDE: Intellij IDEA
|
|
* 编译器: Java 1.8
|
|
* **不要**修改 `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=<version>` | 覆盖 BMCLAPI 的 API Root, 默认值为 `https://bmclapi2.bangbang93.com`. 例如 `https://download.mcbbs.net`. |
|
|
| `-Dhmcl.font.override=<font family>` | 覆盖字族. |
|
|
| `-Dhmcl.version.override=<version>` | 覆盖版本号. |
|
|
| `-Dhmcl.update_source.override=<url>` | 覆盖更新源. |
|
|
| `-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 密钥. |
|