ServerEssentials Setup Guide

Complete installation and configuration guide for ServerEssentials. Get your server up and running in minutes!

Start Installation Troubleshooting Download Plugin
Installation Dependencies Configuration First Start Troubleshooting FAQ

📋 Quick Overview

⚡
Lightweight
Designed for performance with async code and minimal server impact
🎯
All-in-One
Homes, warps, economy, shops, and admin tools in one plugin
🔧
Customizable
Every feature can be enabled/disabled in the config
🌍
Multi-Language
Support for multiple languages with per-player settings

🚀 Installation Guide

Step 1: Download the Plugin

Download ServerEssentials from the official Modrinth page:

Make sure you download the correct version for your Minecraft server version (1.17-1.21.11 supported).

Step 2: Install Dependencies FIRST

⚠️ CRITICAL: ServerEssentials will NOT work without these 3 dependencies. Install them BEFORE starting your server:

🔴 IMPORTANT: Install these plugins in this exact order:

1. Vault (Required for Economy)

💰 Download Vault →

2. LuckPerms (Required for Permissions)

🔐 Download LuckPerms →

3. PlaceholderAPI (Required for Placeholders)

🏷️ Download PlaceholderAPI →
✅ Simple Installation: Just put these 3 JAR files in your plugins folder, then add ServerEssentials!
Step 3: Install ServerEssentials

Now you can add ServerEssentials to your plugins folder:

📁 Your plugins folder should look like this:
  • Vault.jar ✅
  • LuckPerms.jar ✅
  • PlaceholderAPI.jar ✅
  • ServerEssentials-2.0.7.jar ← Add this one
Step 4: Start Your Server

Start your server and watch the console. You should see ServerEssentials loading messages:

[ServerEssentials] Enabling ServerEssentials v2.0.7
[ServerEssentials] Loading configuration files...
[ServerEssentials] Successfully loaded!
// Look for these messages in your server console
✅ Success! If you see these messages, ServerEssentials is working correctly.

🔗 Required Dependencies

These 3 plugins MUST be installed for ServerEssentials to function properly:

💰 Vault

What it does: Connects ServerEssentials to your economy plugin and permission system.

Why you need it: Without Vault, economy features (/balance, /pay, shops) won't work.

✅ Install first - Required for money features
🔐 LuckPerms

What it does: Manages who can use which commands.

Why you need it: Without LuckPerms, players will get "No permission" errors.

✅ Install second - Required for permissions
🏷️ PlaceholderAPI

What it does: Provides dynamic text for messages and scoreboards.

Why you need it: Without PAPI, custom messages and scoreboards won't work properly.

✅ Install third - Required for custom text
🚨 What happens if I skip dependencies?
  • ❌ ServerEssentials won't start at all
  • ❌ You'll see red error messages in console
  • ❌ Commands won't work properly
  • ❌ Economy and permissions will be broken

⚙️ Basic Configuration

Step 1: Understanding the Config Files

After first startup, ServerEssentials creates several files in plugins/ServerEssentials/:

Main Configuration Files:

📄 config.yml - Main settings (enable/disable features)
🗣️ lang/en.json - Language files (change messages)
🎁 kits.yml - Starter kits for new players
🛒 shops/ - Shop configuration folder
Step 3: Set Up Basic Permissions

Use these simple commands to give players access to basic features:

🔹 For Regular Players (Default Group)

💰 /lp group default permission set serveressentials.command.balance
// Let players check their money
🏠 /lp group default permission set serveressentials.command.home
// Let players teleport home
📍 /lp group default permission set serveressentials.command.warp
// Let players use warps
🚀 /lp group default permission set serveressentials.command.rtp
// Let players random teleport

🔹 For Staff/Moderators

🛡️ /lp group moderator permission set serveressentials.command.god
// God mode for moderators
👻 /lp group moderator permission set serveressentials.command.vanish
// Vanish for moderators
🛫 /lp group moderator permission set serveressentials.command.fly
// Fly mode for moderators
🎯 Easy Way: Type /lp editor in-game for a web-based permission editor - much easier than commands!

🎯 First Start Checklist

Step 1: Test Basic Commands

Join your server and try these commands to verify everything works:

✅ Test These Commands:

📊 /ping
// Should show your connection speed
💰 /balance
// Should show your money (starting with $0)
🏠 /sethome base
// Should create a home named "base"
🚀 /rtp
// Should teleport you randomly
✅ If all these work: ServerEssentials is installed correctly!
❌ If any fail: Check the troubleshooting section below
Step 2: Set Up Your Spawn

Create your main spawn/welcome area:

🏗️ Build Your Spawn:

  1. Go to your desired spawn location
  2. /lobby set - Sets the main spawn point
  3. /setwarp spawn - Creates a warp called "spawn"
  4. /setwarp tutorial - Creates a tutorial area
💡 New players will automatically teleport to /lobby when they join!
Step 3: Create Starter Kits

Give new players a welcome kit:

🎁 Basic Starter Kit Setup:

  1. Go to /plugins/serveressentials/kits.yml
  2. Configure different types of Kits - Caution: a wrong YAML structure can break the Kit
  3. /kit reload - Reload the Kit System
You can now claim your configured Kits with /kit

🛠️ Common Problems & Solutions

❌ "Plugin won't load"

What you see: Red error messages in console, plugin not in /plugins list

Most likely cause: Missing dependencies

✅ Fix: Install Vault, LuckPerms, and PlaceholderAPI first, then restart server
💰 "Balance command not working"

What you see: "No economy plugin found" or balance shows $0

Most likely cause: Missing economy plugin

✅ Fix: Install an economy plugin like EssentialsX Economy or CMI alongside Vault
🔐 "No permission" errors

What you see: "You don't have permission to use this command"

Most likely cause: LuckPerms not set up

✅ Fix: Type /lp editor and add permissions for your player groups
🌐 "No such pool found: "%pool%" error

What you see: Database errors when enabling a Database

Most likely cause: Config mismatch

✅ Fix: Join the Support Discord, ask the Dev for help
Console Error Decoder

See an error message? Here's what it means:

❌
"Could not load 'ServerEssentials.jar'"
→ Install Vault, LuckPerms, and PlaceholderAPI first!
❌
"No economy plugin found via Vault!"
→ Install an economy plugin (EssentialsX Economy, CMI, etc.)
❌
"Permission check failed"
→ Use /lp editor to set up permissions
❌
"Database is locked"
→ Restart your server properly (don't force-close)

🚫 Common Mistakes to Avoid

❌ DON'T DO THESE:

  1. Install ServerEssentials before dependencies - Always install Vault, LuckPerms, PAPI first
  2. Use /reload instead of restart - Always do a full server restart when adding plugins
  3. Edit config files while server is running - Stop server, edit files, then restart
  4. Give players * permissions - Use specific permissions instead of wildcards
  5. Ignore console errors - Fix problems immediately before they get worse
  6. Use cracked/illegal plugin versions - Only download from official Modrinth page
  7. Skip permission setup - Players can't use commands without permissions!

✅ DO THESE INSTEAD:

  1. Install dependencies first, then ServerEssentials
  2. Always do full server restarts
  3. Edit configs with server stopped
  4. Use specific permissions for each group
  5. Fix errors as soon as you see them
  6. Download only from official sources
  7. Set up basic permissions for each player group

❓ Frequently Asked Questions

Do I really need all 3 dependencies?

▼

Yes, 100% required! Here's why:

  • Vault = Money system (shops, /pay, /balance)
  • LuckPerms = Who can use which commands
  • PlaceholderAPI = Custom text in messages/scoreboards

Without any of these, ServerEssentials will either not start or have broken features.

Can I use ServerEssentials with EssentialsX?

▼

Not recommended. Both plugins have the same commands (/home, /warp, etc.) which causes:

  • Command conflicts and confusion
  • Permission problems
  • Unexpected behavior
  • Potential server issues

Choose one: ServerEssentials has MORE features than EssentialsX and is actively maintained!

How do I set up permissions easily?

▼

Easiest way: Use the web editor!

  1. Type /lp editor in your server console
  2. Click the link it gives you
  3. Use the web interface to drag-and-drop permissions
  4. Click save and apply changes

Much easier than typing long commands!

What economy plugin should I use?

▼

The only working Eco Plugin:

  • Vault - Simple, reliable, most popular

Install process: Download Vault → Put in plugins folder → Restart server → Done!

Can I disable features I don't want?

▼

No, you cant:

  1. Disabling certain commands is not supported yet Fix: Dont give the players permission for a command

How many homes can players have?

▼

You control this with permissions:

  • serveressentials.sethome.1 = 1 home
  • serveressentials.sethome.5 = 5 homes
  • serveressentials.sethome.* = Unlimited homes

Example: Give VIP players 10 homes, regular players 3 homes

Is ServerEssentials laggy?

▼

No! It's designed to be lightweight:

  • Uses async code for database operations
  • Minimal memory footprint
  • Efficient caching system
  • Tested on servers with 100+ players

Actually performs BETTER than EssentialsX in most cases!

What if I need more help?

▼

Support options:

  • Check this guide again - Most problems are covered here
  • GitHub Issues - Report bugs on the GitHub page
  • Discord - Join the community Discord for help
  • Test server - Set up a test server to experiment safely

Always include your server version, plugin version, and console errors when asking for help!

🚀 Advanced Tips

Performance Optimization

⚡ Make ServerEssentials even faster:

🗄️
Disable unused features in config.yml
// Less features = better performance
📊
Reduce scoreboard update frequency
// Update scoreboards less often
🎯
Limit RTP range for faster location finding
// Smaller search area = faster RTP
Custom Languages

🌍 Add your own language:

  1. Copy lang/en.json to lang/yourlang.json
  2. Translate all the messages
  3. Restart server
  4. Players can use /language yourlang