Skip to content

Home

Jump to bottom
ZeroG Network edited this page Aug 25, 2026 · 49 revisions

NeoEssentials Wiki

Welcome to the official documentation hub for NeoEssentials v1.0.5 — a comprehensive NeoForge server essentials mod for Minecraft 1.21.1–1.21.10 (this is the primary development branch — see 26.1.x for the pinned Minecraft 26.1-26.1.2 build, or 26.2.x for the pinned Minecraft 26.2 build).

📚 Wiki Pages

Page Description
Commands Reference Every command — syntax, permission, aliases
Economy System Balances, pay, baltop, ChestShop, Vault API
Chat System Formatting, channels, rich text, AFK broadcasts
AFK System Auto-AFK, kick, tablist indicator, config
Moderation System Ban, mute, jail, freeze, vanish
Teleportation System Home, warp, TPA, RTP, spawn, safe teleport
Kit Management Kits, cooldowns, give-to-others, kitreset
Item Management Repair, enchant, powertool, clearinv, condense
Utility Systems Ptime, pweather, effects, spawnmob, unlimited, MOTD
Hologram System Animated /hologram displays, billboard/spin/hover, shop hologram click-to-trade, dashboard API
Permission System All permission nodes, groups, wildcards, external mods
Web Dashboard Setup, login, dashboard features, Discord auth
API & Placeholder System PlaceholderAPI, Vault, custom placeholders, stat tokens
Chat Channels Channel config, permissions, Discord relay
Split Config System Split config files, validation, repair, migration guide
Tablist System Animated header/footer, hex colors, gradients, per-group/per-player, PlaceholderAPI support
Localization System Server language selection, custom translations, language override commands
Storage Backend Pluggable JSON/YAML/SQLite/MySQL storage covering the whole mod
Dashboard Connectivity Internal vs. external dashboard hosting, webDashboard.mode, connection troubleshooting
Logging System Per-subsystem normal/debug logging toggles, categories, logs/debug.log

🚀 Getting Started

  1. Drop neoessentials-<version>.jar into your server's mods/ folder
  2. Start the server — config files are auto-generated in config/neoessentials/
  3. Key config files (split config mode — recommended):
    • main.json — modules, logging (see Logging System), localization, permissions, kits settings, economy settings
    • commands.json — enable/disable individual commands
    • chat.json — chat formatting, channels, anti-spam
    • teleportation.json — homes, warps, spawn, TPA
    • moderation.json — ban, jail, freeze, kick
    • tablist.json — tablist header/footer/formatting
    • security.json — input validation, allowUnsafeCommands (command safety checks), command length limits
    • Player balances, permission groups/users, and kit definitions are not flat config files — they're persisted through the pluggable Storage Backend (JSON/YAML/SQLite/MySQL) instead; see Storage Backend
    • webDashboard port/auth/UI settings currently live only in the monolithic config.json (not migrated to a split file — see Split Config System)
    • See Split Config System for the complete reference
  4. Assign permissions to players/groups via /permissions or LuckPerms/FTBRanks

⚙️ Optional Dependencies

Mod Purpose
LuckPerms External permission management (auto-detected)
FTB Ranks Alternative external permission management
Simple Discord Link Discord ↔ Minecraft auth and chat relay

All optional — NeoEssentials runs fully standalone without any of them.

💬 Support

NeoEssentials v1.0.5 · Minecraft 1.21.1–1.21.10 · NeoForge 21.1.179+ · build.54

Clone this wiki locally