Configuration Guide - ZeroG-Network/NeoEssentials GitHub Wiki

Configuration Guide

Complete guide to configuring NeoEssentials v1.0.2+ with the latest features including the comprehensive economy system, ultra-smooth animations, and advanced tablist customization.

📁 Configuration Structure

NeoEssentials uses a modern hybrid configuration system:

TOML Configs (`config/neoessentials/`)

Basic settings and system toggles:

general.toml - Core mod settings
homes.toml - Home system configuration
warps.toml - Warp system settings
kits.toml - Kit system configuration
database.toml - Database connection settings

YAML Configs (`config/neoessentials/`)

Advanced system configurations:

economy.yml - NEW! Complete economy system configuration

YAML Templates (`neoessentials/`)

Advanced template and animation configurations:

tablist.yml - Headers, footers, and group templates
animations.yml - Custom animation definitions

⚙️ Essential Configuration Files

`general.toml` - Core Settings

[general]
debug_mode = false
enable_metrics = true
locale = "en_US"

[performance]  
max_concurrent_operations = 100
cache_cleanup_interval = 300

`tablist.toml` - Tablist Performance

[tablist]
# Three-tier update system (NEW in v1.0.1.89)
update_interval = 3000              # Template switching (3 seconds)
placeholder_update_interval = 250   # Dynamic data (250ms)  
animation_frame_interval = 25       # Ultra-smooth animations (25ms)

enable_animations = true
enable_headers = true
enable_footers = true
enable_group_specific = true

`tablist.yml` - Templates & Animations

settings:
  update_interval: 3000
  placeholder_update_interval: 250
  animation_frame_interval: 25
  enable_animations: true

templates:
  headers:
    - "&6&l✦ &b&lNeoEssentials Server &6&l✦"
    - "<anim:welcome>"
    - "&a%player%&e! <anim:server_name>"
  footers:
    - "&eBalance: &a%balance% coins"
    - "<anim:example> &7| <anim:rainbow>"

🚀 Advanced Configuration

Three-Tier Update System

NEW in v1.0.1.89 - Revolutionary performance architecture:

Update Type	Interval	Purpose	Performance Impact
Template Switching	3000ms	Cycle through different templates	Minimal
Placeholder Updates	250ms	Dynamic data (player count, stats)	Low
Animation Frames	25ms	Ultra-smooth animation rendering	Optimized

Multiple Animation Placeholders

Configure unlimited simultaneous animations:

animations:
  welcome:
    interval: 100
    frames: ["&aW", "&aWe", "&aWel", "&aWelcome!"]
  
  rainbow:
    interval: 50  
    frames: ["&#FF0000Text", "&#FF7F00Text", "&#FFFF00Text"]
    
  pulse:
    interval: 25
    frames: ["&f●", "&7●", "&8●", "&7●"]

🔄 Configuration Management

Reloading Configuration

Reload without server restart:

/neoessentials reload          # Reload everything
/tablist reload               # Reload tablist only  
/neoessentials reload tablist # Reload specific system

File Format Support

YAML (.yml) - Recommended for readability
JSON (.json) - Alternative format
TOML (.toml) - Core configuration files

Priority: YAML > JSON > TOML (for templates)

Automatic Backups

NeoEssentials automatically creates backups:

Before updates: config_backup_YYYY-MM-DD/
On reload: .bak files created
On migration: Previous format preserved
Backups are stored in config/neoessentials/backups/
Files are timestamped for easy identification
Use /neoessentials config restore [filename] to restore a backup

Advanced Configuration

For advanced configuration topics, see:

Need Help?

If you need assistance with configuration: