mirror of
https://github.com/HMCL-dev/HMCL.git
synced 2024-11-21 03:10:58 +08:00
Update README.md
This commit is contained in:
parent
b36c194f67
commit
88194e479e
41
README.md
41
README.md
@ -1,24 +1,31 @@
|
||||
# Hello Minecraft! Launcher [![Build Status](https://travis-ci.org/huanghongxun/HMCL.svg?branch=master)](https://travis-ci.org/huanghongxun/HMCL)
|
||||
License is GPL v3, see http://www.gnu.org/licenses/gpl.html
|
||||
开源协议为GPL v3, 详情参见http://www.gnu.org/licenses/gpl.html
|
||||
|
||||
## 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.
|
||||
HMCL是一个Minecraft启动器,支持Mod管理,游戏定制,自动安装,整合包制作,界面主题定制等功能。
|
||||
并且一天的使用次数在工作日时有40万左右、节假日有150万左右的使用次数,也就是说日活跃用户在10万以上。
|
||||
但是本项目的代码不够完善,希望有更多的人能加入HMCL的开发。
|
||||
|
||||
This application has more than 100,000 users and would be opened more than 500,000 times per day.
|
||||
## 贡献
|
||||
如果你很想为本项目贡献代码,这里有一些要求:
|
||||
* 开发环境为Netbeans 8.1
|
||||
* 编译器为Java 1.8,通过retrolambda兼容Java 1.7,所以请不要使用Java 8的新API(如Stream)
|
||||
* 请不要修改`gradle`文件
|
||||
|
||||
But the code of this app is not strong, I hope someone could join the development of this app and make this app stronger.
|
||||
## 代码
|
||||
* 包 `org.jackhuang.hellominecraft.util` 为HMCL和HMCSM的共用工具代码
|
||||
* 包 `org.jackhuang.hellominecraft.launcher` 包含了HMCL的界面以及逻辑代码
|
||||
* 包 `org.jackhuang.hellominecraft.launcher.core` 为HMCL的启动核心
|
||||
* 包 `org.jackhuang.hellominecraft.launcher.api` 是HMCL为了便于定制提供的API,暂不支持加载插件
|
||||
* 包 `org.jackhuang.hellominecraft.svrmgr` 为HMCSM的所有代码
|
||||
* 文件夹 `HMCUtils/src/main/resources/org/jackhuang/hellominecraft/lang` 包含了HMCL和HMCSM使用的语言文件
|
||||
|
||||
由于包树已经相当清晰,因此不再赘述各包各类的用途。
|
||||
|
||||
## Contribution
|
||||
If you really want to join the development, here's some requests.
|
||||
* 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.
|
||||
## 注意事项
|
||||
* 包 `org.jackhuang.hellominecraft.util.logging` 包含了经过精简的Apache License 2.0的Log4j项目的代码
|
||||
* 包 `com.google.gson` 为Google Gson项目Apache License 2.0的代码
|
||||
* 包 `org.jackhuang.hellominecraft.lookandfeel.ui` 包含了Sun Microsystems的NimbusLookAndFeel项目的部分LGPL代码
|
||||
* 所有Pull Request提交的代码均会被重写
|
||||
* 本项目的开源协议是GPL v3,因此包含LGPL和Apache License 2.0的代码是没有法律问题的
|
||||
|
Loading…
Reference in New Issue
Block a user