Skip to content

⚙️ Configuration

EssentialsPlus automatically creates and manages configuration files after the first server start. This page provides an overview of all configuration files and their purposes.

Quick Start

For initial setup, you typically only need to edit:

Directory Structure

After the first start of the plugin, the following structure is created:

mods/fof1092_EssentialsPlus/
├── config.json         # Main configuration file
├── homes.json          # Stores all player homes
├── rules.json          # Configurable server rules
├── warps.json          # Stores all server warps
├── spawns.json         # Stores all server spawns
├── ipbans.json         # Stores all IP bans
├── adminshop.json      # Admin shop items with buy/sell prices
├── announcements.json  # Announcement system configuration
├── languages/          # Directory containing language files
│   ├── en-US.lang      # English (US) translations
│   ├── de-DE.lang      # German translations
│   ├── ...             # Other translations
│   └── override.lang   # Global override translations (highest priority)
├── kits/               # Directory containing kit definitions
│   └── kitname.json    # Individual kit files (one per kit)
├── mails/              # Directory containing player mailboxes
│   └── user-uuid.json  # Individual mailbox files (one per player)
└── users/              # Directory containing user data
    └── user-uuid.json  # Individual user files (one per player)

Getting Started

First-Time Setup

  1. Start your server with EssentialsPlus installed
  2. Stop the server after initial generation
  3. Edit config.json to customize features
  4. Edit rules.json to set your server rules (optional)
  5. Edit announcements.json (optional)
  6. Reload the Mod - reload the mod using /essentialsplus reload

Common Configuration Tasks

TaskFile to EditSection
Change chat formatconfig.jsonchat.groups
Enable/disable featuresconfig.jsonFeature-specific sections
Configure teleport cooldownsconfig.jsoninterception.cooldowns
Customize welcome messagesconfig.jsonfirstJoin.messages
Set up server rulesrules.jsonrules array
Create automated broadcastsannouncements.jsonannouncements array
Customize message textlanguages/override.langAny translation key

Configuration Files

Manual Configuration (Editable)

These files are designed to be edited by server administrators:

config.json

Main configuration file containing all plugin features and settings.

What you can configure:

  • Feature toggles (enable/disable commands and systems)
  • Chat formatting and groups
  • Teleportation settings (warmup, cooldown, costs)
  • Economy settings
  • First-join configuration
  • Join/quit messages
  • MOTD (Message of the Day)
  • And much more...

Recommended for: Initial setup, customizing plugin behavior


rules.json

Server rules displayed to players with /rules.

What you can configure:

  • List of server rules
  • Custom formatting with color codes
  • Rule numbering and structure

Recommended for: Setting up server guidelines for your community


announcements.json

Automated announcement system for broadcasting messages to players.

What you can configure:

  • Broadcast interval
  • Multiple announcement messages
  • Chat, title, notification, and sound messages
  • Per-announcement permissions (target specific player groups)
  • Random or sequential order
  • Commands to run with announcements

Recommended for: Regular server messages, reminders, events


languages/

Translation files for multi-language support and custom messages.

Available languages:

  • Available by default: English (US), German, Spanish, French, Portuguese, Turkish
  • Additional languages can be added as needed
  • override.lang - Override any message across all languages

What you can configure:

  • Custom translations for any plugin message
  • Multi-language support for your community
  • Server-specific terminology

Recommended for: Customizing player-facing messages, translating content


Auto-Managed Files (Do Not Edit)

These files are automatically created and updated by the plugin. Manual editing is strongly discouraged as your changes may be overwritten or cause data corruption.

homes.json

Stores all player home locations set with /sethome.

  • ⚠️ Auto-managed - Modified via /sethome, /delhome, /home commands
  • Contains: Home name, position, rotation, world, player UUID

warps.json

Stores all server warp points set with /setwarp.

  • ⚠️ Auto-managed - Modified via /setwarp, /delwarp, /warp commands
  • Contains: Warp name, position, rotation, world

spawns.json

Stores all spawn points set with /setspawn.

  • ⚠️ Auto-managed - Modified via /setspawn command
  • Contains: Main spawn, per-world spawns, position, rotation, world
  • Features: Multiple spawn points, one main spawn, per-world spawn support

ipbans.json

Stores all IP bans issued with /ipban.

  • ⚠️ Auto-managed - Modified via /ipban, /unipban commands
  • Contains: IP address, player UUID, username, reason, ban timestamp, banned by

adminshop.json

Stores admin shop items with buy/sell prices.

  • ⚠️ Auto-managed - Modified via /adminshop add, /adminshop remove commands
  • Contains: Item ID, buy price, sell price
  • Supports: Buy-only, sell-only, or buy-and-sell items

kits/

Individual kit files for each kit created with /kit create.

  • ⚠️ Auto-managed - Modified via /kit create, /kit edit, /kit delete commands
  • Contains: Kit name, cooldown, items (inventory, armor, hotbar, utility)
  • Each kit is stored in a separate file: kitname.json

mails/

Player mailboxes with received and sent messages.

  • ⚠️ Auto-managed - Modified via /mail send, /mail read, /mail delete commands
  • Contains: Inbox, sent messages, attachments, timestamps
  • Each player has their own file: user-uuid.json

users/

Player data files containing balances, timestamps, and status information.

  • ⚠️ Auto-managed - Modified automatically by plugin systems
  • Contains: UUID, username, balance, join timestamps, mute/ban status, ignored players, IP history
  • Each player has their own file: user-uuid.json

Tips & Best Practices

Backup Your Configuration

Always backup your configuration files before making major changes:

Version Control

The version field in configuration files helps the plugin manage updates. Don't modify this field unless you know what you're doing.

Hot Reload

Most changes to config.json, rules.json, and announcements.json can be reloaded without restarting the server using /essentialsplus reload.

Data Files

Never manually edit files in users/, mails/, kits/, or data files like homes.json, warps.json, etc. Use in-game commands instead to prevent data corruption.