lan/HMCL
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
huangyuhui
2016-02-26 13:40:41 +08:00
parent 0817b9aebb
commit 09dbade477
2 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,9 +1,24 @@
# Hello Minecraft! Launcher [![Build Status](https://travis-ci.org/huanghongxun/HMCL.svg?branch=master)](https://travis-ci.org/huanghongxun/HMCL)
Hello Minecraft! Launcher is a Minecraft launcher.
License is GPL v3, see http://www.gnu.org/licenses/gpl.html
### Joining
## Introduction
This application is a Minecraft launcher that supports mod management, game modification, auto-installing Minecraft/Forge/LiteLoader/OptiFine, modpack manufacture, UI theme customization, and so on.
This application has more than 100,000 users and would be opened more than 500,000 times per day.
But the code of this app is not strong, I hope someone could join the development of this app and make this app stronger.
## Contribution
If you really want to join the development, here's some requests.
* The Development Environment is Netbeans 8.0.2 with Gradle Support plugin.
* The project is built on Java 1.8, using the retrolambda backported to Java 1.7. So DO NOT use the libraries of Java 8 like Stream APIs.
* DO NOT modify *.gradle.
* The Development Environment is Netbeans 8.0.2 with plugin: Gradle Support.
* The project is built on Java 1.8 using the retrolambda backporting to Java 1.7. So DO NOT use the libraries of Java 8 like Stream APIs.
* DO NOT modify any file whose suffix is `gradle`.
## Code tree
* Package `hmc.util` contains all the utilities that HMCL and HMCSM depend on.
* Package `hmc.launcher` contains HMCL ui, a few utility codes.
* Package `hmc.launcher.core` contains all the Minecraft Launcher logic that the HMCL supports.
* Package `hmc.svrmgr` contains all HMCSM logic.
* Folder `HMCLAPI/src/main/resources/org/jackhuang/hellominecraft/lang` contains all the localization files that HMCL and HMCSM used. If you are good at translation, you could join the localization plan by opening a pull request.