README.zhcn.md

Phoenix Framework

跨服务端插件框架.

语言: English,简体中文

介绍

Phoenix 是一个开源的 Minecraft 服务端插件框架， 让你的开发更简单。

这个项目主要目的是让您今后的插件可以同时在 Spigot、 Sponge、 Nukkit等其他服务端上加载， 而不用操心移植的问题。

文档

您可以在 GitHub issues 寻求帮助.

PhoenixAPI 的 Javadoc 可以在 这里 查看.

@Lss233 正在 Phoenix Framework 编写一个中文版的教程， 您可以在 这里 查看。

构建

1. 初始化

这个项目需要Java 8 或以上版本。

在安装 Oracle JDK (推荐) 或 OpenJDK, 和 Maven之后, 下载源码:

git clone https://github.com/ThePhoenixMC/PhoenixAPI.git
cd PhoenixAPI

2. 编译

mvn install

最终的jar文件将会在 target/ 文件夹， 名为 Phoenix-API-X.X.X-SNAPSHOT.jar.

使用

Maven

在您的 pom.xml 适当位置添加以下内容:

    <repositories>
        <repository>
            <id>lss233-repo</id>
            <name>Lss233's Minecraft Repository</name>
            <url>https://lss233.com/artifactory/minecraft</url>
        </repository>    
    </repositories>
    <dependencies>
        <dependency>
            <groupId>com.lss233.phoenix</groupId>
            <artifactId>Phoenix-API</artifactId>
            <version>THE_LAST_VERSION_OF_PHOENIX_API</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

贡献

我们需要开发者协助我们开发Phoenix, 您可以通过以下两种方式协助我们:

Pull request

1. Fork这个项目.
2. 创建您的特性分支 (git checkout -b my-new-feature).
3. 提交您的改动 (git commit -am '修复Bug').
4. 提交您的分支 (git push origin my-new-feature).
5. 创建Pull Request.

加入小组

我们的QQ群号为: 498385830
当然，您也可以在Telegram上找到我们的群组: 点击这里

许可

PhoenixAPI 是一个使用 MIT 协议的开源项目. 您可以在 LICENSE 文件中查看详情.