Installation - EssentialsMiniReload

System Requirements

Server Software

Spigot / Paper / Purpur

Minecraft Version

1.20.6+

Java Version

17+

Using an older Minecraft version? Download the original EssentialsMini plugin for servers running versions before 1.20.6.

Installation Steps

Follow these simple steps to install EssentialsMiniReload:

Download the latest .jar file from the Downloads page
Place the jar file in your server's plugins folder
Start or restart your Minecraft server
Configure the plugin by editing files in plugins/EssentialsMini/
Restart your server again to apply configuration changes

Optional Dependencies

The following plugins enhance EssentialsMiniReload's functionality:

Vault

Required for economy integration with other plugins

LuckPerms

Recommended for advanced permission management

ProtocolLib

Enables extended packet-based features

Geyser

Optional support for Bedrock players connecting through Java

Floodgate

Optional support for Bedrock account checks with Geyser setups

Configuration

After installation, configuration files are automatically generated in:

plugins/EssentialsMini/

Common configuration files:

config.yml - Main plugin configuration
messages_en-EN.yml - Default language/messages
messages_nl-NL.yml - Example custom locale file
locations.yml - Home and warp locations
kits.yml - Kit definitions and cooldowns
mail.yml - Player mail data
nicks.yml - Player nicknames
tempMutes.yml - Temporary mute records
Language files - Customizable messages

Existing config.yml files are updated with missing default options and bundled comments on startup or /essentialsmini reload without overwriting configured values.

Custom Message Locales

Add custom message files to plugins/EssentialsMini/ using the messages_<locale>.yml format, for example messages_nl-NL.yml.

Enable custom locales with /essentialsmini messages add <locale> or by editing messages.customLocales in config.yml.

Create a locale from English defaults with /essentialsmini messages create <locale>, and inspect loaded and pending locales with /essentialsmini messages list.

messages:
  customLocales:
    - nl-NL
  promptForCustomLocales: true

Customization

Use the customization section in config.yml to configure prefixes, notifications, disabled-command messages, and GUI titles/items.

customization.prefixes - Feature-specific prefixes for economy, moderation, mail, teleport, help, kits, backpack, trash, and utility stations
customization.notifications - Chat/actionbar/title/sound delivery for teleport, mail, and economy notifications
customization.disabledCommands - Default disabled-command message plus per-command overrides such as help, me, and plugins
customization.guis - Titles and item material/name/lore settings for home, warp, kits, trash, backpack, and utility station GUIs

For /nick <nickname> <skin> troubleshooting, set skinDebug: true in config, reload, and check console output for [SkinDebug].

Storage Options

EssentialsMiniReload supports multiple storage backends:

YAML - Default, file-based storage
SQLite - Embedded database
MySQL - Remote database support
MongoDB - NoSQL database support

Configure storage options in the main config file based on your server's needs.

Permissions

All permissions use the essentialsmini. prefix.

Main admin permission: essentialsmini.*

Kit permissions: essentialsmini.kits.<kitname>

First Run Checklist

Install the plugin jar to the plugins folder
Start the server (files will be generated)
Configure permissions with your permission plugin (LuckPerms recommended)
Set spawn location using /setspawn
Test basic commands like /home and /warp
Customize messages in configuration files if desired
Restart the server to apply all changes

Need Help?

If you encounter issues during installation:

Check the server console for error messages
Verify Java version is 17 or higher
Ensure Minecraft version is 1.20.6 or higher
Visit the GitHub repository for documentation and issue tracking
Check the website at framedev.ch for support resources

Installation & Setup