Files
HMCL/README.md
2016-06-27 10:23:39 +08:00

31 lines
1.8 KiB
Markdown
Executable File
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Hello Minecraft! Launcher [![Build Status](https://travis-ci.org/huanghongxun/HMCL.svg?branch=master)](https://travis-ci.org/huanghongxun/HMCL)
开源协议为GPL v3, 详情参见http://www.gnu.org/licenses/gpl.html
## 介绍
HMCL是一个Minecraft启动器支持Mod管理游戏定制自动安装整合包制作界面主题定制等功能。
但是本项目的代码不够完善希望有更多的人能加入HMCL的开发。
## 贡献
如果你很想为本项目贡献代码,这里有一些要求:
* 开发环境为Netbeans 8.1
* 编译器为Java 1.8通过retrolambda兼容Java 1.7所以请不要使用Java 8的新API如Stream
* 请不要修改`gradle`文件
## 代码
*`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使用的语言文件
由于包树已经相当清晰,因此不再赘述各包各类的用途。
## 注意事项
*`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的代码是没有法律问题的