README.md

Phoenix Framework

Cross server-side plugin framework.

Languages: English,简体中文

Introduction

Phoenix is a open source Minecraft server plugin framework that makes your plugin developing easier.

The main goals of the project are to make Phoenix can be loaded on Spigot, Sponge, Nukkit and some other Minecraft server software.

Docs

The best place to receive support is on GitHub issues.

Javadocs for PhoenixAPI can be found here.

The official developing guide is on Wiki

Building

1. Setup

This project require Java 8 or above.

After installing Oracle JDK (recommended) or OpenJDK, and Maven, checkout the source:

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

2. Build

mvn install

The final jar will be placed in target/ named Phoenix-API-X.X.X-SNAPSHOT.jar.

Using

Maven

Add the flowing code to your 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>

Contributing

We will always have a need for developers to help improve Phoenix.

Pull request

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create new Pull Request.

Join us

You can find us on Telegram: Click here.

Licensing

PhoenixAPI is open-source software released under the MIT license. Please see the LICENSE file for details.