Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 4.73 KB

README.md

File metadata and controls

71 lines (46 loc) · 4.73 KB
Raw

⛏ Hello Minecraft! Launcher 💎

Build Status Downloads Stars Discord QQ Group

English | 简体中文 | 繁體中文

Introduction

HMCL is an open-source, cross-platform Minecraft launcher that 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. Not only does it run on different operating systems like Windows, Linux, and macOS, but it also supports various CPU architectures such as x86, ARM, MIPS, and LoongArch. You can easily enjoy Minecraft across different platforms through HMCL.

For systems and CPU architectures supported by HMCL, see this table.

Download

Download the latest version from the official website.

You can also find the latest version of HMCL in GitHub Releases.

Although not necessary, it is recommended only to download releases from the official websites listed above.

License

The software is distributed under GPLv3 license with the following additional terms:

Additional terms under GPLv3 Section 7

  1. 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.

  2. You must not remove the copyright declaration displayed in the software. (Under GPLv3, 7(b))

Contribution

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

  • IDE: IntelliJ IDEA
  • Compiler: Java 1.8 or Java 11+
  • Do NOT modify gradle files

Compilation

Simply execute the following command in the project root directory:

./gradlew clean build

Make sure you have at least JavaFX 8 installed. Liberica Full JDK 8 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 updates
-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 the specified authlib-injector (instead of downloading one)
-Dhmcl.openjfx.repo=<maven repository url> Add custom Maven repository for downloading 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