Lots of wiki changes

* Remove redundant changelogs in favour of GitHub releases pages
* Minor updates to the Home and Locale page
* Split "Downloading EssentialsX" page into "Installing" and "Modules"
md678685 2020-01-04 16:31:30 +00:00
parent 33172059cb
commit 5929de1bab
11 changed files with 122 additions and 186 deletions

@ -1,60 +0,0 @@
# EssentialsX 2.15.0
`EssentialsX 2.15.0` was released on March 28th, 2018.
Previous release: `2.0.1-b488` on June 20th, 2017.
Next release: [2.16.0](Changelog-2.16.0) on January 3rd, 2019.
## Changes
### Main Essentials
* Kits now support itemflags. ([Details](#itemflags-in-kits))
* Kits have been moved from `config.yml` to `kits.yml`. See [details](#kitsyml) for information on upgrading.
* `/me` now respects users that ignore it.
* Pagination has been fixed in news and info.
* Splash potion support in `/potion` has been fixed.
* Tons of translations have been updated.
* Messages are now sorted alphabetically in messages.properties.
* `/tppos` now respects per-world teleport permissions.
* Tempban expiry shows on join
* Optional confirmations for `/pay` and `/clearinventory` have been added.
* Deeper LuckPerms support
* God mode is now checked on login.
* `/seen` and `/whois` now support tab complete, as well as lots of other commands.
* The message displayed to banned users when trying to join can now be translated.
* Socialspy can now optionally include messages from muted players
* Muted players can no longer use `/r`
* Versioning system updated to `major.minor.patch.commits`, inspired by LuckPerms
For a more detailed list of additions and fixes, see the [release page](https://github.com/EssentialsX/Essentials/releases/tag/2.15.0).
### Essentials Chat
* `{PREFIX}` and `{SUFFIX}` now work as tags to put in the chat format. They will retrieve the prefix and suffix from your permissions plugin (requires Vault).
### Essentials Spawn
* Allow configuring spawn-on-join and respawn priority separately - fixed issue with Multiverse wanting priority on spawns
### Essentials GeoIP
* @k-jiang updated to new GeoIP database since old version wasn't supported anymore.
## Details
### ItemFlags in Kits
[ItemFlags](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag.html) can be added to kits now by using:
`itemflags:flag1` OR
`itemflags:flag1,flag2`
### kits.yml
When you run 2.15.0 for the first time, your kits in your `config.yml` will be automatically migrated to a new `kits.yml` file. Once the migration has taken place, you can safely delete the `kits` section of your `config.yml`, as it is no longer used.
`/createkit` is a command that we've had for almost 3 years at the time of this posting. You can now create kits using this in game command without worrying about messing up the formatting of your config.yml! We will be expanding the functionality of /createkit in the future.
Make sure that you disable `pastebin-createkit` in your `config.yml` if you want to add kits directly to your `kits.yml`.

@ -1,10 +0,0 @@
# EssentialsX 2.16.0
`EssentialsX 2.16.0` was released on January 3rd, 2019.
Previous release: [2.15.0](Changelog-2.15.0) on March 28th, 2018.
Next release: [2.16.1](Changelog-2.16.1) on March 4th, 2019.
## Changelog
You can view the full changelog for this version on [GitHub](https://github.com/EssentialsX/Essentials/releases/tag/2.16.0).

@ -1,10 +0,0 @@
# EssentialsX 2.16.1
`EssentialsX 2.16.1` was released on March 4th, 2019.
Previous release: [2.16.0](Changelog-2.16.0) on January 3rd, 2019.
Next release: [2.17.0](Changelog-2.17.0), to be released in summer 2019.
## Changelog
You can view the full changelog for this version on [GitHub](https://github.com/EssentialsX/Essentials/releases/tag/2.16.1).

@ -1,10 +0,0 @@
# EssentialsX 2.17.0
`EssentialsX 2.17.0` will be released in summer 2019.
Previous release: [2.16.1](Changelog-2.16.1) on March 4th, 2019.
Next release: [2.17.1](Changelog-2.17.1), to be released after 2.17.0.
## Changelog
You will be able to view the full changelog for this version after release on [GitHub](https://github.com/EssentialsX/Essentials/releases/tag/2.17.0).

@ -1,8 +0,0 @@
# Changelogs
You can find update changelogs below:
* [2.15.0](Changelog-2.15.0)
* [2.16.0](Changelog-2.16.0)
* [2.16.1](Changelog-2.16.1)
* [2.17.0](Changelog-2.17.0)

@ -1,33 +0,0 @@
## Downloading EssentialsX
You can download EssentialsX from the [website](https://essentialsx.github.io/#/) or from [the build server](https://ci.ender.zone/job/EssentialsX/). You will also need to install [Vault](https://www.spigotmc.org/resources/vault.34315/) and a permissions plugin like [LuckPerms](https://luckperms.github.io) to be able to control ranks, permissions, prefixes and suffixes for your players.
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 and can be either installed alongside EssentialsX or [replaced with more in-depth plugins](#alternatives).
### Core
The core EssentialsX jar contains many of the core features for most servers. This includes most commands as well as signs, kits and the economy. **You need this jar for all the other modules to work.**
### Modules
**EssentialsX Chat** includes EssentialsX's chat features; it allows you to customise chat formatting on your server including adding prefixes, suffixes and colours in chat. *You need Vault and LuckPerms to give players prefixes and suffixes.*
**EssentialsX Spawn** lets you control where players spawn both when they first join the server and when they die. You can use the in-game `/setspawn` command to set a spawn location for everyone on your server or for specific groups.
**EssentialsX AntiBuild** adds permissions to your server that let you restrict which players can build on your server, as well as restricting players from placing or breaking certain blocks, like TNT or diamond blocks. *We recommend you use a permissions plugin with AntiBuild to make the most of its features.*
**EssentialsX Protect** allows you to control some simple settings for your worlds, like preventing creepers from damaging buildings, disabling fire spread and disabling certain types of mob spawns.
**EssentialsX GeoIP** provides an approximate lookup of where your players come from, based on their public IP and public geographical databases.
**EssentialsX XMPP** acts as a bridge between the XMPP chat network and your server. This allows players to chat across XMPP networks and your server, and can also report server errors to admins. *If you don't know what XMPP is, you don't need this!*
### Alternatives
There are many alternative plugins that provide some of EssentialsX's features. If you use a dedicated chat plugin, you won't need to install EssentialsX Chat as it won't do anything useful. In addition, if you use [WorldGuard](http://worldguard.enginehub.org/), you may not need EssentialsX AntiBuild or Protect as WorldGuard includes many of the same features and more.
<!--
**EssentialsX Discord** (coming soon) acts as a bridge between a Discord server and your Minecraft server. This allows players to chat between Discord and your server, as well as letting players link their Discord and Minecraft accounts for special ranks.
(also hi thanks for looking at the raw page 😛)
**EssentialsX Potato** integrates your Minecraft server with the well-known culinary open source project [Potato](https://github.com/drtshock/Potato). This ensures you always have the finest high-quality potatos ready to go!
-->

16
Home.md

@ -8,15 +8,10 @@ EssentialsX is the essential plugin for Spigot servers, providing core features
* Various moderation tools including **kicks, temporary bans, mutes and jails**
* Built-in economy features including **sign shops, command costs and full Vault support**
In addition, EssentialsX's add-on plugins provide further integrated features:
* **AntiBuild**: Enforce permissions checks for building/interacting/crafting and alert staff when players use certain items. [More details on the Essentials wiki.](http://wiki.ess3.net/wiki/AntiBuild)
* **Chat**: Customise chat formats for the whole server as well as specific groups.
* **GeoIP**: Display geographical lookup data for players when they log in and in `/whois`.
* **Protect**: Set rules to protect your world, like disabling explosions and fire spread.
* **Spawn**: Set up spawnpoints for different groups, and show welcome messages and set different spawn locations for new players.
* **XMPP**: Monitor your server and receive private messages via a XMPP-compatible chat service. ~~We have no idea how it works either.~~
In addition, EssentialsX's optional modules provide further integrated features like chat formatting, world protection, GeoIP lookup and more - see the [Module Breakdown](Module-Breakdown) for more information.
## Pages
* [Banner Metadata](BannerMeta)
* [Command Cooldowns](Command-Cooldowns)
* [Color Permissions](Color-Permissions)
@ -25,9 +20,8 @@ In addition, EssentialsX's add-on plugins provide further integrated features:
**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).
## The original Essentials plugin
## Updating from Essentials 2
EssentialsX is a fork of the original [Essentials](https://github.com/essentials/Essentials), which was discontinued in 2014. EssentialsX adds several new features over the original Essentials plugin and the SpigotMC Essentials fork. See [Improvements](Improvements) and [Changelogs](Changelogs) for more information.
To upgrade from Essentials 2.14.x or earlier, stop your server, replace your Essentials jars with the equivalent EssentialsX jars and restart your server. EssentialsX will load and convert your old Essentials files when you first run it.
EssentialsX is a fork of the original [Essentials project](https://github.com/essentials/Essentials), which was discontinued in 2014. EssentialsX adds several new features over the original Essentials - [the Improvements page](Improvements) and [EssentialsX changelogs](https://github.com/EssentialsX/Essentials/releases) for more information.
To upgrade from Essentials 2.14.x or earlier, stop your server, delete the old Essentials jars and replace them with the equivalent EssentialsX jars. We recommend renaming your `config.yml` file to take advantage of new settings added by EssentialsX, and taking a full backup of your `plugins/Essentials/` folder. Once you restart your server, EssentialsX will create a new `config.yml` and update old user data to the new format.

15
Installing-EssentialsX.md Normal file

@ -0,0 +1,15 @@
# Installing EssentialsX
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.
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.
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.
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).
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.
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.
Once you've installed all the plugins you need, restart your server. EssentialsX will create configuration files (and upgrade old Essentials data if needed) when it starts up.

@ -1,8 +1,11 @@
# Translations
EssentialsX stores all its messages as templates in the messages file, and comes with support for [many languages already built-in](#Supported-languages). These files can be easily replaced or extended to customize your server by placing them in the `plugins/Essentials/` folder.
# Translations
## Switching language
You can tell EssentialsX which language you want it to use by changing the `locale` setting in `config.yml`:
```yaml
# Set the locale for all messages.
# ...
@ -14,86 +17,91 @@ Remember that you need to **uncomment** the `locale: ` line by **removing the `#
Below is a list of languages that EssentialsX supports:
## Supported languages
* **Standard (US) English**: `en`
- **Standard (US) English**: `en`
- **UK**: `en_GB`
* **Czech**: `cs`
* **Danish**: `da`
* **German**: `de`
* **Spanish**: `es`
* **Estonian**: `et`
* **Finnish**: `fi`
* **French**: `fr`
* **Hungarian**: `hu`
* **Italian**: `it`
* **Korean**: `ko`
* **Lithuanian**: `lt`
* **Dutch**: `nl`
* **Polish**: `pl`
* **Portuguese**: `pt`
- **Czech**: `cs`
- **Danish**: `da`
- **German**: `de`
- **Spanish**: `es`
- **Estonian**: `et`
- **Finnish**: `fi`
- **French**: `fr`
- **Hungarian**: `hu`
- **Italian**: `it`
- **Korean**: `ko`
- **Lithuanian**: `lt`
- **Dutch**: `nl`
- **Polish**: `pl`
- **Portuguese**: `pt`
- Brazil: `pt_BR`
* **Romanian**: `ro`
* **Russian**: `ru`
* **Swedish**: `sv`
* **Turkish** `tr`
* Chinese:
- **Romanian**: `ro`
- **Russian**: `ru`
- **Swedish**: `sv`
- **Turkish** `tr`
- Chinese:
- `zh` for **modern Chinese**,
- `zh_HK` for **Hong Kong**, and
- `zh_TW` for **traditional Chinese**
## Defining Locale
There are many reasons you may want to add or modify the messages file in EssentialsX. Virtually all messages and formatting are defined here, so you can modify this file if you want to change the look and feel of the plugin. EssentialsX bundles several messages files in different locales inside the jar, so you can get a copy of the locale by extracting it from the main EssentialsX jar. Simply take the locale you want to change, place it in the `plugins/Essentials/` folder and start editing. Remember that the file is updated quite regularly; you might want to keep a backup of the file and use a diff tool to allow easy updates.
## Changing locale
EssentialsX bundles several messages files in different languages inside the jar, so you can get a copy of your desired messages file by extracting it from the main EssentialsX jar. Simply take the messages file you want to change, place it in the `plugins/Essentials/` folder and start editing. Remember that the file is updated quite regularly; you might want to keep a backup of the file and use a diff tool to allow easy updates.
If you decide you can improve the existing translation of EssentialsX, or want to submit your translation for bundling, feel free to submit your altered locale file back to EssentialsX. EssentialsX often changes and improves, and it's quite easy for language files to be left behind when the developers don't use the language. You can submit your improved locale file over on our [Crowdin page](https://crowdin.com/project/essentialsx-official).
## Custom Messages
It is also possible to use the messages files for servers to define custom messages. This can give a server a more customised feel, and can be used to chance the colour scheme of EssentialsX messages.
## Customising messages
You can find the latest messages files inside the EssentialsX jar.
Since all of the plugins' messages are defined in the messages file, you can fully customise the look and feel of your server by changing the text and colour scheme for all EssentialsX commands.
Simply place your edited locale file (with appropriate local suffix) in the Essentials plugin folder, and make sure the locale setting in the config file matches (`locale: en` -> `messages_en.properties`), then restart the server.
Simply place your edited locale file (with appropriate locale suffix) in the `plugins/Essentials` folder and make sure the locale setting in the config file matches (`locale: en` -> `messages_en.properties`), then restart the server.
If you are having trouble, [try this tutorial video](https://www.youtube.com/watch?v=9Uan2oJ9zK8). Note that this video is for the original Essentials plugin, not EssentialsX.
You may need to update the file on occasion to deal with changes in EssentialsX such as parameter changes or changes to the actual syntax of the messages. This can be done with a diff tool like [diffuse](http://diffuse.sourceforge.net/screenshots.html), which highlights changes between two text files.
## Minor Changes
When EssentialsX looks for a message, if it is missing from your version, it will instead use the **built-in version**.
This means that if you only want to change a few messages instead of the whole translation, you can do this by making a copy of the locale file you're using in `plugins/Essentials/` and deleting all messages in the file, other than the ones you want to change. This means you don't have to worry about keeping your messages file up to date with every EssentialsX update.
When editing only a few keys, the process should look something like [this](http://wiki.ess3.net/w/images/0/0c/Locale.PNG).
When editing only a few keys, the process should look something like [this (click to open image)](http://wiki.ess3.net/w/images/0/0c/Locale.PNG).
## Colours
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** (&sect;), used in Minecraft to make colour codes.
Most Java IDE's will do the conversion to and from Unicode automatically.
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** (&sect;), 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 to manually convert them.
## Editing Locale
If you are unhappy with a translation, or otherwise just want to modify messages, the easiest way to do this is to take a copy of the locale file your using, and place it in the Essentials folder. Essentials will give a locale file placed in this folder priority over the ones shipped inside of the jar file. This means you can make modifications to messages without too much worry about them becoming out of date.
## Example
You will generally need to periodically update the file, to deal with things such as parameter changes, or changes to the actual syntax of the messages. This is best done with a diff tool like [diffuse](http://diffuse.sourceforge.net/screenshots.html), which highlights changes between two text files.
### Example
Let's say you simply want to change the way currency is output so that the currency symbol comes AFTER the balance:
* Be sure to read the information above regarding custom locales/messages.
* Locate the line "currency={0}{1}"
* Switch the numbers around, it should now read "currency={1}{0}". {1} is the amount, {0} is the currency symbol. You can have spaces here too, if you want.
* Save the file and restart the server or issue /ess reload.
- Be sure to read the information above regarding custom locales/messages.
- Locate the line "currency={0}{1}"
- Switch the numbers around, it should now read "currency={1}{0}". {1} is the amount, {0} is the currency symbol. You can have spaces here too, if you want.
- Save the file and restart the server or issue /ess reload.
## Disabling Messages
Most user messages can be disabled or hidden simply by setting the message string to blank, for example:
```properties
noNewMail=
```
## Contributing
If you wish to contribute translations, you can do so using [Crowdin](https://crowdin.com/project/essentialsx-official).
## Other files
### plugin.yml
Aside from the messages file, there are a few other locations or settings you may want to change. The EssentialsX help system automatically reads each plugin's `plugin.yml`, including its own, and uses these files to display the syntax and command descriptions. To have a complete in-game translation, you may want to update these files to your native language.
### Config file
There are a number of settings in EssentialsX which can be altered by editing `plugins/Essentials/config.yml`, such as the currency format. These are independent of the `locale` setting, and can be changed without editing the jar file.
### Text commands
EssentialsX's text commands like `/motd` and `/rules` can be edited completely separately from the messages files and the config. Simply run the command in-game once, then find the corresponding text file inside `plugins/Essentials` to edit it.
EssentialsX's text commands like `/motd` and `/rules` can be edited completely separately from the messages files and the config. Simply run the command in-game once, then find the corresponding text file inside `plugins/Essentials` to edit it.

47
Module-Breakdown.md Normal file

@ -0,0 +1,47 @@
# Modules
## Core
The core EssentialsX jar contains many of the core features for most servers. This includes most commands as well as signs, kits and the economy. **You need this jar for all the other modules to work.**
## EssentialsX AntiBuild
**EssentialsX AntiBuild** adds permissions to your server that gives you fine control over which players can build, interact with blocks or craft on your server. You can control individual items and blocks for specific groups or users, or simply allow or deny entire groups from building at all using build flags. It also includes an alert system for when players use certain items. For more information, see the [AntiBuild wiki page](http://wiki.mc-ess.net/wiki/AntiBuild) (item IDs have been removed in 1.13+).
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).
*We recommend you use LuckPerms with AntiBuild to make the most of its features.*
## EssentialsX Chat
**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.
*You need Vault and LuckPerms to give players prefixes and suffixes and to detect groups.*
## EssentialsX GeoIP
**EssentialsX GeoIP** displays an approximate lookup of where your players come from based on looking up their IP in a geographical database. This lookup can be seen by admins either when players log in or in `/whois`.
## EssentialsX Protect
**EssentialsX Protect** allows you to control some simple settings for your worlds, like preventing creepers from damaging buildings, disabling fire spread and blocking certain types of mob spawns.
Note that Protect doesn't include any kind of region protection; to protect specific regions we recommend installing [WorldGuard](https://dev.bukkit.org/projects/worldguard).
## EssentialsX Spawn
**EssentialsX Spawn** lets you control where players spawn both when they first join the server and when they die. You can use the in-game `/setspawn` command to set a spawn location for everyone on your server as well as for specific groups.
## EssentialsX XMPP
**EssentialsX XMPP** acts as a bridge between Jabber/XMPP chat networks and your server. This allows players to chat between XMPP networks and your server, and can also allow server admins to monitor the console and server errors remotely. For more information, see the [Essentials XMPP guide](https://wiki.mc-ess.net/wiki/XMPP).
*If you don't know what XMPP is, you don't need this!*
<!--
**EssentialsX Link** (coming soon) acts as a bridge between chat services such as Discord and your Minecraft server. This allows players to chat between Discord and your server, as well as letting players link their Discord and Minecraft accounts for special ranks.
(also hi thanks for looking at the raw page o/)
**EssentialsX Potato** integrates your Minecraft server with the well-known culinary open source project [Potato](https://github.com/drtshock/Potato). This ensures you always have the finest high-quality potatos ready to go!
-->

@ -1,15 +1,18 @@
[![**EssentialsX Wiki**](https://camo.githubusercontent.com/9ad178e5cf76a372d6aaee8bbdf13485fbc1d51b/68747470733a2f2f692e696d6775722e636f6d2f435034535a70422e706e67)](https://github.com/EssentialsX/Essentials/wiki)
## Getting started
* [[Downloading EssentialsX]]
* [Commands](https://essinfo.xeya.me/commands.php) and [Permissions](https://essinfo.xeya.me/commands.php)
* [[Installing EssentialsX]]
* [Commands](https://essinfo.xeya.me/commands.php) and [Permissions](https://essinfo.xeya.me/permissions.php)
## Features
* [[Improvements over Essentials|Improvements]]
* [[Banner Metadata|BannerMeta]]
* [[Command Cooldowns]]
## Support
* [[Common Issues]]
* [Issue Tracker](https://github.com/EssentialsX/Essentials/issues)
* [Discord](https://discord.gg/F7gexAQ) - [[Rules|Discord-Rules]]
* [Discord](https://discord.gg/F7gexAQ) - [[Rules|Discord-Rules]]