Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revise readme and platform docs [skip ci] #3054

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+189 −89
Open

Revise readme and platform docs [skip ci] #3054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
864055b
Revise [skip ci]
3gf8jv4dv Sep 13, 2024
dc5d849
Revise [skip ci]
3gf8jv4dv Sep 13, 2024
2cbd1c3
Revise [skip ci]
3gf8jv4dv Sep 16, 2024
300da3a
Revise [skip ci]
3gf8jv4dv Sep 17, 2024
bad87a1
Revise [skip ci]
3gf8jv4dv Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions PLATFORM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 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) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
Expand All @@ -16,24 +16,22 @@ English | [简体中文](PLATFORM_cn.md)

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.
3gf8jv4dv marked this conversation as resolved.
Show resolved Hide resolved
* 👌 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 GitHub Issue.
32 changes: 15 additions & 17 deletions PLATFORM_cn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 平台支持状态

[English](PLATFORM.md) | 简体中文
[English](PLATFORM.md) | **简体中文** | [繁體中文](PLATFORM_tw.md)

| | Windows | Linux | Mac OS | FreeBSD |
| | Windows | Linux | macOS | FreeBSD |
|----------------------------|:--------------------------------------------------|:---------------------------|:-----------------------------------------------------------------------|:------------------------|
| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.21) |
| x86 | ✅️ (~1.20.4) | ✅️ (~1.20.4) | / | / |
Expand All @@ -14,26 +14,24 @@
| 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 提出支持请求。
37 changes: 37 additions & 0 deletions PLATFORM_tw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 平臺支援狀態

[English](PLATFORM.md) | [简体中文](PLATFORM_cn.md) | **繁體中文**

| | Windows | Linux | macOS | FreeBSD |
|----------------------------|:--------------------------------------------------|:---------------------------|:-----------------------------------------------------------------------|:------------------------|
| x86-64 | ✅️ | ✅️ | ✅️ | 👌(Minecraft 1.13~1.21) |
| 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.20.1) | / | / |
| PowerPC-64 (Little-Endian) | / | ❔ | / | / |
| S390x | / | ❔ | / | / |

圖例：

* ✅ 官方支援的平臺

受 Mojang 官方支援。在遊戲中遇到的問題應該直接向 Mojang 回報。

* 👌 支援的平臺

由 HMCL 提供支援，經過測試可以正常執行，但可能比得到全面支援的平臺有更多問題。
不保證支援 Minecraft 1.6 以下的版本。
如果你遇到在得到全面支援的平臺上不存在的問題，可以向 HMCL 回報 。

* ❔ 低級別支援的平臺

HMCL 可以在這個平臺上執行，並且有一些基本的支援。但是，還不能正常地啟動遊戲。
如果你想正常啟動遊戲，則需要透過其他方式獲得遊戲所需的本機庫 (LWJGL)，並在（全域）遊戲設定中指定本機庫路徑。

* ／ 不支援的平臺

我們目前還沒有打算支援這些平臺，主要是因為我們沒有測試這些平臺的裝置。
如果你能幫助我們進行測試，請透過提交 Issue 提出支援請求。
47 changes: 22 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).

Expand Down Expand Up @@ -43,8 +40,8 @@ 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
* Compiler: Java 1.8 or Java 11+
* IDE: IntelliJ IDEA
* Compiler: Java 11+
* Do NOT modify `gradle` files

### Compilation
Expand All @@ -55,20 +52,20 @@ Simply execute the following command in project root directory:
./gradlew clean build
```

Make sure you have Java installed with JavaFX 8 at least. Liberica Full JDK 8 or later is recommended.
Make sure you have Java installed with JavaFX 11 at least. Liberica Full JDK 11 or later is recommended.

## 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