mirror of https://github.com/HMCL-dev/HMCL.git synced 2024-11-21 03:10:58 +08:00

Go to file

Glavo c873352ee9 更多平台的原生适配 (#1654 ) * Add Minecraft 1.13+ support for linux-loongarch64_ow * Add Minecraft 1.6~1.12.2 support for linux-arm32 * Update documents		2022-08-28 16:56:33 +08:00
.github	因开黑啦改名成 KOOK，所以改名 (#1600 )	2022-08-08 16:51:38 +08:00
config/checkstyle
gradle/wrapper
HMCL	更多平台的原生适配 (#1654 )	2022-08-28 16:56:33 +08:00
HMCLauncher	No longer download from tuna mirror	2022-03-01 23:27:51 +08:00
HMCLCore	Support path containing unicode characters on Mac OS (#1661 )	2022-08-28 16:54:22 +08:00
lib
minecraft/libraries	Use Gradle Kotlin DSL	2022-01-01 20:59:36 +08:00
.editorconfig	feat: add .editorconfig. Closes #1425 .	2022-05-22 00:54:57 +08:00
.gitignore	chore: update gitignore.	2022-05-22 01:45:09 +08:00
build.gradle.kts	Fix build on JDK without JavaFX	2022-01-23 19:47:26 +08:00
gradlew
gradlew.bat
javafx.gradle.kts	Add openjfx to testImplementation dependencies	2022-05-07 18:51:52 +08:00
LICENSE
PLATFORM.md	更多平台的原生适配 (#1654 )	2022-08-28 16:56:33 +08:00
README_cn.md	更多平台的原生适配 (#1654 )	2022-08-28 16:56:33 +08:00
README.md	更多平台的原生适配 (#1654 )	2022-08-28 16:56:33 +08:00
settings.gradle.kts	Use Gradle Kotlin DSL	2022-01-01 20:59:36 +08:00

README.md

⛏ Hello Minecraft! Launcher 💎

English | 中文

Introduction

HMCL is a cross-platform Minecraft launcher which supports Mod Management, Game Customizing, Auto Installing (Forge, Fabric, 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 Mac OS, 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.

Download

Download the latest version from the official website.

Note: The recent versions released in GitHub are beta versions, which contains extra testing functions compared to the release versions on the official website. However, they may be unstable and you're more likely to encounter bugs or unexpected problems.

Although not necessary, it is recommended to download the ones from the official website.

License

The software is distributed under GPLv3 with additional terms.

Additional terms under GPLv3 Section 7

When you distribute a modified version of the software, you must change the software name or the version number in a reasonable way in order to distinguish it from the original version. (Under GPLv3, 7(c))

The software name and the version number can be edited here.
You must not remove the copyright declaration displayed in the software. (Under GPLv3, 7(b))

Contribution

If you want to submit a pull request, there are some requirements:

IDE: Intellij IDEA
Compiler: Java 1.8
Do NOT modify gradle files

Compilation

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.

JVM Options (for debugging)

Parameter	Description
`-Dhmcl.self_integrity_check.disable=true`	Bypass the self integrity check when checking for update.
`-Dhmcl.bmclapi.override=<version>`	Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com`. e.g. `https://download.mcbbs.net`.
`-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.
`-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.