将 README.md 移动至 docs 文件夹中 (#4398)
This commit is contained in:
Glavo
72
docs/README.md
Normal file
72
docs/README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
**English** | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
## 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, macOS, and FreeBSD, but it also supports various CPU architectures such as x86, ARM, RISC-V, MIPS, and LoongArch. You can easily enjoy Minecraft across different platforms through HMCL.
|
||||
|
||||
For systems and CPU architectures supported by HMCL, please refer to [this table](PLATFORM.md).
|
||||
|
||||
## Download
|
||||
|
||||
Download the latest version from the [official website](https://hmcl.huangyuhui.net/download).
|
||||
|
||||
You can also find the latest version of HMCL in [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases).
|
||||
|
||||
Although not necessary, it is recommended only to download releases from the official websites listed above.
|
||||
|
||||
## License
|
||||
|
||||
The software is distributed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 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)](https://github.com/HMCL-dev/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374))
|
||||
|
||||
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
|
||||
|
||||
Simply execute the following command in the project root directory:
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
Make sure you have Java 17 or later installed.
|
||||
|
||||
## 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 |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | Override CurseForge API Key |
|
||||
64
docs/README_es.md
Normal file
64
docs/README_es.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
**español** | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
## Introducción
|
||||
|
||||
HMCL es un lanzador de Minecraft de código abierto y multiplataforma que admite la gestión de mods, personalización del juego, instalación de ModLoaders (Forge, NeoForge, Fabric, Quilt, LiteLoader y OptiFine), creación de modpacks, personalización de la interfaz de usuario y más.
|
||||
|
||||
HMCL tiene increíbles capacidades multiplataforma. No solo funciona en diferentes sistemas operativos como Windows, Linux, macOS y FreeBSD, sino que también es compatible con varias arquitecturas de CPU como x86, ARM, RISC-V, MIPS y LoongArch. Puedes disfrutar fácilmente de Minecraft en diferentes plataformas a través de HMCL.
|
||||
|
||||
Para los sistemas y arquitecturas de CPU compatibles con HMCL, consulta [esta tabla](PLATFORM.md).
|
||||
|
||||
## Descarga
|
||||
|
||||
Descarga la última versión desde el [sitio web oficial](https://hmcl.huangyuhui.net/download).
|
||||
|
||||
También puedes encontrar la última versión de HMCL en [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases).
|
||||
|
||||
Aunque no es necesario, se recomienda descargar las versiones solo de los sitios web oficiales mencionados anteriormente.
|
||||
|
||||
## 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
|
||||
|
||||
Simplemente ejecuta el siguiente comando en el directorio raíz del proyecto:
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
Asegúrate de tener instalado Java 17 o una versión posterior.
|
||||
|
||||
## Opciones de JVM (para depuración)
|
||||
|
||||
| Parámetro | Descripción |
|
||||
|---------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
|
||||
| `-Dhmcl.home=<ruta>` | Sobrescribe el directorio de HMCL |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | Omite la verificación de integridad propia al buscar actualizaciones |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | Sobrescribe la raíz de la API del proveedor de descargas BMCLAPI. Por defecto `https://bmclapi2.bangbang93.com` |
|
||||
| `-Dhmcl.font.override=<familia de fuente>` | Sobrescribe la familia de fuente |
|
||||
| `-Dhmcl.version.override=<versión>` | Sobrescribe el número de versión |
|
||||
| `-Dhmcl.update_source.override=<url>` | Sobrescribe la fuente de actualizaciones de HMCL |
|
||||
| `-Dhmcl.authlibinjector.location=<ruta>` | Usa el authlib-injector especificado (en vez de descargar uno) |
|
||||
| `-Dhmcl.openjfx.repo=<url del repositorio maven>` | Añade un repositorio Maven personalizado para descargar OpenJFX |
|
||||
| `-Dhmcl.native.encoding=<codificación>` | Sobrescribe la codificación nativa |
|
||||
| `-Dhmcl.microsoft.auth.id=<ID de App>` | Sobrescribe el ID de la App OAuth de Microsoft |
|
||||
| `-Dhmcl.microsoft.auth.secret=<Secreto de App>` | Sobrescribe el secreto de la App OAuth de Microsoft |
|
||||
| `-Dhmcl.curseforge.apikey=<Clave API>` | Sobrescribe la clave API de CurseForge |
|
||||
64
docs/README_ja.md
Normal file
64
docs/README_ja.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | **日本語** |
|
||||
[español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
## 紹介
|
||||
|
||||
HMCLはオープンソースでクロスプラットフォーム対応のMinecraftランチャーです。Mod管理、ゲームカスタマイズ、Modローダーのインストール（Forge、NeoForge、Fabric、Quilt、LiteLoader、OptiFine）、Modパック作成、UIカスタマイズなど、さまざまな機能をサポートしています。
|
||||
|
||||
HMCLは優れたクロスプラットフォーム性能を持っています。Windows、Linux、macOS、FreeBSDなどの異なるオペレーティングシステムだけでなく、x86、ARM、RISC-V、MIPS、LoongArchなどのさまざまなCPUアーキテクチャにも対応しています。HMCLを使えば、さまざまなプラットフォームでMinecraftを簡単に楽しむことができます。
|
||||
|
||||
HMCLが対応しているシステムやCPUアーキテクチャについては、[この表](PLATFORM.md)をご参照ください。
|
||||
|
||||
## ダウンロード
|
||||
|
||||
最新版は[公式サイト](https://hmcl.huangyuhui.net/download)からダウンロードできます。
|
||||
|
||||
また、[GitHub Releases](https://github.com/HMCL-dev/HMCL/releases)でも最新版を入手できます。
|
||||
|
||||
必要ではありませんが、上記の公式サイトからのみリリース版をダウンロードすることを推奨します。
|
||||
|
||||
## ライセンス
|
||||
|
||||
ライセンスについては [README.md](README.md#license) をご参照ください。
|
||||
|
||||
## コントリビューション
|
||||
|
||||
プルリクエストを送信したい場合、以下の要件を満たしてください。
|
||||
|
||||
* IDE：IntelliJ IDEA
|
||||
* コンパイラ：Java 17以上
|
||||
|
||||
### コンパイル方法
|
||||
|
||||
プロジェクトのルートディレクトリで次のコマンドを実行してください。
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
Java 17以上がインストールされていることを確認してください。
|
||||
|
||||
## JVMオプション（デバッグ用）
|
||||
|
||||
| パラメータ | 説明 |
|
||||
|----------------------------------------------|-----------------------------------------------------------------------------|
|
||||
| `-Dhmcl.home=<path>` | HMCLディレクトリを上書きします |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | アップデート時の自己整合性チェックをバイパスします |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | BMCLAPIダウンロードプロバイダーのAPIルートを上書きします。デフォルトは`https://bmclapi2.bangbang93.com`です |
|
||||
| `-Dhmcl.font.override=<font family>` | フォントファミリーを上書きします |
|
||||
| `-Dhmcl.version.override=<version>` | バージョン番号を上書きします |
|
||||
| `-Dhmcl.update_source.override=<url>` | HMCL本体のアップデートソースを上書きします |
|
||||
| `-Dhmcl.authlibinjector.location=<path>` | 指定したauthlib-injectorを使用します（ダウンロードせずに） |
|
||||
| `-Dhmcl.openjfx.repo=<maven repository url>` | OpenJFXダウンロード用のカスタムMavenリポジトリを追加します |
|
||||
| `-Dhmcl.native.encoding=<encoding>` | ネイティブエンコーディングを上書きします |
|
||||
| `-Dhmcl.microsoft.auth.id=<App ID>` | Microsoft OAuthアプリIDを上書きします |
|
||||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | Microsoft OAuthアプリシークレットを上書きします |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | CurseForge APIキーを上書きします |
|
||||
65
docs/README_lzh.md
Normal file
65
docs/README_lzh.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | **中文** ([简体](README_zh.md), [繁體](README_zh_Hant.md), **文言**) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
### 概說
|
||||
|
||||
HMCL 者，開源之礦藝啟者也。能理改囊，善於遊戲之自定，且自動安裝諸如 Forge、NeoForge、Fabric、Quilt、LiteLoader、OptiFine 諸改囊，亦可製作改囊集，界面亦可隨意更易。
|
||||
|
||||
HMCL 跨域甚廣。無論 Windows、Linux、macOS、FreeBSD 諸常見械綱，抑或 x86、ARM、RISC-V、MIPS、LoongArch 諸大構處理器，皆可運行。
|
||||
君可憑此，於諸算機間自如遊戲。
|
||||
|
||||
若欲詳知 HMCL 於諸算機之支援，請觀[此表](PLATFORM_zh_Hant.md)。
|
||||
|
||||
## 下載
|
||||
|
||||
請自 [HMCL 官網](https://hmcl.huangyuhui.net/download) 取其最新版。
|
||||
|
||||
亦可於 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 得其新者。
|
||||
|
||||
雖非強制，然猶勸自官網取之。
|
||||
|
||||
## 開源之約
|
||||
|
||||
詳見 [README_zh_Hant.md](README_zh_Hant.md#開源協議)。
|
||||
|
||||
## 貢獻
|
||||
|
||||
若欲獻 Pull Request，須遵下列：
|
||||
|
||||
* IDE 用 IntelliJ IDEA
|
||||
* 編譯器用爪哇十七以上
|
||||
|
||||
### 編造
|
||||
|
||||
於項目之根目錄，執下列令：
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
務必保汝已安裝爪哇十七或更高者。
|
||||
|
||||
## 爪哇虛機之通弦（以資勘誤）
|
||||
|
||||
| 參數 | 解釋 |
|
||||
|----------------------------------------------|---------------------------------------------------------|
|
||||
| `-Dhmcl.home=<path>` | 易 HMCL 之用戶目錄 |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時不驗本體之全 |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | 易 BMCLAPI 之 API 根，預設為 `https://bmclapi2.bangbang93.com` |
|
||||
| `-Dhmcl.font.override=<font family>` | 易書體 |
|
||||
| `-Dhmcl.version.override=<version>` | 易版 |
|
||||
| `-Dhmcl.update_source.override=<url>` | 易 HMCL 之更新所 |
|
||||
| `-Dhmcl.authlibinjector.location=<path>` | 用所指之 authlib-injector，毋需下載 |
|
||||
| `-Dhmcl.openjfx.repo=<maven repository url>` | 增 OpenJFX 下載之自定 Maven 庫 |
|
||||
| `-Dhmcl.native.encoding=<encoding>` | 易本地編碼 |
|
||||
| `-Dhmcl.microsoft.auth.id=<App ID>` | 易 Microsoft OAuth 之 App ID |
|
||||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | 易 Microsoft OAuth 之金鑰 |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | 易 CurseForge 之 API 金鑰 |
|
||||
64
docs/README_ru.md
Normal file
64
docs/README_ru.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | **русский** | [українська](README_uk.md)
|
||||
|
||||
## Введение
|
||||
|
||||
HMCL — это открытый, кроссплатформенный лаунчер для Minecraft с поддержкой управления модами, настройки игры, установки загрузчиков модов (Forge, NeoForge, Fabric, Quilt, LiteLoader и OptiFine), создания модпаков, настройки интерфейса и многого другого.
|
||||
|
||||
HMCL обладает отличной кроссплатформенностью. Он работает не только на различных операционных системах, таких как Windows, Linux, macOS и FreeBSD, но и поддерживает различные архитектуры процессоров: x86, ARM, RISC-V, MIPS и LoongArch. Благодаря HMCL вы можете легко наслаждаться Minecraft на разных платформах.
|
||||
|
||||
Список поддерживаемых систем и архитектур процессоров HMCL смотрите в [этой таблице](PLATFORM.md).
|
||||
|
||||
## Загрузка
|
||||
|
||||
Скачайте последнюю версию с [официального сайта](https://hmcl.huangyuhui.net/download).
|
||||
|
||||
Также вы можете найти последнюю версию HMCL в [релизах на GitHub](https://github.com/HMCL-dev/HMCL/releases).
|
||||
|
||||
Хотя это не обязательно, рекомендуется скачивать релизы только с указанных выше официальных сайтов.
|
||||
|
||||
## Лицензия
|
||||
|
||||
См. [README.md](README.md#license).
|
||||
|
||||
## Вклад
|
||||
|
||||
Если вы хотите отправить pull request, ознакомьтесь с требованиями:
|
||||
|
||||
* IDE: IntelliJ IDEA
|
||||
* Компилятор: Java 17+
|
||||
|
||||
### Сборка
|
||||
|
||||
Выполните следующую команду в корневой директории проекта:
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
Убедитесь, что у вас установлена Java 17 или новее.
|
||||
|
||||
## Параметры JVM (для отладки)
|
||||
|
||||
| Параметр | Описание |
|
||||
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------|
|
||||
| `-Dhmcl.home=<путь>` | Переопределить директорию HMCL |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | Отключить проверку целостности при проверке обновлений |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | Переопределить корневой API-адрес провайдера загрузки BMCLAPI. По умолчанию `https://bmclapi2.bangbang93.com` |
|
||||
| `-Dhmcl.font.override=<название шрифта>` | Переопределить семейство шрифтов |
|
||||
| `-Dhmcl.version.override=<версия>` | Переопределить номер версии |
|
||||
| `-Dhmcl.update_source.override=<url>` | Переопределить источник обновлений для самого HMCL |
|
||||
| `-Dhmcl.authlibinjector.location=<путь>` | Использовать указанный authlib-injector (вместо загрузки) |
|
||||
| `-Dhmcl.openjfx.repo=<url репозитория maven>` | Добавить пользовательский Maven-репозиторий для загрузки OpenJFX |
|
||||
| `-Dhmcl.native.encoding=<кодировка>` | Переопределить нативную кодировку |
|
||||
| `-Dhmcl.microsoft.auth.id=<App ID>` | Переопределить Microsoft OAuth App ID |
|
||||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | Переопределить Microsoft OAuth App Secret |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | Переопределить CurseForge API Key |
|
||||
64
docs/README_uk.md
Normal file
64
docs/README_uk.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | 中文 ([简体](README_zh.md), [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | [русский](README_ru.md) | **українська**
|
||||
|
||||
## Вступ
|
||||
|
||||
HMCL — це відкритий, кросплатформний лаунчер для Minecraft, який підтримує керування модами, налаштування гри, встановлення модлоадерів (Forge, NeoForge, Fabric, Quilt, LiteLoader та OptiFine), створення модпаків, налаштування інтерфейсу та багато іншого.
|
||||
|
||||
HMCL має чудові кросплатформні можливості. Він працює не лише на різних операційних системах, таких як Windows, Linux, macOS і FreeBSD, а й підтримує різні архітектури процесорів, такі як x86, ARM, RISC-V, MIPS і LoongArch. Ви можете легко насолоджуватися Minecraft на різних платформах за допомогою HMCL.
|
||||
|
||||
Щодо підтримуваних систем і архітектур процесорів дивіться [цю таблицю](PLATFORM.md).
|
||||
|
||||
## Завантаження
|
||||
|
||||
Завантажте останню версію з [офіційного сайту](https://hmcl.huangyuhui.net/download).
|
||||
|
||||
Також ви можете знайти останню версію HMCL у [релізах GitHub](https://github.com/HMCL-dev/HMCL/releases).
|
||||
|
||||
Хоча це не обовʼязково, рекомендується завантажувати релізи лише з офіційних сайтів, зазначених вище.
|
||||
|
||||
## Ліцензія
|
||||
|
||||
Дивіться [README.md](README.md#license).
|
||||
|
||||
## Внесок
|
||||
|
||||
Якщо ви хочете надіслати pull request, ознайомтеся з наступними вимогами:
|
||||
|
||||
* IDE: IntelliJ IDEA
|
||||
* Компілятор: Java 17+
|
||||
|
||||
### Компіляція
|
||||
|
||||
Просто виконайте наступну команду в кореневому каталозі проєкту:
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
Переконайтеся, що у вас встановлено Java 17 або новішої версії.
|
||||
|
||||
## 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 |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | Override CurseForge API Key |
|
||||
72
docs/README_zh.md
Normal file
72
docs/README_zh.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | **中文** (**简体**, [繁體](README_zh_Hant.md), [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
## 简介
|
||||
|
||||
HMCL 是一款开源、跨平台的 Minecraft 启动器，支持模组管理、游戏自定义、游戏自动安装 (Forge、NeoForge、Fabric、Quilt、LiteLoader 和 OptiFine)、整合包创建、界面自定义等功能。
|
||||
|
||||
HMCL 有着强大的跨平台能力。它不仅支持 Windows、Linux、macOS、FreeBSD 等常见的操作系统，同时也支持 x86、ARM、RISC-V、MIPS、LoongArch 等不同的 CPU 架构。你可以使用 HMCL 在不同平台上轻松地游玩 Minecraft。
|
||||
|
||||
如果你想要了解 HMCL 对不同平台的支持程度，请参见 [此表格](PLATFORM_zh.md)。
|
||||
|
||||
## 下载
|
||||
|
||||
请从 [HMCL 官网](https://hmcl.huangyuhui.net/download) 下载最新版本的 HMCL。
|
||||
|
||||
你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下载最新版本的 HMCL。
|
||||
|
||||
虽然并不强制，但仍建议通过 HMCL 官网下载启动器。
|
||||
|
||||
## 开源协议
|
||||
|
||||
该程序在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 开源协议下发布，同时附有以下附加条款。
|
||||
|
||||
### 附加条款 (依据 GPLv3 开源协议第七条)
|
||||
|
||||
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+
|
||||
|
||||
### 编译
|
||||
|
||||
于项目根文件夹执行以下命令：
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
请确保你至少安装了 JDK 17 或更高版本。
|
||||
|
||||
## JVM 选项 (用于调试)
|
||||
|
||||
| 参数 | 简介 |
|
||||
| -------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `-Dhmcl.home=<path>` | 覆盖 HMCL 数据文件夹 |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | 检查更新时不检查本体完整性 |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | 覆盖 BMCLAPI 的 API Root，默认值为 `https://bmclapi2.bangbang93.com` |
|
||||
| `-Dhmcl.font.override=<font family>` | 覆盖字族 |
|
||||
| `-Dhmcl.version.override=<version>` | 覆盖版本号 |
|
||||
| `-Dhmcl.update_source.override=<url>` | 覆盖 HMCL 更新源 |
|
||||
| `-Dhmcl.authlibinjector.location=<path>` | 使用指定的 authlib-injector (而非下载一个) |
|
||||
| `-Dhmcl.openjfx.repo=<maven repository url>` | 添加用于下载 OpenJFX 的自定义 Maven 仓库 |
|
||||
| `-Dhmcl.native.encoding=<encoding>` | 覆盖原生编码 |
|
||||
| `-Dhmcl.microsoft.auth.id=<App ID>` | 覆盖 Microsoft OAuth App ID |
|
||||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | 覆盖 Microsoft OAuth App 密钥 |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | 覆盖 CurseForge API 密钥 |
|
||||
72
docs/README_zh_Hant.md
Normal file
72
docs/README_zh_Hant.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Hello Minecraft! Launcher
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://docs.hmcl.net/groups.html)
|
||||
|
||||
[English](README.md) | **中文** ([简体](README_zh.md), **繁體**, [文言](README_lzh.md)) | [日本語](README_ja.md) |
|
||||
[español](README_es.md) | [русский](README_ru.md) | [українська](README_uk.md)
|
||||
|
||||
## 簡介
|
||||
|
||||
HMCL 是一款開源、跨平臺的 Minecraft 啟動器，支援模組管理、遊戲客製化、遊戲自動安裝 (Forge、NeoForge、Fabric、Quilt、LiteLoader 和 OptiFine)、模組包建立、介面客製化等功能。
|
||||
|
||||
HMCL 有著強大的跨平臺能力。它不僅支援 Windows、Linux、macOS、FreeBSD 等常見的作業系統，同時也支援 x86、ARM、RISC-V、MIPS、LoongArch 等不同的 CPU 架構。你可以使用 HMCL 在不同平臺上輕鬆地遊玩 Minecraft。
|
||||
|
||||
如果你想要了解 HMCL 對不同平臺的支援程度，請參見 [此表格](PLATFORM_zh_Hant.md)。
|
||||
|
||||
## 下載
|
||||
|
||||
請從 [HMCL 官網](https://hmcl.huangyuhui.net/download) 下載最新版本的 HMCL。
|
||||
|
||||
你也可以在 [GitHub Releases](https://github.com/HMCL-dev/HMCL/releases) 中下載最新版本的 HMCL。
|
||||
|
||||
雖然並不強制，但仍建議透過 HMCL 官網下載啟動器。
|
||||
|
||||
## 開源協議
|
||||
|
||||
該程式在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 開源協議下發布，同時附有以下附加條款。
|
||||
|
||||
### 附加條款 (依據 GPLv3 開源協議第七條)
|
||||
|
||||
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+
|
||||
|
||||
### 編譯
|
||||
|
||||
於項目根目錄執行以下指令：
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
請確保你至少安裝了 JDK 17 或更高版本。
|
||||
|
||||
## JVM 選項 (用於除錯)
|
||||
|
||||
| 參數 | 簡介 |
|
||||
| -------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `-Dhmcl.home=<path>` | 覆蓋 HMCL 使用者目錄 |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | 檢查更新時不檢查本體完整性 |
|
||||
| `-Dhmcl.bmclapi.override=<url>` | 覆蓋 BMCLAPI 的 API Root，預設值為 `https://bmclapi2.bangbang93.com` |
|
||||
| `-Dhmcl.font.override=<font family>` | 覆蓋字族 |
|
||||
| `-Dhmcl.version.override=<version>` | 覆蓋版本號 |
|
||||
| `-Dhmcl.update_source.override=<url>` | 覆蓋 HMCL 更新來源 |
|
||||
| `-Dhmcl.authlibinjector.location=<path>` | 使用指定的 authlib-injector (而非下載一個) |
|
||||
| `-Dhmcl.openjfx.repo=<maven repository url>` | 添加用於下載 OpenJFX 的自訂 Maven 倉庫 |
|
||||
| `-Dhmcl.native.encoding=<encoding>` | 覆蓋原生編碼 |
|
||||
| `-Dhmcl.microsoft.auth.id=<App ID>` | 覆蓋 Microsoft OAuth App ID |
|
||||
| `-Dhmcl.microsoft.auth.secret=<App Secret>` | 覆蓋 Microsoft OAuth App 金鑰 |
|
||||
| `-Dhmcl.curseforge.apikey=<Api Key>` | 覆蓋 CurseForge API 金鑰 |
|
||||
Reference in New Issue
Block a user