You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Command-Cooldowns.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
**This feature was added in [build 369](https://ci.drtshock.net/job/EssentialsX) ([09acbcd](https://github.com/drtshock/Essentials/commit/09acbcdb05f34e0043116f1866904b0ff0f03ddd)).**
1
+
**This feature was added in [build 369](https://ci.ender.zone/job/EssentialsX) ([09acbcd](https://github.com/drtshock/Essentials/commit/09acbcdb05f34e0043116f1866904b0ff0f03ddd)).**
2
2
_Requested in [#110](/drtshock/Essentials/issues/110). PR in [#692](/drtshock/Essentials/pull/692)._
3
3
4
4
This feature introduces the highly demanded ability to apply cooldowns to commands. If you want to limit how often a player can `/feed` or go `/home`, all you have to do is simply add that command to the config:
Copy file name to clipboardExpand all lines: Common-Issues.md
+39-10Lines changed: 39 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ aliases:
32
32
See the [Bukkit wiki page](https://bukkit.gamepedia.com/Commands.yml#aliases) for more information.
33
33
34
34
## Another plugin is overriding an EssentialsX command
35
-
Typically, if EssentialsX finds another plugin providing a command with the same name as one of EssentialsX's own commands, it will try and hand over that command to the other plugin. However, you can force EssentialsX to handle commands that are also provided by another plugin using the [`overridden-commands` section](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/config.yml#L138) of your `config.yml`. This will tell EssentialsX not to "give up" the command to the other plugin.
35
+
Typically, if EssentialsX finds another plugin providing a command with the same name as one of EssentialsX's own commands, it will try and hand over that command to the other plugin. However, you can force EssentialsX to handle commands that are also provided by another plugin using the [`overridden-commands` section](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/config.yml#L162) of your `config.yml`. This will tell EssentialsX not to "give up" the command to the other plugin.
36
36
37
37
For example, to force EssentialsX to handle the `/msg` command instead of passing it over to another plugin, your section should look like this:
38
38
```yaml
@@ -62,20 +62,35 @@ This is required to allow EssentialsX's compatibility providers can build agains
62
62
63
63
Next, [download or clone EssentialsX](https://github.com/EssentialsX/Essentials), open a terminal in the root of the EssentialsX source and run:
64
64
```bash
65
-
mvn clean install
65
+
./gradlew build
66
66
```
67
67
68
-
If this completes with no errors, you will be able to find each plugin jar in the `target` subdirectory of the respective plugin's directory - `Essentials/target/` will contain the EssentialsX jar, `EssentialsSpawn/target/` will contain the EssentialsXSpawn jar and so on.
68
+
If this completes with no errors, you will be able to find each plugin jar in the `jars/` directory or, in `build/libs/` inside each module's directory.
69
69
70
70
## How do I add EssentialsX as a dependency?
71
+
### Repositores
72
+
Do you want to integrate with EssentialsX in your plugin? You can use the EssentialsX Maven repo to build against EssentialsX's API.
73
+
74
+
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/`.
75
+
76
+
To add EssentialsX to your build system, you should use the following artifacts:
Note: up until 2.18.2, EssentialsX used the net.ess3 group ID, but starting with 2.19.0 snapshots, the group ID is now net.essentialsx. When updating your plugin, make sure you use the correct group ID.
85
+
71
86
### Maven
72
87
Under `repositories` in your `pom.xml`, you need to add a new `repository` for the EssentialsX CI server:
**Note:** When updating EssentialsX, you need to update *all* the modules to the same version to prevent version mismatch errors. In addition, you may want to update your config file - the latest config file can always be found [here](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/config.yml).
21
+
**Note:** When updating EssentialsX, you need to update *all* the modules to the same version to prevent version mismatch errors. In addition, you may want to update your config file - the latest config file can always be found [here](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/config.yml).
Copy file name to clipboardExpand all lines: Installing-EssentialsX.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
First of all, make sure you're running a supported Minecraft server platform. We recommend using [Paper](https://papermc.io), especially for 1.13+ as it contains many performance improvements over Spigot.
4
4
5
-
You can download EssentialsX either from [SpigotMC](https://www.spigotmc.org/resources/essentialsx.9089/) for stable releases, or from the [downloads page](https://essentialsx.cf/downloads.html) for development builds with the latest features and bug fixes.
5
+
You can download EssentialsX either from [SpigotMC](https://www.spigotmc.org/resources/essentialsx.9089/) for stable releases, or from the [downloads page](https://essentialsx.net/downloads.html) for development builds with the latest features and bug fixes.
6
6
7
7
EssentialsX is split up into several separate plugins. The only jar that is necessary for EssentialsX to work is the main `EssentialsX` jar, which contains most of the core features most servers will need. The other modules are optional - see the [[Module-Breakdown|Module Breakdown]] page for more information on what each module does.
8
8
9
9
Once you've decided which EssentialsX modules you need, copy the required `.jar` files into the `plugins/` directory (if you downloaded from SpigotMC, you'll need to unzip the downloaded file first).
10
10
11
-
If you don't already have a permissions plugin, we recommend that you install [LuckPerms](https://luckperms.github.io) to control ranks, permissions, prefixes and suffixes for your players. This is optional but recommended.
11
+
If you don't already have a permissions plugin, we recommend that you install [LuckPerms](https://luckperms.net) to control ranks, permissions, prefixes and suffixes for your players. This is optional but recommended.
12
12
13
13
You'll also need to install [Vault](https://www.spigotmc.org/resources/vault.34315/) to allow EssentialsX to talk to permissions plugins; without it, prefixes, suffixes and group-related features won't work.
Copy file name to clipboardExpand all lines: Locale.md
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,9 @@ When editing only a few keys, the process should look something like [this (clic
69
69
70
70
## Colours
71
71
72
-
If you decide to edit the locale files with a standard text editor, you may notice lots of text like '\u00a7'. These are Unicode character escapes, which allow you to represent symbols and letters which do not exist in ASCII within an ASCII file. The most common of these you will see is '\u00a7' which represents the **section symbol** (§), used in Minecraft to make colour codes. Other languages such as those that use their own alphabets or use non-standard characters will also need to use these codes. Many Java IDEs will do the conversion to and from Unicode automatically, or you can use a tool like [this](https://native2ascii.net/) to manually convert them.
72
+
If you have an older messages file, you may notice lots of text like `\u00a7`. These are Unicode character escapes, but are no longer needed in modern versions of EssentialsX which support UTF-8 files, and you can convert these to UTF-8 characters `§` using a tool such as [Interactive native2ascii](https://native2ascii.net/).
73
+
74
+
To use RGB colour codes, you will need to use Spigot's `§x§R§R§G§G§B§B` format, where RRGGBB come from the colour's hexadecimal code. You can also use [legacy colour codes (`§0` to `§f`)](https://minecraft.gamepedia.com/Formatting_codes#Color_codes) and [formatting codes](https://minecraft.gamepedia.com/Formatting_codes#Formatting_codes).
Copy file name to clipboardExpand all lines: Module-Breakdown.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ The core EssentialsX jar contains many of the core features for most servers. Th
10
10
11
11
Note that AntiBuild doesn't include any kind of region protection; to restrict building in specific regions we recommend installing [WorldGuard](https://dev.bukkit.org/projects/worldguard).
12
12
13
-
*We recommend you use LuckPerms with AntiBuild to make the most of its features.*
13
+
*We recommend you use [LuckPerms](https://luckperms.net/download) with AntiBuild to make the most of its features.*
14
14
15
15
## EssentialsX Chat
16
16
17
17
**EssentialsX Chat** includes many of EssentialsX's chat features. It allows you to customise chat formatting on your server by adding prefixes, suffixes and colours in chat, as well as setting different formats for different groups.
18
18
19
-
*You need Vault and LuckPerms to give players prefixes and suffixes and to detect groups.*
19
+
*You need [Vault](https://www.spigotmc.org/resources/34315/) and [LuckPerms](https://luckperms.net/download) to give players prefixes and suffixes and to detect groups.*
0 commit comments