The essential plugin suite for Minecraft servers.
Go to file
md678685 aa4d3cc9fd Bump to 2.16-pre2 2018-12-25 00:27:54 +00:00
.github/ISSUE_TEMPLATE Rename help-.md to help.md 2018-10-28 10:54:01 +00:00
Essentials Add setting to enable item ID recognition on signs 2018-12-23 23:02:36 +00:00
EssentialsAntiBuild Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
EssentialsChat Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
EssentialsGeoIP Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
EssentialsProtect Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
EssentialsSpawn Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
EssentialsXMPP Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
examples remove users from bperm example, different yml file now. 2012-09-13 01:50:55 +01:00
nms Bump version to 2.16.0 and release 2.16-pre1 2018-12-09 14:33:53 +00:00
.gitignore Ignore kits.yml created during tests 2018-12-09 15:15:55 +00:00
.travis.yml Reset BuildTools work directory on Travis 2018-10-09 20:32:40 +01:00
LICENSE Added License info. Essentials is GPLv3 2011-05-13 19:58:30 +00:00
README.md Improved README (#2293) 2018-12-23 17:21:31 +00:00
pom.xml Bump to 2.16-pre2 2018-12-25 00:27:54 +00:00

README.md

EssentialsX

Jenkins

Discord

Patreon

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 use EssentialsX?

EssentialsX is an unofficial continuation of EssentialsX, updated to support modern Minecraft and Spigot versions. It provides several performance enhancements and fixes that are currently not available in Essentials and Spigot-Essentials. For more details, see the wiki.

EssentialsX is almost a completely drop-in replacement for Essentials. However, it has different requirements:

  • EssentialsX requires Vault to enable chat prefix/suffixes and group support if you have a supported permissions plugin. We recommend using LuckPerms.

  • If you have an unsupported permissions plugin but still wish to use wildcards, enable use-bukkit-permissions in the configuration. Otherwise, the plugin will fall back to config-based permissions.

  • EssentialsX requires Java 8 or higher. On older versions, the plugin may not work properly.

  • EssentialsX supports Minecraft versions 1.8.8, 1.9.4, 1.10.2, 1.11.2 and 1.12.2. Support for 1.13.2 is coming soon.

Support

Need help with using EssentialsX? Join the MOSS Discord community to ask for help and discuss EssentialsX.

If you need to report a bug or want to suggest a new feature, you can open an issue on GitHub.

Building

EssentialsX builds against the Spigot/CraftBukkit server software for legacy support. To compile EssentialsX, you first need to run BuildTools several times:

java -jar BuildTools.jar --rev 1.8
java -jar BuildTools.jar --rev 1.8.3
java -jar BuildTools.jar --rev 1.9
java -jar BuildTools.jar --rev 1.9.4

Then, to build with Maven, run the following command:

mvn clean install

Each module's jar can be found in target/ inside each module's directory.

Contributing

Want to help improve EssentialsX? There are numerous ways you can contribute to the project.

If you'd like to make a financial contribution to the project, you can join our Patreon. If you can't make a donation, don't worry! There's lots of other ways to contribute:

  • Do you run a server? Take a look at our "help wanted" issues, where you can find issues that need extra testing and investigation. You can also join the MOSS Discord community and provide support to others.
  • Do you speak multiple languages? If so, we always welcome pull requests to our language files.
  • If you're a developer, you could look through our "open to PR" issues. We're always happy to receive bug fixes and feature additions as pull requests.