An open API service indexing awesome lists of open source software.

https://github.com/snipertvmc/essentialsx-gui

A GUIs add-on for EssentialsX plugin.
https://github.com/snipertvmc/essentialsx-gui

Last synced: 5 months ago
JSON representation

A GUIs add-on for EssentialsX plugin.

Awesome Lists containing this project

README

          

Logo

# EssentialsX-GUI

EssentialsX-GUI is an EssentialsX addon that adds some GUIs for Essentials features, like homes, kits, warps, etc..

[![Download](https://img.shields.io/github/downloads/SniperTVmc/EssentialsX-GUI/total?style=for-the-badge)](https://github.com/SniperTVmc/EssentialsX-GUI/releases/latest)
[![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](https://github.com/SniperTVmc/EssentialsX-GUI/blob/Main/LICENSE)
[![CodeFactor](https://www.codefactor.io/repository/github/snipertvmc/essentialsx-gui/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/snipertvmc/essentialsx-gui)
[![Issues](https://img.shields.io/github/issues/SniperTVmc/EssentialsX-GUI?style=for-the-badge)](https://github.com/SniperTVmc/EssentialsX-GUI/issues)

## ✨ | Features

### Homes:
- Customize the appearance of your home in the homes' GUI
- Customizable home display name.
- Customizable home display icon.
- Per-player home item editor.
- Infinite number of homes supported.
- Play custom sounds when an action is performed.

> **Supported EssentialsX features (2/2):**
> - Essentials Homes
> - Home limit per player.
### Kits:
- Customize the appearance of your kits in the kits' GUI
- Customizable kit display name.
- Customizable kit display icon.
- Infinite number of kits supported.
- Play custom sounds when an action is performed.
- Admin view to manage kits.
- Chose a player and give him a kit.
- Per-kit item editor.
- Player view to see owned kits.
- Give kit to player when clicking on it.
- Kits preview in a GUI.

> **Supported EssentialsX features (3/3):**
> - Essentials Kits
> - Cooldown for each kit.
> - Permission for each kit.
### Warps :
- 🚧 ~~Available in an upcoming update.~~

## 🔨 | How to install EssentialsX-GUI ?

Requirements:

- Minecraft Server: **Java Edition**
- Java Version: **16+**
- EssentialsX Version: **2.21.1+**
- Supported Versions: **[Click to view list](#supported-versions)**

First, install the latest version of EssentialsX-GUI [here](https://github.com/SniperTVmc/EssentialsX-GUI/releases/latest).

Then drop the file `EssentialsX-GUI-[version].jar` in the `plugins/` folder of your server.

Finally, __restart__ the server and you're done!

## 📋 | Supported Versions

| Version name | Status | Tested plugin version |
|:-----------------:|:------:|-----------------------|
| 1.8.8 and earlier | 🟧 | ✖️ |
| 1.8.8 | ✅ | 1.0.0-beta5 |
| 1.12.2 | ✅ | 1.0.0-beta5 |
| 1.16.5 | ✅ | 1.0.0-beta5 |
| 1.21.4 | ✅ | 1.0.0-beta5 |
| 1.8.8 and higher | 🟧 | ✖️ |

> Legend:
> - ✅ : Supported
> - 🟨 : Partially supported
> - 🟧 : Not tested
> - ❌ : Not supported

## 📢 | Servers using EssentialsX-GUI

Are you using our plugin and would like to add your server to the list? Join [Discord Server](https://discord.gg/fSzK79TAYf).

## ❓ | Support

For support, join [Discord Server](https://discord.gg/fSzK79TAYf).