OreoEssentials

🚀 Why OreoEssentials?

OreoEssentials is the next generation of server essentials, designed from the ground up for modern Minecraft networks with true cross-server synchronization. Clean, fast, and extremely easy to configure.

⚡ Core Features

🌐 Full Cross-Server Synchronization

True real-time sync powered by MongoDB + Redis + RabbitMQ
Not just shared databases—actual cross-server communication.

• 🔄 Player data follows users across your entire network
• 💬 Global chat and messaging
• 🚀 Cross-server teleports and homes
• 💰 Unified economy system
• 🛡️ Synchronized moderation tools

💬 Advanced Chat & Tab System

• ✅ Global chat across all servers
• ✅ Per-rank chat formats with PlaceholderAPI
• ✅ Custom chat channels (staff, admin, etc.)
• ✅ Discord webhook integration
• ✅ Beautiful tab headers and footers
• ✅ Fully customizable layouts

🏠 Homes & Warps

• ✅ Tier-based home limits (oreo.tier.vip, oreo.tier.mvp)
• ✅ Cross-server player warps
• ✅ RTP (Random Teleport) with safe spawn detection
• ✅ Configurable warmups and cooldowns
• ✅ Permission-based radius limits

💰 Economy System

• ✅ Vault API compatible
• ✅ Backend options: PostgreSQL or MongoDB
• ✅ Redis caching for performance
• ✅ RabbitEconomy for cross-server sync
• ✅ UltimateShopGUI integration

🎁 Kits & Items

• ✅ Unlimited custom kits
• ✅ Per-kit permissions and cooldowns
• ✅ Optional GUI interface
• ✅ Full ItemsAdder & Nexo support
• ✅ MythicMobs integration

🛠️ Moderation Tools

Complete suite including:

✓ Ban, Kick, Mute, Warn
✓ Vanish (with tab hiding)
✓ Freeze players
✓ Cross-server moderation logs
✓ Staff chat channels

🎨 Custom Features

🎯 Smart Utilities

• ✨ Modern GUIs with SmartInventories
• 📝 PlaceholderAPI support everywhere
• 🌍 Full localization system (lang.yml)
• 🗺️ Per-world configurations
• 🔑 Advanced permissions system

🧩 Web Editor (Config Builder)

📦 Installation

⚡ Quick Start

Step 1: Drop the JAR

📁 plugins/ 
  └── OreoEssentials.jar

Step 2: Generate Configs

Start your server once to auto-generate configuration files.

Step 3: Configure Databases

Edit config.yml with your database credentials:

MongoDB:
  enabled: true
  uri: "mongodb://user:[email protected]:27017/oreo"

RabbitMQ:
  enabled: true
  uri: "amqp://guest:[email protected]:5672/"

Redis:
  enabled: true
  host: "127.0.0.1"
  port: 6379
  password: "yourpass"

Step 4: Restart & Enjoy

Restart all servers — cross-server sync activates automatically! 🎉

💡 Need Help with Setup?

🔧 Cross-Server Requirements

Component	Purpose	Required?	Recommended?
	Core data storage (Homes, Warps, Inventories)	Yes ✅	Yes ⭐
	Real-time messaging (Chat/TP/Moderation)	Yes ✅	Yes ⭐
	Cache for Economy & Chat	Optional	Highly 🔥
	Alternative economy backend	Optional	Optional

📚 Full Setup Guides Available

Documentation: docs.oreostudios.fr/oreoessentials

• ✅ Cross-Server Sync Setup
• ✅ RabbitMQ on Pterodactyl (egg included)
• ✅ MongoDB + Redis Configuration
• ✅ Troubleshooting Guide

🎮 Feature Showcase

💬 Global Chat Example

┌─────────────────────────────────────────┐
│ [Survival] [VIP] Elias: Hello from      │
│                          Server 1! 👋    │
│                                          │
│ [Creative] [Admin] Sarah: Hey from      │
│                            Server 2! 🎨  │
└─────────────────────────────────────────┘

🔐 Private Channels

Configure custom channels in chat-format.yml:

channels:
  staff:
    format: "&c[Staff] {player}: &f{message}"
    permission: "oreoessentials.chat.staff"
  
  admin:
    format: "&4[Admin] {player}: &f{message}"
    permission: "oreoessentials.chat.admin"

📋 Cross-Server Commands

All standard commands work seamlessly across your entire network

Homes & Warps

• /home, /sethome, /delhome
• /warp, /setwarp, /delwarp
• /spawn, /setspawn

Teleportation

• /tpa, /tpaccept, /tpdeny
• /tphere, /tpall
• /back, /rtp

Communication

• /msg, /reply, /mail
• /broadcast, /staffchat

Economy

• /balance, /pay, /eco
• /baltop, /worth

Moderation

• /ban, /unban, /tempban
• /kick, /mute, /warn
• /freeze, /vanish

Utilities

• /kit, /kits
• /time, /weather
• /gamemode, /fly
• /heal, /feed

And many more...

🆚 Comparison with Other Plugins

Legend:

• ✅ Fully supported
• ⚙️ Basic/partial support
• ⚠️ Limited functionality
• ❌ Not available

🎬 Video Previews

🔌 Integrations

Plugin	Support Level	Description
	✅ Full	Complete economy integration
	✅ Full	Works everywhere in the plugin
	✅ Full	Custom items & blocks support
	✅ Full	Alternative custom items
	✅ Full	Custom mob integration
	✅ Full	Shop integration
	✅ Full	Advanced permissions

🚀 Velocity Support

For cross-server tab and join/quit messages on Velocity networks:

Download: Oreo Velocity Extension

Adds:

• Network-wide tab list
• Cross-server join/quit messages
• Unified player counts

⚙️ Technical Details

🚀 Performance

✓ Java 21 optimized
✓ Fully asynchronous I/O
✓ Redis caching layer
✓ Thread-safe operations
✓ Optimized for large networks

🖥️ Supported Platforms

Minimum Requirements:

• Java 21+
• Paper 1.20.1+ (or equivalent)

🗄️ Database Architecture

┌─────────────────────────────────────────┐
│         Application Layer               │
│         (OreoEssentials)                │
└─────────────┬───────────────────────────┘
              │
    ┌─────────┴──────────┐
    │                    │
┌───▼────┐          ┌────▼────┐
│ Redis  │◄────────►│ RabbitMQ│
│ Cache  │          │ Messages│
└───┬────┘          └─────────┘
    │
    │
┌───▼─────────────────────────────────┐
│  Primary Storage                     │
│  ┌──────────┐    ┌──────────────┐  │
│  │ MongoDB  │ or │ PostgreSQL   │  │
│  └──────────┘    └──────────────┘  │
└──────────────────────────────────────┘

Why This Architecture?

• MongoDB/PostgreSQL: Persistent, reliable data storage
• Redis: Lightning-fast cache for hot data
• RabbitMQ: Real-time cross-server messaging
• Result: Best of all worlds—speed, reliability, and real-time sync

🛡️ Permissions

🔑 Quick Access Permissions

# Full admin access
oreo.*

# Administrative commands
oreo.admin

# Moderation tools only
oreo.mod

🎯 Tier System

The tier system allows you to create VIP ranks with enhanced limits:

Example Configuration:

tiers:
  default:
    homes: 5
    rtp-radius: 5000
  
  vip:
    homes: 10
    rtp-radius: 7500
  
  mvp:
    homes: 20
    rtp-radius: 10000

📋 Command Permissions

Per-command permissions are automatically generated:

Home Commands

• oreo.home - Use /home
• oreo.sethome - Set homes
• oreo.delhome - Delete homes
• oreo.homes - List homes

Warp Commands

• oreo.warp - Use /warp
• oreo.setwarp - Create warps (admin)
• oreo.delwarp - Delete warps (admin)

Economy Commands

• oreo.balance - Check balance
• oreo.pay - Send money
• oreo.baltop - View top balances

Moderation Commands

• oreo.ban - Ban players
• oreo.kick - Kick players
• oreo.mute - Mute players
• oreo.vanish - Toggle vanish

Utility Commands

• oreo.fly - Toggle flight
• oreo.heal - Heal yourself
• oreo.feed - Feed yourself
• oreo.gamemode - Change gamemode

And many more...

📝 Configuration Examples

💬 Chat Formats

chat-format:
  # Default chat format
  default: "&7{player}: &f{message}"
  
  # VIP players
  vip: "&6[VIP] &e{player}: &f{message}"
  
  # Staff members
  staff: "&b[Staff] &3{player}: &f{message}"
  
  # Administrators
  admin: "&c[Admin] &4{player}: &f{message}"
  
  # Owner
  owner: "&d[Owner] &5{player}: &f{message}"

Supports PlaceholderAPI:

custom: "&7[{vault_rank}] &r{player_displayname}&7: &f{message}"

📊 TabList Header/Footer

tablist:
  header: |
    &6&l━━━━━━━━━━━━━━━━━━━━━━━
    &e&lOreo Network
    &7Your adventure awaits
    &6&l━━━━━━━━━━━━━━━━━━━━━━━
  
  footer: |
    &6&l━━━━━━━━━━━━━━━━━━━━━━━
    &ePlayers: &f{online}/{max}
    &ePing: &f{ping}ms
    &eRank: &f{vault_rank}
    &6&l━━━━━━━━━━━━━━━━━━━━━━━

🚀 RTP (Random Teleport) Settings

rtp:
  # Default radius for all players
  default-radius: 5000
  
  # Maximum radius limit
  max-radius: 15000
  
  # Safe spawn checking
  safe-spawn: true
  
  # Warmup time (seconds)
  warmup: 3
  
  # Cooldown between uses (seconds)
  cooldown: 300
  
  # Tier-based radius multipliers
  tier-multipliers:
    default: 1.0
    vip: 1.5      # 7,500 blocks
    mvp: 2.0      # 10,000 blocks
    ultimate: 3.0 # 15,000 blocks
  
  # Blacklisted biomes
  blacklisted-biomes:
    - OCEAN
    - DEEP_OCEAN
    - LAVA_OCEAN

🎁 Kit Configuration

kits:
  starter:
    # Items in the kit
    items:
      - "DIAMOND_SWORD 1 name:&bStarter_Sword"
      - "COOKED_BEEF 32"
      - "GOLDEN_APPLE 5"
    
    # Permission required
    permission: "oreo.kit.starter"
    
    # Cooldown (seconds, 0 = once per player)
    cooldown: 0
    
    # Description shown in GUI
    description:
      - "&7A starter kit for new players"
      - "&eIncludes: Sword, Food, Golden Apples"
  
  vip:
    items:
      - "DIAMOND_CHESTPLATE 1 enchant:PROTECTION:4"
      - "DIAMOND_PICKAXE 1 enchant:EFFICIENCY:5"
      - "ENDER_PEARL 16"
    permission: "oreo.kit.vip"
    cooldown: 86400  # 24 hours
    description:
      - "&6&lVIP Kit"
      - "&eDaily rewards for VIP players"

🏠 Home Limits by Tier

homes:
  limits:
    default: 5
    vip: 10
    mvp: 20
    ultimate: 50
  
  # Allow setting homes in specific worlds
  allowed-worlds:
    - world
    - world_nether
    - world_the_end
  
  # Warmup before teleport
  warmup: 3
  
  # Cooldown between home teleports
  cooldown: 5

🌀 Portal Configuration

portals:
  spawn:
    # Portal location (min corner)
    location1:
      world: world
      x: 100
      y: 64
      z: 200
    
    # Portal location (max corner)
    location2:
      world: world
      x: 110
      y: 74
      z: 210
    
    # Destination
    destination:
      world: world
      x: 0
      y: 100
      z: 0
    
    # Particle effect
    particle: PORTAL
    
    # Sound effect
    sound: ENTITY_ENDERMAN_TELEPORT

🤝 Support & Community

📚 Get Help

❤️ Support Development

This plugin is 100% Open Source and maintained by passionate developers.

Ways to Support:

• 💝 Donate via PayPal
• ⭐ Leave a positive review
• 📢 Share with other server owners
• 🐛 Report bugs and help improve the plugin
• 📝 Contribute to documentation

Every bit of support helps us continue development and add new features!

🏢 Official Partners

Features:

• ⚡ High-performance servers
• 🗄️ Database support (MongoDB, Redis, RabbitMQ)
• 🌐 Perfect for multi-server networks
• 🛠️ Easy setup and management
• 💬 Great support

Get 10% OFF with code: OREOSTUDIOS

🔗 Order Now: minestrator.com/a/OREOSTUDIOS

📜 License

🏆 Why Choose OreoEssentials?