mirror of
https://github.com/HMCL-dev/HMCL.git
synced 2024-12-15 06:50:12 +08:00
242df8a81a
* Support #2376 * Add necessary @Nullable annotations * Display different types of dependencies in different sections. * Fix checkstyle * Add I18N for different types of dependencies. * Enhance UI * Code cleanup * Enhance UI * Manually sort the result from curseforge when searching mods by name. * Render the search results from remote mod repositories in several pages. * Fix merge * Fix * Add a button which navigates to the modpack download page in the modpack installl page * Fix I18N * Render the mod loaders supported by the version in mod info page. * Fix #2104 * Enhance TwoLineListItem * Render the mod loader supported by this mod file on the ModListPage * Fix chinese searching and curseforge searching * Update I18N * Fix * Fix * Select the specific game version when clicking the 'download' button on ModListPage * Support HMCL to update mod_data and mod_pack data from https://github.com/huanghongxun/HMCL/raw/javafx/data-json/dynamic-remote-resources.json * Enhance :HMCL:build.gradle.kts * Revert parse_mcmod_data.py * Abstract 'new Image' to FXUtils.newBuiltinImage and FXUtils.newRemoteImage FXUtils.newBuiltinImage is used to load image which is supposed to be correct definitely and is a file within the jar. Or, it will throw ResourceNotFoundError. FXUtils.newRemoteImage is used to load image from the internet. It will cache the data of images for the further usage. The cached data will be deleted when HMCL is closed or hidden. * Add javadoc for FXUtils.newBuiltinImage and FXUtils.newRemoteImage. * Fix checkstyle * Fix * Fix * Fix * Add license for RemoteResourceManager * Remove TODO * Enhance Chinese searching * Support to decode metadata for local quilt mod. * Enhance ModManager * Fix checkstyle * Refactor * Fix * Fix * Refactor DownloadPage * Fix * Revert "Refactor DownloadPage" This reverts commit953558da77. * Refactor DownloadPage * Refactor * Fix * Fix checkstyle * Set org.jackhuang.hmcl.ui.construct.TwoLineListItem.TagChangeListener as a private static inner class. * Fix * Fix * Fix * Enhance SimpleMultimap * Revert TwoLineListItem * Fix * Code cleanup * Code cleanup * Fix * Code cleanup * Add license for IModMetadataReader * Add prefix 'Minecraft' at the supported minecrft version list in DownloadPage * Fix #2498 * Update README_cn.md * Opti ModMananger * Log a warning message when 'hmcl.update_source.override' is used. * Fix chinese searching * Enhance chinese searching. * Enhance memory usage * Close the mod version dialog window after clicking the downloading / save as button if the dependency list is empty. * Cache builtin images. * Enhance FXUtils (Make tooltip installer faster). * Fix * Fix * Fix #2560 * Fix typo * Fix remote image cache. * Fix javadoc * Fix checkstyle * Optimize FXUtils::shutdown * Fix merge * I have no idea on why the sha1 was matched. * Revert "Enhance FXUtils (Make tooltip installer faster)." This reverts commit0a49eb2c12. * Support multi download source in order balance the traffic of hmcl.huangyuhui.net and the download speed in China Mainland. * Modify dynamic remote resource urls. * Optimize codes with StringUtils.DynamicCommonSubsequence. * Prevent unofficial HMCL to access HMCL Resource Update URL. * Zip the dynamic-remote-resources json by Gradle automatically. * Remove unnecessary getters. --------- Co-authored-by: Burning_TNT <pangyl08@163.com“>
77 lines
5.4 KiB
Markdown
77 lines
5.4 KiB
Markdown
# ⛏ Hello Minecraft! Launcher 💎
|
|
|
|
[](https://ci.huangyuhui.net/job/HMCL)
|
|
|
|
|
|
[](https://discord.gg/jVvC7HfM6U)
|
|
[](https://kook.top/Kx7n3t)
|
|
|
|
English | [中文](README_cn.md)
|
|
|
|
## Introduction
|
|
|
|
HMCL is a cross-platform Minecraft launcher which supports Mod Management, Game Customizing, Auto Installing (Forge, Fabric, Quilt, LiteLoader and OptiFine), Modpack Creating, UI Customization, and more.
|
|
|
|
HMCL has amazing cross-platform capabilities.
|
|
It can not only run on different operating systems such as Windows, Linux, and macOS,
|
|
but also supports multiple CPU architectures such as x86, arm, mips, and loongarch.
|
|
You can easily play Minecraft on different platforms through HMCL.
|
|
|
|
For systems and CPU architectures supported by HMCL, see [this table](PLATFORM.md).
|
|
|
|
## Download
|
|
|
|
Download the latest version from [the official website](https://hmcl.huangyuhui.net/download).
|
|
|
|
You can also download the latest version of HMCL in [GitHub Releases](https://github.com/huanghongxun/HMCL/releases).
|
|
|
|
Although not necessary, it is recommended to download the ones from the official website.
|
|
|
|
## License
|
|
|
|
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))
|
|
|
|
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))
|
|
|
|
## 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
|
|
|
|
### Compilation
|
|
|
|
Simply execute the following command in project root directory:
|
|
|
|
```bash
|
|
./gradlew clean build
|
|
```
|
|
|
|
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.home=<path>` | Override HMCL directory. |
|
|
| `-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 for HMCL itself. (Deprecated, please use `hmcl.hmcl_update_source.override` instead.) |
|
|
| `-Dhmcl.hmcl_update_source.override=<url>` | Override the update source for HMCL itself. |
|
|
| `-Dhmcl.resource_update_source.override=<url>` | Override the update source for dynamic remote resources. |
|
|
| `-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. |
|