9f57b3e476
<!--
EssentialsX feature submission guide
====================================
NOTE: Failure to fill out this template properly may result in your PR
being
delayed or ignored without warning.
NOTE: Don't type between any arrows in the template, as this text will
be
hidden. This includes this header block and any other explanation text
blocks.
Want to discuss your PR before submitting it? Join the EssentialsX
Development
server: https://discord.gg/CUN7qVb
EssentialsX is GPL
------------------
By contributing to EssentialsX, you agree to license your code under the
GNU General Public License version 3, which can be found at the link
below:
https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE
Instructions
------------
If you are submitting a new feature, please follow the following steps:
1. Fill out the template in full.
This includes providing screenshots and a link to the original feature
request. If there isn't an existing feature request, we strongly
recommend opening a new feature request BEFORE opening your PR to
implement it, as this allows us to review whether we're likely to accept
your feature in advance, and also allows us to discuss possible
implementations for the feature. If there is no associated feature
request, your PR may be delayed or rejected without warning.
You can open a new feature request by following this link:
https://github.com/EssentialsX/Essentials/issues/new/choose
2. If you are fixing a performance issue, please use the "Bug fix" PR
template
instead. The "bug fix" template is better suited to performance issues.
3. Include a demonstration.
If you are adding commands, please provide screenshots and/or a video
demonstration of the feature. Similarly, if you are adding a new API,
please include a link to example code that takes advantage of your
proposed API. This will aid us in reviewing PRs and speed up the process
significantly.
-->
### Information
<!--
Replace #nnnn with the number of the original issue. If this PR
implements
features from multiple issues, you should repeat the phrase "closes
#nnnn"
for each issue.
-->
Closes #6336.
### Details
<!-- Type a description of your proposed feature below this line. -->
This adds a config option that allows disabling the logging of console
and RCON commands.
**Environments tested:**
<!-- Type the OS you have used below. -->
OS: Arch Linux
<!-- Type the JDK version (from java -version) you have used below. -->
Java version: openjdk 21.0.8 2025-07-15
<!--
Put an "x" inside the boxes for the server software you have tested this
bug fix on. If this feature does not apply to a server, strike through
the server software using ~~strikethrough~~. If you have tested on other
environments, add a new line with relevant details.
-->
- [x] Most recent Paper version (1.XX.Y, git-Paper-BUILD)
- [x] CraftBukkit/Spigot/Paper 1.12.2
- [x] CraftBukkit 1.8.8
**Demonstration:**
<!--
Below this block, include screenshots/log snippets from before and after
as
necessary. If you have created or used a test case plugin, please link
to a
download of the plugin, source code and exact version used where
possible.
-->
Without these changes, with the config option not set:
<img width="680" height="69" alt="image"
src="https://github.com/user-attachments/assets/92647fc0-c0c5-4e7b-9f61-953fcadd7f93"
/>
With these changes, with the config option set to false:
<img width="635" height="68" alt="image"
src="https://github.com/user-attachments/assets/fd11572c-dfe2-4b79-89ab-69e2275d2c9f"
/>
---------
Co-authored-by: Josh Roy <10731363+JRoy@users.noreply.github.com>
|
||
|---|---|---|
| .checkstyle | ||
| .github | ||
| .idea | ||
| build-logic | ||
| Essentials | ||
| EssentialsAntiBuild | ||
| EssentialsChat | ||
| EssentialsDiscord | ||
| EssentialsDiscordLink | ||
| EssentialsGeoIP | ||
| EssentialsProtect | ||
| EssentialsSpawn | ||
| EssentialsXMPP | ||
| gradle/wrapper | ||
| providers | ||
| .gitignore | ||
| build.gradle | ||
| CONTRIBUTING.md | ||
| crowdin.yml | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| README.md | ||
| settings.gradle.kts | ||
This is a fork of Essentials called EssentialsX.
If you are using this, do NOT ask Essentials for support.
The official upstream repository for the original Essentials project is at https://github.com/Essentials/Essentials.
Why use EssentialsX?
EssentialsX is a continuation of the Essentials plugin suite, updated to support modern Minecraft and Spigot versions.
It provides countless new features, performance enhancements and fixes that are not available in the original Essentials or Spigot-Essentials. For more details, see the wiki.
If you're coming from the original Essentials plugin, EssentialsX is a drop-in replacement for Essentials. It does, however, have some new requirements:
- EssentialsX requires CraftBukkit, Spigot or Paper to run. Other server software may work, but these are not tested by the team and we may not be able to help with any issues that occur.
- EssentialsX currently supports Minecraft versions 1.8.8, 1.9.4, 1.10.2, 1.11.2, 1.12.2, 1.13.2, 1.14.4, 1.15.2, 1.16.5, 1.17.1, 1.18.2, 1.19.4, 1.20.6, and 1.21.10.
- EssentialsX currently requires Java 8 or higher. We recommend using the latest Java version supported by your server software.
- EssentialsX requires Vault to enable using chat prefix/suffixes and
group support from supported permissions plugins.
- We recommend using LuckPerms for permissions and groups.
- If you have an unsupported permissions plugin but still want to use wildcards, enable
use-bukkit-permissionsin the configuration. Otherwise, the plugin will fall back to config-based permissions.
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
To build EssentialsX, you need JDK 8 or higher installed on your system.
Clone this repository, then run the following command:
- On Linux or macOS:
./gradlew build - On Windows:
gradlew build
You can then find builds of EssentialsX modules in the jars/ directory.
Running a test server
You can also run a test server from your development environment using the following command:
- On Linux or macOS:
./gradlew build :runServer - On Windows:
gradlew build :runServer
Note the : - without it, you will run several servers at once, which will likely crash Gradle.
Using EssentialsX in your plugin
Do you want to integrate with EssentialsX in your plugin? You can build your plugin against the EssentialsX API, available from the EssentialsX Maven repo.
Releases are hosted on the Maven repo at https://repo.essentialsx.net/releases/, while snapshots (including dev
builds) are hosted at https://repo.essentialsx.net/snapshots/.
To add EssentialsX to your build system, you should use the following artifacts:
| Type | Group ID | Artifact ID | Version |
|---|---|---|---|
| Latest release | net.essentialsx |
EssentialsX |
2.21.2 |
| Snapshots | net.essentialsx |
EssentialsX |
2.22.0-SNAPSHOT |
| Older releases | net.ess3 |
EssentialsX |
2.18.2 |
Note: until version 2.18.2, EssentialsX used the net.ess3 group ID.
From 2.19.0 onwards, EssentialsX uses the net.essentialsx group ID.
When updating your plugin, make sure you use the correct group ID.
You can find more information, including Maven and Gradle examples, at the wiki.
Support the EssentialsX project
Want to help improve EssentialsX? There are several ways you can support and contribute to the project.
Donate to EssentialsX
Donations allow us to cover the costs of our infrastructure, and also enable us to keep updating EssentialsX with new features and for new Minecraft versions.
You can support us with a one-off or monthly donation via GitHub Sponsors, and you'll get a badge on GitHub for supporting the project through this.
Alternatively, you can also donate monthly to the EssentialsX project on Patreon, or you can make a one-off donation on our Ko-fi page.
If you can't make a donation, don't worry! There are lots of other ways to contribute:
Contributing directly to EssentialsX
- Are you a developer? We're always happy to receive bug fixes and feature additions as pull requests.
- Do you speak multiple languages? If so, we always welcome contributions to our community translations. Crowdin project.
See CONTRIBUTING.md to find out more.
Providing support to other users
- Do you run a server? Take a look at our "help wanted" and "bug: unconfirmed" issues, where you can find issues that need extra testing and investigation.
- Do you want to help others set up EssentialsX? You can contribute to the EssentialsX docs. You can also join the MOSS Discord community and provide direct community support to other EssentialsX users.