mirror of
https://github.com/HMCL-dev/HMCL.git
synced 2025-04-06 18:20:26 +08:00
feat(README_cn.md): Added Chinese translation for README.md (#1637)
* feat(README_cn.md): Added Chinese translation for README.md * edit(README.md): Improved formats for README.md * fix(README): Roll back to Commit ID to pin lines * edit(README): Let languages switchers "more like buttons" * fix(README): Fix errors caused by misunderstanding * edit(README): Added 8 spaces
This commit is contained in:
K1t3AB
GitHub
parent
675af3a5aa
commit
2d182807b2
62
README.md
62
README.md
@ -1,67 +1,59 @@
|
||||
# ⛏ Hello Minecraft! Launcher 💎
|
||||
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://kook.top/Kx7n3t)
|
||||
|
||||
## Introduction
|
||||
English | [中文](https://github.com/huanghongxun/HMCL/blob/javafx/README_cn.md)
|
||||
|
||||
HMCL is a Minecraft launcher which supports Mod management, game customizing, auto installing(Forge, Fabric, LiteLoader and OptiFine), modpack creating, UI customization, and more.
|
||||
## Introduction
|
||||
HMCL is a Minecraft launcher which supports Mod Management, Game Customizing, Auto Installing (Forge, Fabric, LiteLoader and OptiFine), Modpack Creating, UI Customization, and more.
|
||||
|
||||
No plugin API is provided.
|
||||
|
||||
## Download
|
||||
Download the latest version [from the official website](https://hmcl.huangyuhui.net/download).
|
||||
Download the latest version from [the official website](https://hmcl.huangyuhui.net/download).
|
||||
|
||||
Note: The recent version released in Github is the beta version, 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.
|
||||
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 [GPL v3](https://www.gnu.org/licenses/gpl-3.0.html) with additional terms.
|
||||
The software is distributed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) with 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/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374)\]
|
||||
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/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374))
|
||||
|
||||
The software name and the version number can be edited [here](https://github.com/huanghongxun/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L32-L34).
|
||||
The software name and the version number can be edited [here](https://github.com/huanghongxun/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/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370)\]
|
||||
|
||||
Chinese Translation:
|
||||
### 附加条款（依据 GPLv3 协议第七条）
|
||||
1. 当你分发本程序的修改版本时，你必须以一种合理的方式修改本程序的名称或版本号，以示其与原始版本不同。\[[依据 GPLv3, 7(c).](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374)\]
|
||||
|
||||
本程序的名称及版本号可在[此处](https://github.com/huanghongxun/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L32-L34)修改。
|
||||
|
||||
2. 你不得移除本程序所显示的版权声明。\[[依据 GPLv3, 7(b).](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370)\]
|
||||
2. You must not remove the copyright declaration displayed in the software. (Under [GPLv3, 7(b)](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370))
|
||||
|
||||
## 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.
|
||||
* IDE: Intellij IDEA
|
||||
* Compiler: Java 1.8
|
||||
* Do NOT modify `gradle` files
|
||||
|
||||
### Compilation
|
||||
Simply execute the following command in project root directory:
|
||||
|
||||
Simply execute the following command:
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
Make sure you have Java installed with JavaFX 8 at least. Liberica full JDK 8 or later is recommended.
|
||||
|
||||
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.|
|
||||
| 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. |
|
||||
|
||||
59
README_cn.md
Normal file
59
README_cn.md
Normal file
@ -0,0 +1,59 @@
|
||||
# ⛏ Hello Minecraft! Launcher 💎
|
||||
[](https://ci.huangyuhui.net/job/HMCL)
|
||||
|
||||
|
||||
[](https://discord.gg/jVvC7HfM6U)
|
||||
[](https://kook.top/Kx7n3t)
|
||||
|
||||
[English](https://github.com/huanghongxun/HMCL/blob/javafx/README.md) | 中文
|
||||
|
||||
## 简介
|
||||
HMCL 是一款 Minecraft 启动器, 支持 Mod 管理, 游戏自定义, 游戏自动安装 (Forge, Fabric, LiteLoader 与 OptiFine), 模组包创建, 界面自定义等功能.
|
||||
|
||||
不提供插件 API.
|
||||
|
||||
## 下载
|
||||
请从 [HMCL 官网](https://hmcl.huangyuhui.net/download)下载最新版本的 HMCL.
|
||||
|
||||
注: 在 GitHub 发布的最新版 HMCL 为测试版, 与官网上发布的正式版相比, 它们包含额外的测试功能. 但是, 它们相较于正式版更不稳定, 您更有可能在使用测试版的过程中遇到 Bug 或意外问题.
|
||||
|
||||
虽然并不强制, 但仍建议通过 HMCL 官网下载启动器.
|
||||
|
||||
## 开源协议
|
||||
该程序在 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 开源协议下发布, 同时附有附加条款.
|
||||
|
||||
### 附加条款 (依据 GPLv3 开源协议第七条)
|
||||
1. 当您分发该程序的修改版本时, 您必须以一种合理的方式修改该程序的名称或版本号, 以示其与原始版本不同. (依据 [GPLv3, 7(c)](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L372-L374))
|
||||
|
||||
该程序的名称及版本号可在[此处](https://github.com/huanghongxun/HMCL/blob/javafx/HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java#L33-L35)修改.
|
||||
|
||||
2. 您不得移除该程序所显示的版权声明. (依据 [GPLv3, 7(b)](https://github.com/huanghongxun/HMCL/blob/11820e31a85d8989e41d97476712b07e7094b190/LICENSE#L368-L370))
|
||||
|
||||
## 贡献
|
||||
如果您想提交一个 Pull Request, 必须遵守如下要求:
|
||||
* IDE: Intellij IDEA
|
||||
* 编译器: Java 1.8
|
||||
* **不要**修改 `gradle` 相关文件
|
||||
|
||||
### 编译
|
||||
于项目根目录执行以下命令:
|
||||
|
||||
```bash
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
请确保您至少安装了含有 JavaFX 8 的 Java. 建议使用 Liberica Full JDK 8 或更高版本.
|
||||
|
||||
## JVM 选项 (用于调试)
|
||||
| 参数 | 简介 |
|
||||
| -------------------------------------------- | ------------------------------------------- |
|
||||
| `-Dhmcl.self_integrity_check.disable=true` | 检查更新时绕过本体完整性检查. |
|
||||
| `-Dhmcl.bmclapi.override=<version>` | 覆盖 BMCLAPI 的 API Root, 默认值为 `https://bmclapi2.bangbang93.com`. 例如 `https://download.mcbbs.net`. |
|
||||
| `-Dhmcl.font.override=<font family>` | 覆盖字族. |
|
||||
| `-Dhmcl.version.override=<version>` | 覆盖版本号. |
|
||||
| `-Dhmcl.update_source.override=<url>` | 覆盖更新源. |
|
||||
| `-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 密钥. |
|
||||
Loading…
x
Reference in New Issue
Block a user