From 5f0b4715245df6bb28c99d3a54976608d62fac8f Mon Sep 17 00:00:00 2001 From: 3gf8jv4dv <158490944+3gf8jv4dv@users.noreply.github.com> Date: Sat, 18 May 2024 02:04:52 +0000 Subject: [PATCH] Revise readme and platform docs [skip ci] --- PLATFORM.md | 44 ++++++++++++++++++------------------- PLATFORM_cn.md | 52 +++++++++++++++++++++----------------------- README.md | 33 +++++++++++++--------------- README_cn.md | 59 +++++++++++++++++++++++++------------------------- 4 files changed, 90 insertions(+), 98 deletions(-) diff --git a/PLATFORM.md b/PLATFORM.md index af68e418cc..ce996003b2 100644 --- a/PLATFORM.md +++ b/PLATFORM.md @@ -1,39 +1,37 @@ # Platform Support Status -English | [简体中文](PLATFORM_cn.md) +**English** | [简体中文](PLATFORM_cn.md) -| | Windows | Linux | Mac OS | FreeBSD | -|----------------------------|:--------------------------------------------------|:---------------------------|:------------------------------------------------------------------------|:---------------------------| +| | Windows | Linux | macOS | FreeBSD | +| -------------------------- | :----------------------------------------------- | :------------------------ | :--------------------------------------------------------------------- | :------------------------ | | x86-64 | ✅️ | ✅️ | ✅️ | 👌 (Minecraft 1.13~1.20.4) | -| x86 | ✅️ | ✅️ | / | / | -| ARM64 | 👌 (Minecraft 1.8~1.18.2)
✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (Minecraft 1.6~1.18.2)
✅ (Minecraft 1.19+)
✅ (use Rosetta 2) | ❔ | -| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / | -| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / | -| RISC-V 64 | / | 👌 (Minecraft 1.13~1.20.4) | / | / | -| LoongArch64 | / | 👌 (Minecraft 1.6~1.20.1) | / | / | -| PowerPC-64 (Little-Endian) | / | ❔ | / | / | -| S390x | / | ❔ | / | / | +| x86 | ✅️ | ✅️ | / | / | +| ARM64 | 👌 (Minecraft 1.8~1.18.2)
✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (Minecraft 1.6~1.18.2)
✅ (Minecraft 1.19+)
✅ (use Rosetta 2) | ❔ | +| ARM32 | /️ | 👌 (Minecraft 1.8~1.20.1) | / | / | +| MIPS64el | / | 👌 (Minecraft 1.8~1.20.1) | / | / | +| RISC-V 64 | / | 👌 (Minecraft 1.13~1.20.4) | / | / | +| LoongArch64 | / | 👌 (Minecraft 1.6~1.20.1) | / | / | +| PowerPC-64 (Little-Endian) | / | ❔ | / | / | +| S390x | / | ❔ | / | / | Legend: -* ✅: Official supported platform. +* `✅` Official supported platform. Fully supported by Mojang official. Problems encountered in the game should be directly reported to the Mojang. -* 👌: Supported platforms. +* `👌` 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. +* `❔` 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 Issues. diff --git a/PLATFORM_cn.md b/PLATFORM_cn.md index 8150c26ea2..3385144a40 100644 --- a/PLATFORM_cn.md +++ b/PLATFORM_cn.md @@ -1,39 +1,37 @@ # 平台支持状态 -[English](PLATFORM.md) | 简体中文 +[English](PLATFORM.md) | **简体中文** -| | Windows | Linux | Mac OS | FreeBSD | -|------------------|:---------------------------------------------------|:---------------------------|:-----------------------------------------------------------------------|:--------------------------| -| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.20.4) | -| x86 | ✅️ | ✅️ | / | / | -| ARM64 | 👌 (Minecraft 1.8~1.18.2)
✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (Minecraft 1.6~1.18.2)
✅ (Minecraft 1.19+)
✅ (使用 Rosetta 2) | ❔ | -| ARM32 | /️ | 👌 (Minecraft 1.6~1.20.1) | / | / | -| MIPS64el | / | 👌 (Minecraft 1.6~1.20.1) | / | / | -| RISC-V 64 | / | 👌 (Minecraft 1.13~1.20.4) | / | / | -| LoongArch64 | / | 👌 (Minecraft 1.6~1.20.1) | / | / | -| PowerPC-64 (小端序) | / | ❔ | / | / | -| S390x | / | ❔ | / | / | +| | Windows | Linux | macOS | FreeBSD | +| ------------------- | :----------------------------------------------- | :------------------------ | :---------------------------------------------------------------------- | :----------------------- | +| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.20.4) | +| x86 | ✅️ | ✅️ | / | / | +| ARM64 | 👌 (Minecraft 1.8~1.18.2)
✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (Minecraft 1.6~1.18.2)
✅ (Minecraft 1.19+)
✅ (使用 Rosetta 2) | ❔ | +| ARM32 | /️ | 👌 (Minecraft 1.6~1.20.1) | / | / | +| MIPS64el | / | 👌 (Minecraft 1.6~1.20.1) | / | / | +| RISC-V 64 | / | 👌 (Minecraft 1.13~1.20.4) | / | / | +| LoongArch64 | / | 👌 (Minecraft 1.6~1.20.1) | / | / | +| PowerPC-64 (小端序) | / | ❔ | / | / | +| S390x | / | ❔ | / | / | -图例: +图例： -* ✅: 官方支持的平台. +* `✅` 官方支持的平台 - 受 Mojang 官方支持. 在游戏中遇到的问题应该直接向 Mojang 反馈. + 受 Mojang 官方支持。在游戏中遇到的问题应该直接向 Mojang 反馈。 -* 👌: 支持的平台. +* `👌` 支持的平台 - 由 HMCL 提供支持, 经过测试可以正常运行, 但可能比得到全面支持的平台有更多问题. - 不保证支持 Minecraft 1.6 以下的版本. - 如果你遇到在得到全面支持的平台上不存在的问题, 可以向 HMCL 反馈. + 由 HMCL 提供支持, 经过测试可以正常运行，但可能比得到全面支持的平台有更多问题。 + 不保证支持 Minecraft 1.6 以下的版本。 + 如果你遇到在得到全面支持的平台上不存在的问题，可以向 HMCL 反馈。 -* ❔: 低级别支持的平台. +* `❔` 低级别支持的平台 - HMCL 可以在这个平台上运行, 并且有一些基本的支持. - 但是, 还不能正常地启动游戏. - 如果你想正常启动游戏, - 则需要通过其他方式获得游戏所需的本地库(LWJGL), 并在版本设置中指定本地库路径. + HMCL 可以在这个平台上运行，并且有一些基本的支持。但是，还不能正常地启动游戏。 + 如果你想正常启动游戏，则需要通过其他方式获得游戏所需的本地库 (LWJGL)，并在版本设置中指定本地库路径。 -* /: 不支持的平台. +* `／` 不支持的平台 - 我们目前还没有打算支持这些平台, 主要是因为我们没有测试这些平台的设备. - 如果你能帮助我们进行测试, 请通过提交 Issue 提出支持请求. + 我们目前还没有打算支持这些平台，主要是因为我们没有测试这些平台的设备。 + 如果你能帮助我们进行测试，请通过提交 Issues 提出支持请求。 diff --git a/README.md b/README.md index 930a1cc654..3a277152c7 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,13 @@ [![KOOK](https://img.shields.io/badge/KOOK-HMCL-brightgreen)](https://kook.top/Kx7n3t) [![QQ Group](https://img.shields.io/badge/QQ-HMCL-brightgreen)](https://docs.hmcl.net/groups.html) -English | [中文](README_cn.md) +**English** | [简体中文](README_cn.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 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). @@ -60,16 +57,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=` | Override HMCL directory. | -| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for update. | -| `-Dhmcl.bmclapi.override=` | Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com`. | -| `-Dhmcl.font.override=` | Override font family. | -| `-Dhmcl.version.override=` | Override the version number. | -| `-Dhmcl.update_source.override=` | Override the update source for HMCL itself. | -| `-Dhmcl.authlibinjector.location=` | Use specified authlib-injector (instead of downloading one). | -| `-Dhmcl.openjfx.repo=` | Add custom Maven repository for download OpenJFX. | -| `-Dhmcl.native.encoding=` | Override the native encoding. | -| `-Dhmcl.microsoft.auth.id=` | Override Microsoft OAuth App ID. | -| `-Dhmcl.microsoft.auth.secret=` | Override Microsoft OAuth App secret. | +| Parameter | Description | +| -------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `-Dhmcl.home=` | Override HMCL directory | +| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for update | +| `-Dhmcl.bmclapi.override=` | Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com` | +| `-Dhmcl.font.override=` | Override font family | +| `-Dhmcl.version.override=` | Override the version number | +| `-Dhmcl.update_source.override=` | Override the update source for HMCL itself | +| `-Dhmcl.authlibinjector.location=` | Use specified authlib-injector (instead of downloading one) | +| `-Dhmcl.openjfx.repo=` | Add custom Maven repository for download OpenJFX | +| `-Dhmcl.native.encoding=` | Override the native encoding | +| `-Dhmcl.microsoft.auth.id=` | Override Microsoft OAuth App ID | +| `-Dhmcl.microsoft.auth.secret=` | Override Microsoft OAuth App secret | diff --git a/README_cn.md b/README_cn.md index 7bb8ca4a03..207829945f 100644 --- a/README_cn.md +++ b/README_cn.md @@ -7,67 +7,66 @@ [![KOOK](https://img.shields.io/badge/KOOK-HMCL-brightgreen)](https://kook.top/Kx7n3t) [![QQ Group](https://img.shields.io/badge/QQ-HMCL-brightgreen)](https://docs.hmcl.net/groups.html) -[English](README.md) | 中文 +[English](README.md) | **简体中文** ## 简介 -HMCL 是一款跨平台 Minecraft 启动器, 支持 Mod 管理, 游戏自定义, 游戏自动安装 (Forge, NeoForge, Fabric, Quilt, LiteLoader 与 OptiFine), 整合包创建, 界面自定义等功能. +HMCL 是一款跨平台 Minecraft 启动器，支持 Mod 管理、游戏自定义、游戏自动安装 (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=` | 覆盖 HMCL 数据文件夹. | -| `-Dhmcl.self_integrity_check.disable=true` | 检查更新时绕过本体完整性检查. | -| `-Dhmcl.bmclapi.override=` | 覆盖 BMCLAPI 的 API Root, 默认值为 `https://bmclapi2.bangbang93.com`. | -| `-Dhmcl.font.override=` | 覆盖字族. | -| `-Dhmcl.version.override=` | 覆盖版本号. | -| `-Dhmcl.update_source.override=` | 覆盖 HMCL 更新源. | -| `-Dhmcl.authlibinjector.location=` | 使用指定的 authlib-injector (而非下载一个). | -| `-Dhmcl.openjfx.repo=` | 添加用于下载 OpenJFX 的自定义 Maven 仓库 | -| `-Dhmcl.native.encoding=` | 覆盖原生编码. | -| `-Dhmcl.microsoft.auth.id=` | 覆盖 Microsoft OAuth App ID. | -| `-Dhmcl.microsoft.auth.secret=` | 覆盖 Microsoft OAuth App 密钥. | +| 参数 | 简介 | +| -------------------------------------------- | -------------------------------------------------------------------- | +| `-Dhmcl.home=` | 覆盖 HMCL 数据文件夹 | +| `-Dhmcl.self_integrity_check.disable=true` | 检查更新时绕过本体完整性检查 | +| `-Dhmcl.bmclapi.override=` | 覆盖 BMCLAPI 的 API Root, 默认值为 `https://bmclapi2.bangbang93.com` | +| `-Dhmcl.font.override=` | 覆盖字族 | +| `-Dhmcl.version.override=` | 覆盖版本号 | +| `-Dhmcl.update_source.override=` | 覆盖 HMCL 更新源 | +| `-Dhmcl.authlibinjector.location=` | 使用指定的 authlib-injector (而非下载一个) | +| `-Dhmcl.openjfx.repo=` | 添加用于下载 OpenJFX 的自定义 Maven 仓库 | +| `-Dhmcl.native.encoding=` | 覆盖原生编码 | +| `-Dhmcl.microsoft.auth.id=` | 覆盖 Microsoft OAuth App ID | +| `-Dhmcl.microsoft.auth.secret=` | 覆盖 Microsoft OAuth App 密钥 |