Skip to content

Commit

Permalink
Revise readme and platform docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
3gf8jv4dv committed May 18, 2024
1 parent af37194 commit 5f0b471
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 98 deletions.
44 changes: 21 additions & 23 deletions PLATFORM.md
Original file line number Diff line number Diff line change
@@ -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)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (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.20.4) | / | / |
| LoongArch64 | / | 👌 (Minecraft 1.6~1.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | | / | / |
| S390x | / | | / | / |
| x86 | ✅️ | ✅️ | / | / |
| ARM64 | 👌 (Minecraft 1.8~1.18.2)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (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.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.
52 changes: 25 additions & 27 deletions PLATFORM_cn.md
Original file line number Diff line number Diff line change
@@ -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)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (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.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)<br/>✅ (Minecraft 1.19+) | 👌 (Minecraft 1.8~1.20.4) | 👌 (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.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 提出支持请求
33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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=<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 |
Loading

0 comments on commit 5f0b471

Please sign in to comment.