![[FORK] Kit Preview Essentialsx addon](https://www.spigotmc.org/data/resource_icons/126/126847.jpg?1753024300){kind=icon}
KitsPreview
Let players preview EssentialsX kits before they claim them
A fork of Kit Preview EssentialsX Addon by EnzoL_.
Let players preview EssentialsX kits before they claim them
A fork of Kit Preview EssentialsX Addon by EnzoL_.
Overview
KitsPreview is a companion plugin for servers running EssentialsX kits. It gives players a clean, intuitive GUI to see exactly what's inside a kit before they claim it, and lets admins fully customize each preview's layout for a polished, professional look.
Previews also know where the player came from. Open one from your kits menu and the back button returns them to the kits menu, open the same kit from your store menu and it returns them there instead, so the preview slots into whatever menu system you already run.
✨ Features
- GUI Kit Previews: players open a graphical menu showing every item in a kit with one command.
- Customizable Layouts: arrange each kit's preview items into the exact positions you want.
- Back Button With Context: the preview remembers which menu it was opened from and sends players straight back there.
- Your Own Items: add any items you like to the preview, with click actions, custom heads, and placeholders.
- Sign Integration: place a sign players can right-click to instantly open a kit preview, with fully configurable text.
- EssentialsX Integration: automatically loads all your existing Essentials kits.
- Admin Editing Tools: a dedicated command set to create, edit, and manage preview inventories.
- Configurable: customize GUI titles, sign formats, and every custom item to match your server's theme.
Back Button & Menu Contexts
Open a preview with a context, a label saying which menu the player came from:
Code (Text):
/kitpreview <kit> [context]
Code (YAML):
# kits menu
left_click_commands :
- ' [player ] kitpreview warrior kits'
# store menu
left_click_commands :
- ' [player ] kitpreview warrior store'
left_click_commands :
- ' [player ] kitpreview warrior kits'
# store menu
left_click_commands :
- ' [player ] kitpreview warrior store'
Code (YAML):
contexts:
default:
back-actions :
- "[close]"
kits:
back-actions :
- "[player] dm open kits"
store:
back-actions :
- "[console] dm open store {player}"
default:
back-actions :
- "[close]"
kits:
back-actions :
- "[player] dm open kits"
store:
back-actions :
- "[console] dm open store {player}"
Custom Items
Add as many items as you like to the preview, each with its own material, name, lore, glow, slot and click actions. Use material: PLAYER_HEAD with a texture: value for a custom head, from base64, a texture URL, or a player name.
slot takes a number, a negative number counted from the end, or one of top-left, top-center, top-right, bottom-left, bottom-center and bottom-right.
Actions run top to bottom when the item is clicked:
- [back] go back through the context the player arrived with
- [player] <command> run a command as the player
- [console] <command> run it from console, with {player} for the name
- [close] close the menu
- [message] <text> send a chat line
- [sound] ENTITY_EXPERIENCE_ORB_PICKUP;1;1 play a sound
{player}, {kit} and {context} work in names, lore and commands, and PlaceholderAPI placeholders do too if you have it installed.
Commands & Permissions
Spoiler: Commands and Permissions
Player Commands
Admin Commands (kitpreview.edit)
Reload (kitpreview.reload, op by default)
Sign Creation (kitspreview.sign)
- /kitpreview <kit> [context] open the preview GUI for a kit, with an optional context label (no permission required)
Admin Commands (kitpreview.edit)
- /kiteditpreview createinventory <rows> <kit> create a new preview inventory for a kit
- /kiteditpreview edit <kit> open the editor to arrange a kit's preview items
- /kiteditpreview setrows <rows> <kit> change the number of rows for a kit's preview GUI
Reload (kitpreview.reload, op by default)
- /kitpreview reload reread the config, so you can set your menus up without restarting
Sign Creation (kitspreview.sign)
- Place a sign with [kitpreview] on the first line and the kit name on the second line.
⚙ Configuration
Spoiler: config.yml
# Configure the format of the kit preview signs.
# Use {kitname} as a placeholder for the kit's name.
sign:
lines:
1 : "&a[KitPreview]"
2 : "&e{kitname}"
3 : ""
4 : ""
# Configure the title of the preview GUI.
gui:
title : "&eKit preview {kit}"
items:
balance : GOLD_NUGGET
commands : COMMAND_BLOCK
# Where the back button sends players, per context label.
contexts:
default:
back-actions :
- "[close]"
kits:
back-actions :
- "[player] dm open kits"
# Items placed inside the preview.
custom-items:
back:
enabled : true
material : ARROW
amount : 1
name : "&c&lBack"
lore :
- "&7Return to the previous menu."
glow : false
slot : bottom-left
actions :
- "[back]"
# Pressing Esc also runs the back action.
back-on-close : false
Code (YAML):
# Configure the format of the kit preview signs.
# Use {kitname} as a placeholder for the kit's name.
sign:
lines:
1 : "&a[KitPreview]"
2 : "&e{kitname}"
3 : ""
4 : ""
# Configure the title of the preview GUI.
gui:
title : "&eKit preview {kit}"
items:
balance : GOLD_NUGGET
commands : COMMAND_BLOCK
# Where the back button sends players, per context label.
contexts:
default:
back-actions :
- "[close]"
kits:
back-actions :
- "[player] dm open kits"
# Items placed inside the preview.
custom-items:
back:
enabled : true
material : ARROW
amount : 1
name : "&c&lBack"
lore :
- "&7Return to the previous menu."
glow : false
slot : bottom-left
actions :
- "[back]"
# Pressing Esc also runs the back action.
back-on-close : false
Dependencies
- EssentialsX (required)
- PlaceholderAPI (optional) for placeholders in custom item names, lore and commands
Compatibility
- Minecraft: 1.16+
- Server software: Spigot, Paper, Purpur
- Java: 17 or higher
- Requires: EssentialsX
Support
Found a bug or have a suggestion? Post in the Discussion tab or join the Discord.
Metrics
This plugin uses bStats to collect anonymous usage stats. You can opt out anytime in plugins/bStats/config.yml.
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft versions listed: 1.16, 1.17, 1.18
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
[FORK] Kit Preview Essentialsx addon is a free Minecraft Java mod. Compatible with Minecraft 1.16, 1.17, 1.18, 1.19 and newer. Downloaded 201 times (via Spigot). Download it and open it directly in the game.