Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.6 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.6 KB

PhoenixSponge

A Sponge implementation of the Phoenix API.

Codacy Badge TeamCity Telegram LICENSE

Requirements

  • Java 1.8 or higher

Cloning

The following steps will ensure your project is cloned properly.

git clone  --recursive https://github.com/ThePhoenixMC/PhoenixSponge.git

Updating

The following steps will update your clone with the official repo.

git pull
git submodule update --recursive

Building

  1. Cloning project
  2. Building:
./mvnw clean install

You can find the compiled JAR files in PhoenixForSponge/target directory.

Running

After building the project, drop `PhoenixForSponge-x.x.x-x-x.x-x.jar' to your server's plugin directory, and then restart your server.

  • You can put your Phoenix Module to 'modules' directory.
  • The configuration files of the modules is under 'config' directory.

Contributing

See CONTRIBUTING.

License

This project is licensed under the MIT License.