Essentials/README.markdown

1.9 KiB

This is a fork of Essentials called EssentialsX.

If you are using this, do NOT ask Essentials for support.

The official upstream repository is at https://github.com/Essentials/Essentials

Why you should use it

EssentialsX provides several performance enhancements and fixes that are currently not available in Essentials and Spigot-Essentials. See the wiki for details.

EssentialsX is almost a completely drop-in replacement for Essentials. EssentialsX requires Vault if you have a supported permissions plugin.

Downloads

Downloads can be found at my Jenkins site.

Building

To build with Maven, use the command

mvn package dependency:copy

Jar files can then be found in the /jars folder

Commit Guidelines

Commits should fall into one of 3 areas:

  • [Feature]: Commits which are features should start with [Feature] and followed by a quick summary on the top line, followed by some extra details in the commit body.

  • [Fix]: Commits which fix bugs, or minor improvements to existing features should start with [Fix] and followed by a quick summary on the top line, followed by some extra details in the commit body.

  • Commits which fix bugs caused by previous commits (since last release), or otherwise make no functionality changes, should have no prefix. These will not be added to the project change log.

Other Info

This is an unofficial fork of Essentials. It will be consistently updated and maintained with the latest Minecraft and Spigot versions.

Support

Issue Tracker

Live Support available business hours (GMT -5)