Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2024-11-04 18:09:54 +01:00
Code Issues Projects Releases Wiki Activity
The essential plugin suite for Minecraft servers.
5,569 Commits 11 Branches 68 Tags 426 MiB
Java 99.9%
Kotlin 0.1%
c8b8e505f3
Go to file
montlikadani c8b8e505f3
Add teleport warmup event to API (#2590) 
* Update Teleport.java

* Create UserTeleportEvent.java

* Update Teleport.java

* Add location to event
2020-03-30 20:38:13 -07:00
.github Update funding to include Ko-fi link 2020-02-10 11:34:59 +00:00
Essentials Add teleport warmup event to API (#2590) 2020-03-30 20:38:13 -07:00
EssentialsAntiBuild Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
EssentialsChat Fixed double local logging (#2755) 2020-03-13 02:33:18 -07:00
EssentialsGeoIP Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
EssentialsProtect Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
EssentialsSpawn Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
EssentialsXMPP Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
nms Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
scripts OS X compatible buildtools.sh (#2513) @Argetan 2019-04-30 07:55:54 +01:00
.gitignore Lots of little fixes in the Essentials modules (#2337) @DoNotSpamPls 2019-01-05 18:42:09 +00:00
crowdin.yml Add Estonian alias to Crowdin config 2019-04-07 21:08:30 +01:00
LICENSE Added License info. Essentials is GPLv3 2011-05-13 19:58:30 +00:00
pom.xml Bump version to 2.17.2 2020-02-22 10:05:14 +00:00
README.md Mention 1.15.2 in the README (#3107) 2020-03-29 12:11:44 -07: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 Essentials, 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, 1.12.2, 1.13.2, 1.14.4, and 1.15.2.

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. This only needs to be done once. There are two ways to do this:

  • Use the provided script at scripts/buildtools.sh to automatically download and run BuildTools if needed.
  • Download and run BuildTools yourself for versions 1.8 and 1.8.3.

Next, to build EssentialsX with Maven, run the following command:

mvn clean install

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

Using EssentialsX in your plugin

Writing a plugin and want to support EssentialsX? We have a Maven repository at https://ci.ender.zone/plugin/repository/everything/, and the EssentialsX artifact is net.ess3:EssentialsX:2.17.0. More information at the wiki.

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 contributions to our Crowdin project.
  • 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.