Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2024-11-27 21:18:11 +01:00
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

md678685 2019-08-28 16:32:32 +01:00
parent 122353e70f
commit f381d07520
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Home.md

@ -1,33 +1,33 @@
# EssentialsX wiki!
EssentialsX is the essential plugin for Spigot servers, providing the core features and functionality for Minecraft servers of any size and scale. These features include:
* Private messaging - `/msg`, `/r`, `/mail`
* Moderation commands - `/kick`, `/ban`, `/mute`, `/jail`
* Teleports and teleport requests - `/tp`, `/tppos`, `/tpa`
* Homes and warps - `/home`, `/warp`
* Vault Economy
EssentialsX is the essential plugin for Spigot servers, providing core features for servers of any size and scale. These features include:
* **Player-made homes**
* Server **warps** and **kits**, either server-wide or per-world
* Player-to-player **private messages, teleports and teleport requests**
* Custom player **nicknames**
* Various moderation tools including **kicks, temporary bans, mutes and jails**
* Built-in economy features including **sign shops, command costs and full Vault support**
EssentialsX also has a handful of additional useful features:
* Player information - `/whois`, `seen`, `/getpos`
* Server information - `/gc`, `/list`
* Admin tools - `/gamemode`, `/powertool`
* Utility commands - `/spawner`
* Cheats - `/give`, `/spawnmob`
**Commands list:** https://essinfo.xeya.me/commands.php
**Permissions list:** https://essinfo.xeya.me/permissions.php
**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
EssentialsX is a fork of the original [Essentials](https://github.com/essentials/Essentials), which was discontinued in 2014. Most commands and permissions work the same way - you can find changes on the [Improvements](Improvements) page and [changelogs](Changelogs). When upgrading from Essentials, simply replace the Essentials jars with the equivalent EssentialsX jars - your old Essentials files are compatible with EssentialsX and will be updated when you first run EssentialsX.
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.~~
## Pages
* [Banner Metadata](BannerMeta)
* [Command Cooldowns](Command-Cooldowns)
* [Color Permissions](Color-Permissions)
* [Commands list](https://essinfo.xeya.me/commands.php) (community-maintained)
* [Permissions list](https://essinfo.xeya.me/permissions.php) (community-maintained)
## Improvements over Essentials and Spigot-Essentials
**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
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's new features can now be found on a new page! See [Improvements](Improvements) for more information.