Skip to content

Build a Factions plugin for every version of Factions and not have to worry about version upgrades and changes.

License

Notifications You must be signed in to change notification settings

markhughes/FactionsFramework

Repository files navigation

Factions Framework

Want more information on how you can use Factions Framework? See the wiki.

Looking to download Factions Framework? It can be found on Spigot, Bukkit, and right here on GitHub!

Spigot Resources Spigot Resources

BukkitDev BukkitDev

What is Factions Framework?

Factions Framework is best described as a middle man. It sits in-between your plugin and the Factions plugin you have installed.

The framework has it's own standard for creating commands, getting factions, using events, and other features required for Factions plugins. This means that you only have to create your plugin to work with Factions Framework. These are automatically routed into Factions, using the correct standard for your installed plugin.

In some cases, Factions Framework is more powerful than using the existing Factions API. We've extended on the features in events and other classes, allowing you to do more things easily.

Factions Framework supports Factions UUID (1.6), FactionsOne (1.8) and most versions of Factions 2.

Compiling

Using gradle you will find the project is quite simple to build.

# Clone the repo
git clone https://github.com/MarkehMe/FactionsFramework.git && cd FactionsFramework
# Use gradle to compile
gradle jar
# Or, if you don't have gradle installed - there is an internal wrapper you can use
./gradlew jar

You can use the stable tree to compile the most recent release of Factions Framework.

Development Builds wercker status

wercker status

Development builds are not production ready and no support is guaranteed. Things could be broken (and we should assume they are). So please proceed with caution! However, feel free to report bugs.

You can grab development builds at Wercker. To download development builds, go to the latest build and open the Archive artifacts step.