mirror/HMCL
2
0
Fork 0
mirror of https://github.com/HMCL-dev/HMCL.git synced 2024-11-21 03:10:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

README & PLATFORM docs post-fixes (#3417)

Browse Source
This commit is contained in:
3gf8jv4dv 2024-11-02 17:36:41 +08:00 committed by GitHub
parent 16d304dbb4
commit 1378d1445a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
PLATFORM.md
View File

@ -17,20 +17,20 @@
Legend:
* ✅: Official supported platform.
* ✅: Officially supported platform.
Fully supported by Mojang official. Problems encountered in the game should be directly reported to the Mojang.
Fully supported by Mojang officials. Problems encountered in the game should be directly reported to the Mojang.
* 👌: Supported platforms.
Support is provided by HMCL, tested to work, but may have more issues than a fully supported platform.
Support is provided by HMCL, tested to work, but may have more problems than a fully supported platform.
Support for versions below Minecraft 1.6 is not guaranteed.
If you encounter a problem that does not exist on fully supported platforms, you can report it to HMCL.
* ❔: Low level supported platforms.
* ❔: Low-level supported platforms.
HMCL can run on this platform and has some basic support. However, launching the game directly is not yet available.
If you want to start the game, you will need to get the native libraries needed by Minecraft in other way and specify the native path in the instance settings.
If you want to start the game, you will need to get the native libraries needed by Minecraft in another way and specify the native path in the instance settings.
* `/`: Not applicable.

14
README.md
View File

@ -10,7 +10,7 @@
## 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 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.
@ -46,7 +46,7 @@ If you want to submit a pull request, here are some requirements:
### Compilation
Simply execute the following command in project root directory:
Simply execute the following command in the project root directory:
```bash
./gradlew clean build
@ -59,13 +59,13 @@ Make sure you have at least JavaFX 8 installed. Liberica Full JDK 8 or later is
| Parameter | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `-Dhmcl.home=<path>` | Override HMCL directory |
| `-Dhmcl.self_integrity_check.disable=true` | Bypass the self integrity check when checking for update |
| `-Dhmcl.bmclapi.override=<url>` | Override API Root of BMCLAPI download provider, defaults to `https://bmclapi2.bangbang93.com` |
| `-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 specified authlib-injector (instead of downloading one) |
| `-Dhmcl.openjfx.repo=<maven repository url>` | Add custom Maven repository for download OpenJFX |
| `-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.microsoft.auth.secret=<App Secret>` | Override Microsoft OAuth App Secret |