Join our Discord and be part of our community!
Install and Configure EssentialsX
This document goes through how to install and configure EssentialsX on your Minecraft server.
Download EssentialsX
- Go to EssentialsX and click on the 1 Stable release button.
- Click on 2 Download.
Upload JAR File
- Go to the 1 Files tab.
- Navigate to the 2
pluginsdirectory. - Click on 3 Upload button and select the newly downloaded EssentialsX JAR file.
- Restart the server.
Configuration
- For detailed documentation, see the wiki.
- The configuration file of EssentialsX can be found at
/plugins/Essentials/config.yml.
Setting Up Permissions
- Use a permissions plugin like LuckPerms to set up permissions for different EssentialsX commands and features.
- Important permissions to configure include:
essentials.kit.default- for access to default kit.essentials.warp- for access to warps.essentials.spawn- for access to spawn.essentials.balance- for access to balance commands.- See the permissions list for all options.
Managing User Data
- User data like homes, warps, balances etc. are stored in
plugins/Essentials/userdata. - User data is stored in the UUID format.
- To find a player’s UUID, see the Reset Player Data in Minecraft guide.
- The commands for managing the data:
/home set [name]- Set home location./warp set [name]- Set warp location./balance set [user] [amount]- Set balance./mail send [user] [msg]- Send mail to user.- See the commands list for all options.
EssentialsX Addons
- EssentialsX has several addons that provide additional functionality:
EssentialsX Chat
- This addon enhances the chat and commands related to chat:
- Format chat messages with prefixes, suffixes etc.
- Censor/filter chat messages.
- Mute/unmute players from chatting.
- SocialSpy and admin chat modes.
EssentialsX Spawn
- Adds features related to spawns:
- Set multiple spawn points.
- Send players to different spawn points based on groups.
- Set spawn protection radius.
- Set spawn commands like
/spawn,/setspawnetc.
EssentialsX Protect
- Protect areas and blocks from griefing and undesirables:
- Claim and unclaim protected regions.
- Manage list of allowed/disallowed players in regions.
- Prevent block explode/fire spread in regions.
EssentialsX AntiBuild
- Prevent players from building/modifying map in worlds:
- Toggle build-permission for worlds.
- Limit players to only break blocks, not place them.
- Configure allowed build materials.
EssentialsX GeoIP
- Integrates GeoLite database to get player country information:
- Determine player's geographic location based on IP address.
- Admins can see lookup when players log in or in
/whois. - See the Module Breakdown for all the modules.
Install Addons
- Download the relevant .jar file and place it in the
pluginsfolder alongside EssentialsX.jar. - Restart the server to load the new addons.
- Configure each addon by editing its config file located in
plugins/Essentials/addons.
Additional Tips
- Use
/essentials reloadcommand to reload config changes. - Install add-ons like EssentialsChat, EssentialsSpawn, EssentialsAntiBuild for extra features.
- Backup
plugins/Essentialsfolder regularly for easy restore.
If you require further assistance, you can open a support ticket here.
Feedback and suggestions can be submitted here or further discussed on our Discord server.