Elikill58 / Flier

Elytra air combat minigame for Spigot

Flier

Flier is a Spigot minigame plugin. It lets players fly with engine-powered Elytras and shoot each other. It doesn't allow Minecraft's regular PvP mechanics, instead featuring a wide array of custom gun-like weapons, rockets and bombs.

Documentation

The plugin is thoroughly documented in the docs directory. All files are written in Markdown. When adding new features they should be immediately documented there. The order of the files in the build script is as follows:

• Home
• Installation
• Commands
• Integrations
• Lobby
• Arena
• Game
• ItemSet
• Item
• Engine
• Wings
• Action
• Activator
• Bonus
• Modifications
• Effects

Install

If you prefer already compiled builds, please head to the releases page of the plugin. Next section will cover setting up Flier for development or local building.

Prerequisites

First of all you need to have JDK (version 8 or later) installed on your system. This will let you compile Java programs. Next you have to install Maven, the build automation tool. Just grab a binary zip archive and unpack it somewhere on your system. Make sure the bin directory is added to the PATH.

If you want to be able to use the build script to create a nice zipped package you also need following programs installed:

• Git (grabbing the source code)
• Pandoc (generating the documentation)
• wkhtmltopdf (converting documentation to PDF)
• 7zip (packaging the bundle)

Also you can install it on most deb-based systems (tested on Debian 11):

sudo apt install git pandoc wkhtmltopdf p7zip-full openjdk-17-jdk --no-install-recommends

Building

Compiling the plugin alone is quite easy. Simply open the command line in the plugin's directory and issue this command:

mvn package

Maven will build and package the plugin. If you see a Build successful message then the compiled jar file was placed inside target directory. You can copy it into your server's plugins directory now.

Using the build.bat/build.sh script

This script is meant to automate the release process and provide a consistent way of packaging bundles under Windows and Unix-like systems. It will compile the plugin, its documentation and other important resources and output a 7z bundle. It's not really important for development, just for the official release process. In any case, you can run it on Windows simply by double-clicking it in Explorer. It will tell you if it finds any issues.

API

The stable programming interface is not designed yet. Once version 1.0 is developed it will be available at a separate repository. The currently existing API is not stable yet and may change without warning.

Versioning

Flier uses SemVer for versioning. For the official available versions see the tags of this repository.

License

The project is licensed under MIT license - see the LICENSE file for more details.