From 505752476cb87f7a5710a5ba81c39cbdb45c475f Mon Sep 17 00:00:00 2001 From: Glavo Date: Wed, 7 Jan 2026 22:33:03 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README.md=20(#5156)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Building.md | 56 -------------- docs/Building_zh.md | 56 -------------- docs/Contributing.md | 93 ++++++++++++++++++++++++ docs/{Debug_zh.md => Contributing_zh.md} | 67 +++++++++++++++-- docs/README.md | 81 +++++++++++---------- docs/README_en_Qabs.md | 6 +- docs/README_es.md | 54 +++++--------- docs/README_ja.md | 55 ++++++-------- docs/README_lzh.md | 80 +++++++++++--------- docs/README_ru.md | 55 ++++++-------- docs/README_uk.md | 48 ++++++------ docs/README_zh.md | 84 +++++++++++---------- docs/README_zh_Hant.md | 81 +++++++++++---------- 13 files changed, 418 insertions(+), 398 deletions(-) delete mode 100644 docs/Building.md delete mode 100644 docs/Building_zh.md create mode 100644 docs/Contributing.md rename docs/{Debug_zh.md => Contributing_zh.md} (80%) diff --git a/docs/Building.md b/docs/Building.md deleted file mode 100644 index 12536a243..000000000 --- a/docs/Building.md +++ /dev/null @@ -1,56 +0,0 @@ -# Build Guide - - -**English** | [中文](Building_zh.md) - - -## Requirements - -To build the HMCL launcher, you need to install JDK 17 (or higher). You can download it here: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts). - -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](https://git-scm.com/downloads): - ```shell - 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](https://github.com/HMCL-dev/HMCL/releases). - -## Build HMCL - -To build HMCL, switch to the root directory of the HMCL project and run the following command: - -```shell -./gradlew clean makeExecutables -``` - -The built HMCL program files are located in the `HMCL/build/libs` subdirectory under the project root. diff --git a/docs/Building_zh.md b/docs/Building_zh.md deleted file mode 100644 index 58d9a264b..000000000 --- a/docs/Building_zh.md +++ /dev/null @@ -1,56 +0,0 @@ -# 构建指南 - - -[English](Building.md) | **中文** - - -## 环境需求 - -构建 HMCL 启动器需要安装 JDK 17 (或更高版本)。你可以从此处下载它: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts)。 - -在安装 JDK 后，请确保 `JAVA_HOME` 环境变量指向符合需求的 JDK 目录。 -你可以这样查看 `JAVA_HOME` 指向的 JDK 版本: - -
-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) -``` - -
- -## 获取 HMCL 源码 - -- 通过 [Git](https://git-scm.com/downloads) 可以获取最新源码: - ```shell - git clone https://github.com/HMCL-dev/HMCL.git - cd HMCL - ``` -- 从 [GitHub Release 页面](https://github.com/HMCL-dev/HMCL/releases)可以手动下载特定版本的源码。 - -## 构建 HMCL - -想要构建 HMCL，请切换到 HMCL 项目的根目录下，并执行以下命令: - -```shell -./gradlew clean makeExecutables -``` - -构建出的 HMCL 程序文件位于根目录下的 `HMCL/build/libs` 子目录中。 diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 000000000..5c008ba48 --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,93 @@ +# Contributing Guide + + +**English** | [中文](Contributing_zh.md) + + +## Build HMCL + +### Requirements + +To build the HMCL launcher, you need to install JDK 17 (or higher). You can download it here: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts). + +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](https://git-scm.com/downloads): + ```shell + 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](https://github.com/HMCL-dev/HMCL/releases). + +### Build HMCL + +To build HMCL, switch to the root directory of the HMCL project and run the following command: + +```shell +./gradlew clean makeExecutables +``` + +The built HMCL program files are located in the `HMCL/build/libs` subdirectory under the project root. + +## Debug Options + +> [!WARNING] +> This document describes HMCL's internal features, which we do not guarantee to be stable and may be modified or removed at any time. +> +> Please use these features with caution, as improper use may cause HMCL to behave abnormally or even crash. + +HMCL provides a series of debug options to control the behavior of the launcher. + +These options can be specified via environment variables or JVM parameters. If both are present, JVM parameters will override the environment variable settings. + +| Environment Variable | JVM Parameter | Function | Default Value | Additional Notes | +|-----------------------------|----------------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------------------| +| `HMCL_JAVA_HOME` | | Specifies the Java used to launch HMCL | | Only effective for exe/sh | +| `HMCL_JAVA_OPTS` | | Specifies the default JVM parameters when launching HMCL | | Only effective for exe/sh | +| `HMCL_FORCE_GPU` | | Specifies whether to force GPU-accelerated rendering | `false` | | +| `HMCL_ANIMATION_FRAME_RATE` | | Specifies the animation frame rate of HMCL | `60` | | +| `HMCL_LANGUAGE` | | Specifies the default language of HMCL | Uses the system default language | | +| | `-Dhmcl.dir=` | Specifies the current data folder of HMCL | `./.hmcl` | | +| | `-Dhmcl.home=` | Specifies the user data folder of HMCL | Windows: `%APPDATA\.hmcl`
Linux/BSD: `$XDG_DATA_HOME/hmcl`
macOS: `~Library/Application Support/hmcl` | | +| | `-Dhmcl.self_integrity_check.disable=true` | Disables self-integrity checks during updates | | | +| | `-Dhmcl.bmclapi.override=` | Specifies the API Root for BMCLAPI | `https://bmclapi2.bangbang93.com` | | +| | `-Dhmcl.discoapi.override=` | Specifies the API Root for foojay Disco API | `https://api.foojay.io/disco/v3.0` | | +| `HMCL_FONT` | `-Dhmcl.font.override=` | Specifies the default font for HMCL | Uses the system default font | | +| | `-Dhmcl.update_source.override=` | Specifies the update source for HMCL | `https://hmcl.huangyuhui.net/api/update_link` | | +| | `-Dhmcl.authlibinjector.location=` | Specifies the location of the authlib-injector JAR file | Uses the built-in authlib-injector | | +| | `-Dhmcl.openjfx.repo=` | Adds a custom Maven repository for downloading OpenJFX | | | +| | `-Dhmcl.native.encoding=` | Specifies the native encoding | Uses the system's native encoding | | +| | `-Dhmcl.microsoft.auth.id=` | Specifies the Microsoft OAuth App ID | Uses the built-in Microsoft OAuth App ID | | +| | `-Dhmcl.microsoft.auth.secret=` | Specifies the Microsoft OAuth App Secret | Uses the built-in Microsoft OAuth App Secret | | +| | `-Dhmcl.curseforge.apikey=` | Specifies the CurseForge API key | Uses the built-in CurseForge API key | | +| | `-Dhmcl.native.backend=` | Specifies the native backend used by HMCL | `auto` | | +| | `-Dhmcl.hardware.fastfetch=` | Specifies whether to use fastfetch for hardware detection | `true` | | diff --git a/docs/Debug_zh.md b/docs/Contributing_zh.md similarity index 80% rename from docs/Debug_zh.md rename to docs/Contributing_zh.md index d82e95bb9..7e284ead4 100644 --- a/docs/Debug_zh.md +++ b/docs/Contributing_zh.md @@ -1,4 +1,63 @@ -# 调试选项 +# 贡献指南 + + +[English](Contributing.md) | **中文** + + +## 构建 HMCL + +### 环境需求 + +构建 HMCL 启动器需要安装 JDK 17 (或更高版本)。你可以从此处下载它: [Download Liberica JDK](https://bell-sw.com/pages/downloads/#jdk-25-lts)。 + +在安装 JDK 后，请确保 `JAVA_HOME` 环境变量指向符合需求的 JDK 目录。 +你可以这样查看 `JAVA_HOME` 指向的 JDK 版本: + +
+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) +``` + +
+ +### 获取 HMCL 源码 + +- 通过 [Git](https://git-scm.com/downloads) 可以获取最新源码: + ```shell + git clone https://github.com/HMCL-dev/HMCL.git + cd HMCL + ``` +- 从 [GitHub Release 页面](https://github.com/HMCL-dev/HMCL/releases)可以手动下载特定版本的源码。 + +### 构建 HMCL + +想要构建 HMCL，请切换到 HMCL 项目的根目录下，并执行以下命令: + +```shell +./gradlew clean makeExecutables +``` + +构建出的 HMCL 程序文件位于根目录下的 `HMCL/build/libs` 子目录中。 + +## 调试选项 > [!WARNING] > 本文介绍的是 HMCL 的内部功能，我们不保证这些功能的稳定性，并且随时可能修改或删除这些功能。 @@ -32,9 +91,3 @@ HMCL 提供了一系列调试选项，用于控制启动器的行为。 | | `-Dhmcl.native.backend=` | 指定HMCL使用的本机后端 | `auto` | | | `-Dhmcl.hardware.fastfetch=` | 指定是否使用 fastfetch 检测硬件信息 | `true` | - - - - - - diff --git a/docs/README.md b/docs/README.md index 66bc1ac53..ecb767512 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + **English** (**Standard**, [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) | [español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md) @@ -23,11 +38,31 @@ For systems and CPU architectures supported by HMCL, please refer to [this table ## Download -Download the latest version from the [official website](https://hmcl.huangyuhui.net/download). +You can download HMCL from the following sources: -You can also find the latest version of HMCL in [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases). +- [HMCL Official Website](https://hmcl.huangyuhui.net/download) +- [GitHub Release](https://github.com/HMCL-dev/HMCL/releases) +- [CNB Release](https://cnb.cool/HMCL-dev/HMCL/-/releases) -Although not necessary, it is recommended only to download releases from the official websites listed above. +## Contributing + +HMCL is a community-driven open-source project, and everyone is welcome to contribute code or provide suggestions. + +You can contribute to HMCL development in the following ways: + +- Report bugs or request features by [creating an issue](https://github.com/HMCL-dev/HMCL/issues/new/choose) on GitHub. +- Contribute code by forking the repository on GitHub and [submitting a pull request](https://github.com/HMCL-dev/HMCL/compare). + +Before contributing, please read the [Contributing Guide](./Contributing.md), which includes the following: + +- [How to build and run HMCL from source](./Contributing.md#build-hmcl) +- [Adjusting HMCL behavior using debug options](./Contributing.md#debug-options) + +## Contributors + +Since 2015, more than 110 contributors have participated in HMCL. Thank you for your hard work! + +[![Contributors](https://contrib.rocks/image?repo=HMCL-dev/HMCL)](https://github.com/HMCL-dev/HMCL/graphs/contributors) ## License @@ -40,31 +75,3 @@ The software is distributed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.h The software name and the version number can be edited [here](https://github.com/HMCL-dev/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35). 2. You must not remove the copyright declaration displayed in the software. (Under [GPLv3, 7(b)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370)) - -## Contribution - -If you want to submit a pull request, here are some requirements: - -* IDE: IntelliJ IDEA -* Compiler: Java 17+ - -### Compilation - -See the [Build Guide](./Building.md) page. - -## JVM Options (for debugging) - -| Parameter | Description | -| -------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `-Dhmcl.home=` | Override HMCL directory | -| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for updates | -| `-Dhmcl.bmclapi.override=` | Override API Root of BMCLAPI download provider. Defaults to `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | Override font family | -| `-Dhmcl.version.override=` | Override the version number | -| `-Dhmcl.update_source.override=` | Override the update source for HMCL itself | -| `-Dhmcl.authlibinjector.location=` | Use the specified authlib-injector (instead of downloading one) | -| `-Dhmcl.openjfx.repo=` | Add custom Maven repository for downloading OpenJFX | -| `-Dhmcl.native.encoding=` | Override the native encoding | -| `-Dhmcl.microsoft.auth.id=` | Override Microsoft OAuth App ID | -| `-Dhmcl.microsoft.auth.secret=` | Override Microsoft OAuth App Secret | -| `-Dhmcl.curseforge.apikey=` | Override CurseForge API Key | diff --git a/docs/README_en_Qabs.md b/docs/README_en_Qabs.md index eec53e812..6fc21f3b6 100644 --- a/docs/README_en_Qabs.md +++ b/docs/README_en_Qabs.md @@ -1,6 +1,8 @@ -# ɹǝɥɔunɐ˥ ¡ʇɟɐɹɔǝuᴉW ollǝH +
+ HMCL Logo +
-[![pɐoꞁuʍoᗡ](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=p%C9%90o%EA%9E%81u%CA%8Do%E1%97%A1&style=flat)](https://github.com/HMCL-dev/HMCL/releases) +

ɹǝɥɔunɐ˥ ¡ʇɟɐɹɔǝuᴉW ollǝH

diff --git a/docs/README_es.md b/docs/README_es.md index f81880435..8725913df 100644 --- a/docs/README_es.md +++ b/docs/README_es.md @@ -1,14 +1,28 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) | **español** | [русский](README_ru.md) | [українська](README_uk.md) @@ -33,31 +47,3 @@ Aunque no es necesario, se recomienda descargar las versiones solo de los sitios ## Licencia Consulta [README.md](README.md#license). - -## Contribución - -Si deseas enviar un pull request, aquí tienes algunos requisitos: - -* IDE: IntelliJ IDEA -* Compilador: Java 17+ - -### Compilación - -Consulta la página de la [Guía de compilación](./Building.md). - -## Opciones de JVM (para depuración) - -| Parámetro | Descripción | -|---------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| -| `-Dhmcl.home=` | Sobrescribe el directorio de HMCL | -| `-Dhmcl.self_integrity_check.disable=true` | Omite la verificación de integridad propia al buscar actualizaciones | -| `-Dhmcl.bmclapi.override=` | Sobrescribe la raíz de la API del proveedor de descargas BMCLAPI. Por defecto `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | Sobrescribe la familia de fuente | -| `-Dhmcl.version.override=` | Sobrescribe el número de versión | -| `-Dhmcl.update_source.override=` | Sobrescribe la fuente de actualizaciones de HMCL | -| `-Dhmcl.authlibinjector.location=` | Usa el authlib-injector especificado (en vez de descargar uno) | -| `-Dhmcl.openjfx.repo=` | Añade un repositorio Maven personalizado para descargar OpenJFX | -| `-Dhmcl.native.encoding=` | Sobrescribe la codificación nativa | -| `-Dhmcl.microsoft.auth.id=` | Sobrescribe el ID de la App OAuth de Microsoft | -| `-Dhmcl.microsoft.auth.secret=` | Sobrescribe el secreto de la App OAuth de Microsoft | -| `-Dhmcl.curseforge.apikey=` | Sobrescribe la clave API de CurseForge | diff --git a/docs/README_ja.md b/docs/README_ja.md index 8cb778712..788e92237 100644 --- a/docs/README_ja.md +++ b/docs/README_ja.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | **日本語** | [español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md) @@ -32,31 +47,3 @@ HMCLが対応しているシステムやCPUアーキテクチャについては ## ライセンス ライセンスについては [README.md](README.md#license) をご参照ください。 - -## コントリビューション - -プルリクエストを送信したい場合、以下の要件を満たしてください。 - -* IDE：IntelliJ IDEA -* コンパイラ：Java 17以上 - -### コンパイル方法 - -ビルド方法については、[ビルドガイド](./Building.md)ページをご覧ください。 - -## JVMオプション（デバッグ用） - -| パラメータ | 説明 | -|----------------------------------------------|-----------------------------------------------------------------------------| -| `-Dhmcl.home=` | HMCLディレクトリを上書きします | -| `-Dhmcl.self_integrity_check.disable=true` | アップデート時の自己整合性チェックをバイパスします | -| `-Dhmcl.bmclapi.override=` | BMCLAPIダウンロードプロバイダーのAPIルートを上書きします。デフォルトは`https://bmclapi2.bangbang93.com`です | -| `-Dhmcl.font.override=` | フォントファミリーを上書きします | -| `-Dhmcl.version.override=` | バージョン番号を上書きします | -| `-Dhmcl.update_source.override=` | HMCL本体のアップデートソースを上書きします | -| `-Dhmcl.authlibinjector.location=` | 指定したauthlib-injectorを使用します（ダウンロードせずに） | -| `-Dhmcl.openjfx.repo=` | OpenJFXダウンロード用のカスタムMavenリポジトリを追加します | -| `-Dhmcl.native.encoding=` | ネイティブエンコーディングを上書きします | -| `-Dhmcl.microsoft.auth.id=` | Microsoft OAuthアプリIDを上書きします | -| `-Dhmcl.microsoft.auth.secret=` | Microsoft OAuthアプリシークレットを上書きします | -| `-Dhmcl.curseforge.apikey=` | CurseForge APIキーを上書きします | diff --git a/docs/README_lzh.md b/docs/README_lzh.md index b39993303..743905b67 100644 --- a/docs/README_lzh.md +++ b/docs/README_lzh.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | **中文** ([简体](README_zh.md), [繁體](README_zh_Hant.md), **文言**) | [日本語](README_ja.md) | [español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md) @@ -24,40 +39,33 @@ HMCL 跨域甚廣。無論 Windows、Linux、macOS、FreeBSD 諸常見械綱， ## 下載 -請自 [HMCL 官網](https://hmcl.huangyuhui.net/download) 取其最新版。 +君可自此數途引 HMCL： -亦可於 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 得其新者。 +- [HMCL 官方網站](https://hmcl.huangyuhui.net/download) +- [GitHub Release](https://github.com/HMCL-dev/HMCL/releases) +- [CNB Release](https://cnb.cool/HMCL-dev/HMCL/-/releases) -雖非強制，然猶勸自官網取之。 +## 與貢 + +HMCL 為社群所驅之開源計畫，迎諸君貢獻其碼，或建言於此。 + +君可由此數途參與 HMCL 之開發： + +- 於 GitHub 上[創建 Issue](https://github.com/HMCL-dev/HMCL/issues/new/choose)，以報告謬誤，或請求功能。 +- 於 GitHub 上 Fork 倉庫，並[提交 Pull Request](https://github.com/HMCL-dev/HMCL/compare)，以貢獻其碼。 + +參與貢獻之前，請閱[貢獻指南](./Contributing_zh.md)，其中載有如下： + +- [如何自源碼構建並運行 HMCL](./Contributing_zh.md#构建-hmcl) +- [以調試選項調整 HMCL 之行為](./Contributing_zh.md#调试选项) + +## 貢獻者 + +自公元二〇一五年以來，參與 HMCL 者已逾百十，謝其勤勞！ + +[![Contributors](https://contrib.rocks/image?repo=HMCL-dev/HMCL)](https://github.com/HMCL-dev/HMCL/graphs/contributors) ## 開源之約 詳見 [README_zh_Hant.md](README_zh_Hant.md#開源協議)。 -## 貢獻 - -若欲獻 Pull Request，須遵下列： - -* IDE 用 IntelliJ IDEA -* 編譯器用爪哇十七以上 - -### 編造 - -請觀[編造指南](./Building_zh.md)。 - -## 爪哇虛機之通弦（以資勘誤） - -| 參數 | 解釋 | -|----------------------------------------------|---------------------------------------------------------| -| `-Dhmcl.home=` | 易 HMCL 之用戶目錄 | -| `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時不驗本體之全 | -| `-Dhmcl.bmclapi.override=` | 易 BMCLAPI 之 API 根，預設為 `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | 易書體 | -| `-Dhmcl.version.override=` | 易版 | -| `-Dhmcl.update_source.override=` | 易 HMCL 之更新所 | -| `-Dhmcl.authlibinjector.location=` | 用所指之 authlib-injector，毋需下載 | -| `-Dhmcl.openjfx.repo=` | 增 OpenJFX 下載之自定 Maven 庫 | -| `-Dhmcl.native.encoding=` | 易本地編碼 | -| `-Dhmcl.microsoft.auth.id=` | 易 Microsoft OAuth 之 App ID | -| `-Dhmcl.microsoft.auth.secret=` | 易 Microsoft OAuth 之金鑰 | -| `-Dhmcl.curseforge.apikey=` | 易 CurseForge 之 API 金鑰 | diff --git a/docs/README_ru.md b/docs/README_ru.md index c737c1f33..bf36f9930 100644 --- a/docs/README_ru.md +++ b/docs/README_ru.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) | [español](README_es.md) | **русский** | [українська](README_uk.md) @@ -32,31 +47,3 @@ HMCL обладает отличной кроссплатформенность ## Лицензия См. [README.md](README.md#license). - -## Вклад - -Если вы хотите отправить pull request, ознакомьтесь с требованиями: - -* IDE: IntelliJ IDEA -* Компилятор: Java 17+ - -### Сборка - -См. страницу [Руководство по сборке](./Building.md). - -## Параметры JVM (для отладки) - -| Параметр | Описание | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| `-Dhmcl.home=<путь>` | Переопределить директорию HMCL | -| `-Dhmcl.self_integrity_check.disable=true` | Отключить проверку целостности при проверке обновлений | -| `-Dhmcl.bmclapi.override=` | Переопределить корневой API-адрес провайдера загрузки BMCLAPI. По умолчанию `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=<название шрифта>` | Переопределить семейство шрифтов | -| `-Dhmcl.version.override=<версия>` | Переопределить номер версии | -| `-Dhmcl.update_source.override=` | Переопределить источник обновлений для самого HMCL | -| `-Dhmcl.authlibinjector.location=<путь>` | Использовать указанный authlib-injector (вместо загрузки) | -| `-Dhmcl.openjfx.repo=` | Добавить пользовательский Maven-репозиторий для загрузки OpenJFX | -| `-Dhmcl.native.encoding=<кодировка>` | Переопределить нативную кодировку | -| `-Dhmcl.microsoft.auth.id=` | Переопределить Microsoft OAuth App ID | -| `-Dhmcl.microsoft.auth.secret=` | Переопределить Microsoft OAuth App Secret | -| `-Dhmcl.curseforge.apikey=` | Переопределить CurseForge API Key | diff --git a/docs/README_uk.md b/docs/README_uk.md index c3d0720fc..d2db47c44 100644 --- a/docs/README_uk.md +++ b/docs/README_uk.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) | [español](README_es.md) | [русский](README_ru.md) | **українська** @@ -39,24 +54,3 @@ HMCL має чудові кросплатформні можливості. Ві * IDE: IntelliJ IDEA * Компілятор: Java 17+ - -### Компіляція - -Дивіться сторінку [Посібник зі збірки](./Building.md). - -## JVM Options (for debugging) - -| Parameter | Description | -|----------------------------------------------|-----------------------------------------------------------------------------------------------| -| `-Dhmcl.home=` | Override HMCL directory | -| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for updates | -| `-Dhmcl.bmclapi.override=` | Override API Root of BMCLAPI download provider. Defaults to `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | Override font family | -| `-Dhmcl.version.override=` | Override the version number | -| `-Dhmcl.update_source.override=` | Override the update source for HMCL itself | -| `-Dhmcl.authlibinjector.location=` | Use the specified authlib-injector (instead of downloading one) | -| `-Dhmcl.openjfx.repo=` | Add custom Maven repository for downloading OpenJFX | -| `-Dhmcl.native.encoding=` | Override the native encoding | -| `-Dhmcl.microsoft.auth.id=` | Override Microsoft OAuth App ID | -| `-Dhmcl.microsoft.auth.secret=` | Override Microsoft OAuth App Secret | -| `-Dhmcl.curseforge.apikey=` | Override CurseForge API Key | diff --git a/docs/README_zh.md b/docs/README_zh.md index f6cb615b1..390016a9c 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | **中文** (**简体**, [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) | [español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md) @@ -23,11 +38,31 @@ HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS、 ## 下载 -请从 [HMCL 官网](https://hmcl.huangyuhui.net/download) 下载最新版本的 HMCL。 +你可以从这些渠道下载 HMCL： -你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下载最新版本的 HMCL。 +- [HMCL 官方网站](https://hmcl.huangyuhui.net/download) +- [GitHub Release](https://github.com/HMCL-dev/HMCL/releases) +- [CNB Release](https://cnb.cool/HMCL-dev/HMCL/-/releases) -虽然并不强制，但仍建议通过 HMCL 官网下载启动器。 +## 参与贡献 + +HMCL 是一个社区驱动的开源项目，欢迎任何人参与贡献代码或提出建议。 + +你可以通过以下方式参与 HMCL 的开发： + +- 通过在 GitHub 上[创建 Issue](https://github.com/HMCL-dev/HMCL/issues/new/choose) 来报告 Bug 或提出功能请求。 +- 通过在 GitHub 上 Fork 仓库并[提交 Pull Request](https://github.com/HMCL-dev/HMCL/compare) 来贡献代码。 + +在参与贡献前，请阅读[贡献指南](./Contributing_zh.md)，其中包含以下内容： + +- [如何从源码构建并运行 HMCL](./Contributing_zh.md#构建-hmcl) +- [通过调试选项调整 HMCL 的行为](./Contributing_zh.md#调试选项) + +## 贡献者 + +自 2015 年以来，HMCL 已经有超过 110 位贡献者参与其中，感谢他们的辛勤付出！ + +[![Contributors](https://contrib.rocks/image?repo=HMCL-dev/HMCL)](https://github.com/HMCL-dev/HMCL/graphs/contributors) ## 开源协议 @@ -35,36 +70,9 @@ HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS、 ### 附加条款 (依据 GPLv3 开源协议第七条) -1. 当你分发该程序的修改版本时，你必须以一种合理的方式修改该程序的名称或版本号，以示其与原始版本不同。(依据 [GPLv3, 7(c)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374)) +1. 当你分发该程序的修改版本时，你必须以一种合理的方式修改该程序的名称或版本号，以示其与原始版本不同。( + 依据 [GPLv3, 7(c)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374)) 该程序的名称及版本号可在 [此处](https://github.com/HMCL-dev/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35) 修改。 2. 你不得移除该程序所显示的版权声明。(依据 [GPLv3, 7(b)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370)) - -## 贡献 - -如果你想提交一个 Pull Request，必须遵守如下要求： - -* IDE：IntelliJ IDEA -* 编译器：Java 17+ - -### 构建 HMCL - -参见[构建指南](./Building_zh.md)页面。 - -## JVM 选项 (用于调试) - -| 参数 | 简介 | -| -------------------------------------------- | -------------------------------------------------------------------- | -| `-Dhmcl.home=` | 覆盖 HMCL 数据文件夹 | -| `-Dhmcl.self_integrity_check.disable=true` | 检查更新时不检查本体完整性 | -| `-Dhmcl.bmclapi.override=` | 覆盖 BMCLAPI 的 API Root，默认值为 `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | 覆盖字族 | -| `-Dhmcl.version.override=` | 覆盖版本号 | -| `-Dhmcl.update_source.override=` | 覆盖 HMCL 更新源 | -| `-Dhmcl.authlibinjector.location=` | 使用指定的 authlib-injector (而非下载一个) | -| `-Dhmcl.openjfx.repo=` | 添加用于下载 OpenJFX 的自定义 Maven 仓库 | -| `-Dhmcl.native.encoding=` | 覆盖原生编码 | -| `-Dhmcl.microsoft.auth.id=` | 覆盖 Microsoft OAuth App ID | -| `-Dhmcl.microsoft.auth.secret=` | 覆盖 Microsoft OAuth App 密钥 | -| `-Dhmcl.curseforge.apikey=` | 覆盖 CurseForge API 密钥 | diff --git a/docs/README_zh_Hant.md b/docs/README_zh_Hant.md index cb25fcc31..453262f79 100644 --- a/docs/README_zh_Hant.md +++ b/docs/README_zh_Hant.md @@ -1,14 +1,29 @@ -# Hello Minecraft! Launcher + + +
+ HMCL Logo +
+ +

Hello Minecraft! Launcher

+ -[![CNB](https://img.shields.io/badge/cnb-mirror-ff6200?logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) -[![Downloads](https://img.shields.io/github/downloads/HMCL-dev/HMCL/total?label=Downloads&style=flat)](https://github.com/HMCL-dev/HMCL/releases) -![Stars](https://img.shields.io/github/stars/HMCL-dev/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-bright?label=&logo=qq&logoColor=ffffff&color=1EBAFC&labelColor=1DB0EF&logoSize=auto)](https://docs.hmcl.net/groups.html) +
+ +[![GitHub](https://img.shields.io/badge/GitHub-repo-blue?style=flat-square&logo=github)](https://github.com/HMCL-dev/HMCL) +[![CNB](https://img.shields.io/badge/CNB-mirror-ff6200?style=flat-square&logo=cloudnativebuild)](https://cnb.cool/HMCL-dev/HMCL) +[![Gitee](https://img.shields.io/badge/Gitee-mirror-c71d23?style=flat-square&logo=gitee)](https://gitee.com/huanghongxun/HMCL) + +[![QQ Group](https://img.shields.io/badge/QQ-gray?style=flat-square&logo=qq&logoColor=ffffff)](https://docs.hmcl.net/groups.html) +[![Discord](https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord)](https://discord.gg/jVvC7HfM6U) +[![Bilibili](https://img.shields.io/badge/Bilibili-gray?style=flat-square&logo=bilibili)](https://space.bilibili.com/20314891) + +
+--- + English ([Standard](README.md), [uʍoᗡ ǝpᴉsd∩](README_en_Qabs.md)) | **中文** ([简体](README_zh.md), **繁體**, [文言](README_lzh.md)) | [日本語](README_ja.md) | [español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md) @@ -23,11 +38,31 @@ HMCL 有著強大的跨平臺能力。它不僅支援 Windows、Linux、macOS、 ## 下載 -請從 [HMCL 官網](https://hmcl.huangyuhui.net/download) 下載最新版本的 HMCL。 +你可以從這些渠道下載 HMCL： -你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下載最新版本的 HMCL。 +- [HMCL 官方網站](https://hmcl.huangyuhui.net/download) +- [GitHub Release](https://github.com/HMCL-dev/HMCL/releases) +- [CNB Release](https://cnb.cool/HMCL-dev/HMCL/-/releases) -雖然並不強制，但仍建議透過 HMCL 官網下載啟動器。 +## 參與貢獻 + +HMCL 是一個社區驅動的開源項目，歡迎任何人參與貢獻程式碼或提出建議。 + +你可以通過以下方式參與 HMCL 的開發： + +- 通過在 GitHub 上[創建 Issue](https://github.com/HMCL-dev/HMCL/issues/new/choose) 來報告 Bug 或提出功能請求。 +- 通過在 GitHub 上 Fork 倉庫並[提交 Pull Request](https://github.com/HMCL-dev/HMCL/compare) 來貢獻程式碼。 + +在參與貢獻前，請閱讀[貢獻指南](./Contributing_zh.md)，其中包含以下內容： + +- [如何從原始碼構建並運行 HMCL](./Contributing_zh.md#构建-hmcl) +- [通過調試選項調整 HMCL 的行為](./Contributing_zh.md#调试选项) + +## 貢獻者 + +自 2015 年以來，HMCL 已經有超過 110 位貢獻者參與其中，感謝他們的辛勤付出！ + +[![Contributors](https://contrib.rocks/image?repo=HMCL-dev/HMCL)](https://github.com/HMCL-dev/HMCL/graphs/contributors) ## 開源協議 @@ -40,31 +75,3 @@ HMCL 有著強大的跨平臺能力。它不僅支援 Windows、Linux、macOS、 該程式的名稱及版本號可在 [此處](https://github.com/HMCL-dev/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35) 修改。 2. 你不得移除該程式所顯示的版權宣告。(依據 [GPLv3, 7(b)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370)) - -## 貢獻 - -如果你想提交一個 Pull Request，必須遵守如下要求： - -* IDE：IntelliJ IDEA -* 編譯器：Java 17+ - -### 編譯 - -參閱[構建指南](./Building_zh.md)頁面。 - -## JVM 選項 (用於除錯) - -| 參數 | 簡介 | -| -------------------------------------------- | -------------------------------------------------------------------- | -| `-Dhmcl.home=` | 覆蓋 HMCL 使用者目錄 | -| `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時不檢查本體完整性 | -| `-Dhmcl.bmclapi.override=` | 覆蓋 BMCLAPI 的 API Root，預設值為 `https://bmclapi2.bangbang93.com` | -| `-Dhmcl.font.override=` | 覆蓋字族 | -| `-Dhmcl.version.override=` | 覆蓋版本號 | -| `-Dhmcl.update_source.override=` | 覆蓋 HMCL 更新來源 | -| `-Dhmcl.authlibinjector.location=` | 使用指定的 authlib-injector (而非下載一個) | -| `-Dhmcl.openjfx.repo=` | 添加用於下載 OpenJFX 的自訂 Maven 倉庫 | -| `-Dhmcl.native.encoding=` | 覆蓋原生編碼 | -| `-Dhmcl.microsoft.auth.id=` | 覆蓋 Microsoft OAuth App ID | -| `-Dhmcl.microsoft.auth.secret=` | 覆蓋 Microsoft OAuth App 金鑰 | -| `-Dhmcl.curseforge.apikey=` | 覆蓋 CurseForge API 金鑰 |