mirror/HMCL
2
0
Fork 0
mirror of https://github.com/HMCL-dev/HMCL.git synced 2024-11-21 03:10:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Revise readme and platform docs [skip ci] (#3054)

Browse Source 
* Revise [skip ci]

Squash previous commits.

* Revise [skip ci]

Unify badge style.

* Revise [skip ci]

Change the badge style of QQ group

* Revise [skip ci]

- Add Chinese variants (Traditional, Taiwan)
- Compilation requirements for Java bump to 11+
- Various revisions

* Revise [skip ci]

Fix a link

* Revise [skip ci]

Revert a change

* Revise [skip ci]

* Revise [skip ci]

* Revise [skip ci]
This commit is contained in:
3gf8jv4dv 2024-10-15 18:47:38 +08:00 committed by GitHub
parent 4dce13855a
commit 32c3b694b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 206 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
PLATFORM.md
View File

@ -1,19 +1,19 @@
# Platform Support Status
English | [简体中文](PLATFORM_cn.md)
**English** | [简体中文](PLATFORM_cn.md) | [繁體中文](PLATFORM_tw.md)
| | Windows | Linux | Mac OS | FreeBSD |
|----------------------------|:--------------------------------------------------|:---------------------------|:------------------------------------------------------------------------|:---------------------------|
| | Windows | Linux | macOS | FreeBSD |
| -------------------------- | :----------------------------------------------- | :------------------------ | :--------------------------------------------------------------------- | :------------------------ |
| x86-64 | ✅️ | ✅️ | ✅️ | 👌 (Minecraft 1.13~1.21.1) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.6) | 👌 (Minecraft 1.6~1.18.2)<br/>✅ (Minecraft 1.19+)<br/>✅ (use Rosetta 2) | ❔ |
| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / |
| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / |
| RISC-V 64 | / | 👌 (Minecraft 1.13~1.21.1) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.21.1) | / | / |
| LoongArch64 (Old World) | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.21) | 👌 (Minecraft 1.6~1.18.2)<br/>✅ (Minecraft 1.19+)<br/>✅ (use Rosetta 2) | ❔ |
| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / |
| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / |
| RISC-V 64 | / | 👌 (Minecraft 1.13~1.21.1) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.21.1) | / | / |
| LoongArch64 (Old World) | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |
Legend:
@ -23,18 +23,16 @@ Legend:
* 👌: Supported platforms.
Support is provided by HMCL, tested to work, but may have more issues than a fully supported platform.
Support for versions below Minecraft 1.6 is not guaranteed.
Support is provided by HMCL, tested to work, but may have more issues than a fully supported platform.
Support for versions below Minecraft 1.6 is not guaranteed.
If you encounter a problem that does not exist on fully supported platforms, you can report it to HMCL.
* ❔: Low level supported platforms.
HMCL can run on this platform and has some basic support.
However, launching the game directly is not yet available.
If you want to start the game,
you'll need to get the native libraries needed by Minecraft in other way and specify the native path in the instance settings.
HMCL can run on this platform and has some basic support. However, launching the game directly is not yet available.
If you want to start the game, you will need to get the native libraries needed by Minecraft in other way and specify the native path in the instance settings.
* /: Not applicable.
* `/`: Not applicable.
We have no plans to support these platforms at this time, mainly because we don't have the equipment to test them.
If you can help us adapt, please file a support request via issue.
We have no plans to support these platforms at this time, mainly because we do not have the equipment to test them.
If you can help us adapt, please file a support request via GitHub Issue.

54
PLATFORM_cn.md
View File

@ -1,40 +1,38 @@
# 平台支持状态
[English](PLATFORM.md) | 简体中文
[English](PLATFORM.md) | **简体中文** | [繁體中文](PLATFORM_tw.md)
| | Windows | Linux | Mac OS | FreeBSD |
|----------------------------|:--------------------------------------------------|:---------------------------|:-----------------------------------------------------------------------|:--------------------------|
| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.21.1) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.21) | 👌 (Minecraft 1.6~1.18.2)<br/>✅ (Minecraft 1.19+)<br/>✅ (使用 Rosetta 2) | ❔ |
| ARM32 | /️ | 👌 (Minecraft 1.6~1.20.1) | / | / |
| MIPS64el | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| RISC-V 64 | / | 👌 (Minecraft 1.13~1.21) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.21.1) | / | / |
| LoongArch64 (旧世界) | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |
| | Windows | Linux | macOS | FreeBSD |
| -------------------------- | :----------------------------------------------- | :------------------------ | :---------------------------------------------------------------------- | :----------------------- |
| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.21.1) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.21) | 👌 (Minecraft 1.6~1.18.2)<br/>✅ (Minecraft 1.19+)<br/>✅ (使用 Rosetta 2) | ❔ |
| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / |
| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / |
| RISC-V 64 | / | 👌 (Minecraft 1.13~1.21.1) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.21.1) | / | / |
| LoongArch64 (旧世界) | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |
图例:
图例：
* ✅: 官方支持的平台.
* ✅: 官方支持的平台
受 Mojang 官方支持. 在游戏中遇到的问题应该直接向 Mojang 反馈.
受 Mojang 官方支持。在游戏中遇到的问题应该直接向 Mojang 反馈。
* 👌: 支持的平台.
* 👌: 支持的平台
由 HMCL 提供支持, 经过测试可以正常运行, 但可能比得到全面支持的平台有更多问题.
不保证支持 Minecraft 1.6 以下的版本.
如果你遇到在得到全面支持的平台上不存在的问题, 可以向 HMCL 反馈.
由 HMCL 提供支持，经过测试可以正常运行，但可能比得到全面支持的平台有更多问题。
不保证支持 Minecraft 1.6 以下的版本。
如果你遇到在得到全面支持的平台上不存在的问题，可以向 HMCL 反馈。
* ❔: 低级别支持的平台.
* ❔: 低级别支持的平台
HMCL 可以在这个平台上运行, 并且有一些基本的支持.
但是, 还不能正常地启动游戏.
如果你想正常启动游戏,
则需要通过其他方式获得游戏所需的本地库(LWJGL), 并在版本设置中指定本地库路径.
HMCL 可以在这个平台上运行，并且有一些基本的支持。但是，还不能正常地启动游戏。
如果你想正常启动游戏，则需要通过其他方式获得游戏所需的本地库 (LWJGL)，并在（全局）游戏设置中指定本地库路径。
* /: 不支持的平台.
* `/`: 不支持的平台
我们目前还没有打算支持这些平台, 主要是因为我们没有测试这些平台的设备.
如果你能帮助我们进行测试, 请通过提交 Issue 提出支持请求.
我们目前还没有打算支持这些平台，主要是因为我们没有测试这些平台的设备。
如果你能帮助我们进行测试，请通过提交 Issue 提出支持请求。

38
PLATFORM_tw.md Normal file
View File

@ -0,0 +1,38 @@
# 平臺支援狀態
[English](PLATFORM.md) | [简体中文](PLATFORM_cn.md) | **繁體中文**
| | Windows | Linux | macOS | FreeBSD |
| -------------------------- | :----------------------------------------------- | :------------------------ | :---------------------------------------------------------------------- | :----------------------- |
| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.21.1) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.21) | 👌 (Minecraft 1.6~1.18.2)<br/>✅ (Minecraft 1.19+)<br/>✅ (使用 Rosetta 2) | ❔ |
| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / |
| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / |
| RISC-V 64 | / | 👌 (Minecraft 1.13~1.21.1) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.21.1) | / | / |
| LoongArch64 (舊世界) | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |
圖例：
* ✅: 官方支援的平臺
受 Mojang 官方支援。在遊戲中遇到的問題應該直接向 Mojang 回報。
* 👌: 支援的平臺
由 HMCL 提供支援，經過測試可以正常執行，但可能比得到全面支援的平臺有更多問題。
不保證支援 Minecraft 1.6 以下的版本。
如果你遇到在得到全面支援的平臺上不存在的問題，可以向 HMCL 回報。
* ❔: 低級別支援的平臺
HMCL 可以在這個平臺上執行，並且有一些基本的支援。但是，還不能正常地啟動遊戲。
如果你想正常啟動遊戲，則需要透過其他方式獲得遊戲所需的本機庫 (LWJGL)，並在（全域）遊戲設定中指定本機庫路徑。
* `/`: 不支援的平臺
我們目前還沒有打算支援這些平臺，主要是因為我們沒有測試這些平臺的裝置。
如果你能幫助我們進行測試，請透過提交 Issue 提出支援請求。

43
README.md
View File

@ -1,21 +1,18 @@
# ⛏ Hello Minecraft! Launcher 💎
[![Build Status](https://ci.huangyuhui.net/job/HMCL/badge/icon?.svg)](https://ci.huangyuhui.net/job/HMCL)
![Downloads](https://img.shields.io/github/downloads/huanghongxun/HMCL/total)
![Stars](https://img.shields.io/github/stars/huanghongxun/HMCL)
![Downloads](https://img.shields.io/github/downloads/huanghongxun/HMCL/total?style=flat)
![Stars](https://img.shields.io/github/stars/huanghongxun/HMCL?style=flat)
[![Discord](https://img.shields.io/discord/995291757799538688.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/jVvC7HfM6U)
[![QQ Group](https://img.shields.io/badge/QQ-HMCL-brightgreen)](https://docs.hmcl.net/groups.html)
[![QQ Group](https://img.shields.io/badge/QQ-HMCL-bright?label=&logo=tencentqq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html)
English | [中文](README_cn.md)
**English** | [简体中文](README_cn.md) | [繁體中文](README_tw.md)
## Introduction
HMCL is a cross-platform Minecraft launcher which supports Mod Management, Game Customizing, Auto Installing (Forge, NeoForge, Fabric, Quilt, LiteLoader and OptiFine), Modpack Creating, UI Customization, and more.
HMCL is a cross-platform Minecraft launcher which supports Mod Management, Game Customizing, ModLoader Installing (Forge, NeoForge, Fabric, Quilt, LiteLoader and OptiFine), Modpack Creating, UI Customization, and more.
HMCL has amazing cross-platform capabilities.
It can not only run on different operating systems such as Windows, Linux, and macOS,
but also supports multiple CPU architectures such as x86, arm, mips, and loongarch.
You can easily play Minecraft on different platforms through HMCL.
HMCL has amazing cross-platform capabilities. It can not only run on different operating systems such as Windows, Linux, and macOS, but also supports multiple CPU architectures such as x86, ARM, MIPS, and LoongArch. You can easily play Minecraft on different platforms through HMCL.
For systems and CPU architectures supported by HMCL, see [this table](PLATFORM.md).
@ -43,7 +40,7 @@ The software is distributed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.h
If you want to submit a pull request, there are some requirements:
* IDE: Intellij IDEA
* IDE: IntelliJ IDEA
* Compiler: Java 1.8 or Java 11+
* Do NOT modify `gradle` files
@ -59,16 +56,16 @@ Make sure you have Java installed with JavaFX 8 at least. Liberica Full JDK 8 or
## JVM Options (for debugging)
| Parameter | Description |
|----------------------------------------------|------------------------------------------------------------------------------------------------|
| `-Dhmcl.home=<path>` | Override HMCL directory. |
| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for update. |
| `-Dhmcl.bmclapi.override=<url>` | Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com`. |
| `-Dhmcl.font.override=<font family>` | Override font family. |
| `-Dhmcl.version.override=<version>` | Override the version number. |
| `-Dhmcl.update_source.override=<url>` | Override the update source for HMCL itself. |
| `-Dhmcl.authlibinjector.location=<path>` | Use specified authlib-injector (instead of downloading one). |
| `-Dhmcl.openjfx.repo=<maven repository url>` | Add custom Maven repository for download OpenJFX. |
| `-Dhmcl.native.encoding=<encoding>` | Override the native encoding. |
| `-Dhmcl.microsoft.auth.id=<App ID>` | Override Microsoft OAuth App ID. |
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | Override Microsoft OAuth App secret. |
| Parameter | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `-Dhmcl.home=<path>` | Override HMCL directory |
| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for update |
| `-Dhmcl.bmclapi.override=<url>` | Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com` |
| `-Dhmcl.font.override=<font family>` | Override font family |
| `-Dhmcl.version.override=<version>` | Override the version number |
| `-Dhmcl.update_source.override=<url>` | Override the update source for HMCL itself |
| `-Dhmcl.authlibinjector.location=<path>` | Use specified authlib-injector (instead of downloading one) |
| `-Dhmcl.openjfx.repo=<maven repository url>` | Add custom Maven repository for download OpenJFX |
| `-Dhmcl.native.encoding=<encoding>` | Override the native encoding |
| `-Dhmcl.microsoft.auth.id=<App ID>` | Override Microsoft OAuth App ID |
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | Override Microsoft OAuth App secret |

65
README_cn.md
View File

@ -1,72 +1,71 @@
# ⛏ Hello Minecraft! Launcher 💎
[![Build Status](https://ci.huangyuhui.net/job/HMCL/badge/icon?.svg)](https://ci.huangyuhui.net/job/HMCL)
![Downloads](https://img.shields.io/github/downloads/huanghongxun/HMCL/total)
![Stars](https://img.shields.io/github/stars/huanghongxun/HMCL)
![Downloads](https://img.shields.io/github/downloads/huanghongxun/HMCL/total?style=flat)
![Stars](https://img.shields.io/github/stars/huanghongxun/HMCL?style=flat)
[![Discord](https://img.shields.io/discord/995291757799538688.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/jVvC7HfM6U)
[![QQ Group](https://img.shields.io/badge/QQ-HMCL-brightgreen)](https://docs.hmcl.net/groups.html)
[![QQ Group](https://img.shields.io/badge/QQ-HMCL-bright?label=&logo=tencentqq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html)
[English](README.md) | 中文
[English](README.md) | **简体中文** | [繁體中文](README_tw.md)
## 简介
HMCL 是一款跨平台 Minecraft 启动器, 支持 Mod 管理, 游戏自定义, 游戏自动安装 (Forge, NeoForge, Fabric, Quilt, LiteLoader 与 OptiFine), 整合包创建, 界面自定义等功能.
HMCL 是一款跨平台 Minecraft 启动器，支持模组管理、游戏自定义、游戏自动安装 (Forge、NeoForge、Fabric、Quilt、LiteLoader 和 OptiFine)、整合包创建、界面自定义等功能。
HMCL 有着强大的跨平台能力. 它不仅支持 Windows、Linux、macOS 等常见的操作系统，同时也支持 x86、ARM、MIPS 和 LoongArch 等不同的 CPU 架构.
您可以使用 HMCL 在不同平台上轻松的游玩 Minecraft.
HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS 等常见的操作系统，同时也支持 x86、ARM、MIPS 和 LoongArch 等不同的 CPU 架构。你可以使用 HMCL 在不同平台上轻松地游玩 Minecraft。
如果您想要了解 HMCL 对不同平台的支持程度，请参见[此表格](PLATFORM_cn.md).
如果你想要了解 HMCL 对不同平台的支持程度，请参见 [此表格](PLATFORM_cn.md)。
## 下载
请从 [HMCL 官网](https://hmcl.huangyuhui.net/download) 下载最新版本的 HMCL.
请从 [HMCL 官网](https://hmcl.huangyuhui.net/download) 下载最新版本的 HMCL。
你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下载最新版本的 HMCL.
你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下载最新版本的 HMCL。
虽然并不强制, 但仍建议通过 HMCL 官网下载启动器.
虽然并不强制，但仍建议通过 HMCL 官网下载启动器。
## 开源协议
该程序在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 开源协议下发布, 同时附有附加条款.
该程序在 [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))
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)修改.
该程序的名称及版本号可在 [此处](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))
2. 你不得移除该程序所显示的版权声明。(依据 [GPLv3, 7(b)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370))
## 贡献
如果您想提交一个 Pull Request, 必须遵守如下要求:
如果你想提交一个 Pull Request，必须遵守如下要求：
* IDE: Intellij IDEA
* 编译器: Java 1.8 或 Java 11+
* IDE：IntelliJ IDEA
* 编译器：Java 1.8 或 Java 11+
* **不要**修改 `gradle` 相关文件
### 编译
于项目根目录执行以下命令:
于项目根目录执行以下命令：
```bash
./gradlew clean build
```
请确保您至少安装了含有 JavaFX 8 的 Java. 建议使用 Liberica Full JDK 8 或更高版本.
请确保你至少安装了含有 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 密钥. |
| 参数 | 简介 |
| -------------------------------------------- | -------------------------------------------------------------------- |
| `-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 密钥 |

71
README_tw.md Normal file
View File

@ -0,0 +1,71 @@
# ⛏ Hello Minecraft! Launcher 💎
[![Build Status](https://ci.huangyuhui.net/job/HMCL/badge/icon?.svg)](https://ci.huangyuhui.net/job/HMCL)
![Downloads](https://img.shields.io/github/downloads/huanghongxun/HMCL/total?style=flat)
![Stars](https://img.shields.io/github/stars/huanghongxun/HMCL?style=flat)
[![Discord](https://img.shields.io/discord/995291757799538688.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/jVvC7HfM6U)
[![QQ Group](https://img.shields.io/badge/QQ-HMCL-bright?label=&logo=tencentqq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](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 金鑰 |