HMCL/docs/Building.md

Build Guide

English | 中文

Requirements

To build the HMCL launcher, you need to install JDK 17 (or higher). You can download it here: Download Liberica JDK.

After installing the JDK, make sure the JAVA_HOME environment variable points to the required JDK directory. You can check the JDK version that JAVA_HOME points to like this:

Windows

PowerShell:

PS > & "$env:JAVA_HOME/bin/java.exe" -version
openjdk version "25" 2025-09-16 LTS
OpenJDK Runtime Environment (build 25+37-LTS)
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)

Linux/macOS/FreeBSD

> $JAVA_HOME/bin/java -version
openjdk version "25" 2025-09-16 LTS
OpenJDK Runtime Environment (build 25+37-LTS)
OpenJDK 64-Bit Server VM (build 25+37-LTS, mixed mode, sharing)

Get HMCL Source Code

• You can get the latest source code via Git:

  git clone https://github.com/HMCL-dev/HMCL.git
  cd HMCL
  

• You can manually download a specific version of the source code from the GitHub Release page.

Build HMCL

To build HMCL, switch to the root directory of the HMCL project and run the following command:

./gradlew clean makeExecutables

The built HMCL program files are located in the HMCL/build/libs subdirectory under the project root.