📖 Table of Contents

• ✨ Why HeliosAdmin?
• 📋 Requirements
• 📥 Installation
• 🎮 Commands
• 🔐 Permissions
• 🌐 Web Dashboard
• ⚙️ Configuration
• 🚀 Quick-Start Examples
• ❓ FAQ
• 💬 Support

✨ Why HeliosAdmin?

HeliosAdmin replaces 5–6 separate plugins (essentials, ban systems, homes/warps, kits, backups) with one unified plugin that shares data, permissions, audit logs, and storage with every other Helios plugin via HeliosCore.

✅ Drop-in replacement for EssentialsX • LuckPerms-ready • Adventure / MiniMessage native

📋 Requirements

⚠️ HeliosCore is required. HeliosAdmin will not start without it. After installing HeliosCore for the first time, you must run /hcore setup before HeliosAdmin's dashboard features will work.

📥 Installation

1. Drop HeliosCore-x.y.z.jar     →  plugins/
2. Drop HeliosAdmin-x.y.z.jar    →  plugins/
3. Start the server (data folders & configs auto-generate)
4. Run  /hcore setup             (initialise dashboard owner — REQUIRED)
5. Edit plugins/HeliosAdmin/config.yml to taste
6. Run  /hadmin reload
7. (Optional) Configure your permission plugin — see Permissions below

That's it. Every command and permission node is registered automatically.

🎮 Commands

Aliases: /hadmin • /ha • /nadmin • /na • /heliosadmin • /ninezadmin

🔐 Permissions

HeliosAdmin uses a clean, hierarchical permission tree that drops straight into LuckPerms, GroupManager, PermissionsEx, or vanilla op.

🌳 Hierarchy

heliosadmin.admin                 (default: op)  ━ grants EVERYTHING
└── heliosadmin.command.all                       ━ all leaf nodes below
    ├── heliosadmin.command.<each-command>
    ├── heliosadmin.home.use      / heliosadmin.home.set
    ├── heliosadmin.warp.use      / heliosadmin.warp.manage
    ├── heliosadmin.spawn.use     / heliosadmin.command.setspawn
    ├── heliosadmin.tpa
    ├── heliosadmin.kit.use       / heliosadmin.kit.manage
    └── heliosadmin.command.backup

🎁 Player Defaults (granted to everyone out of the box)

• ✅ heliosadmin.home.use • heliosadmin.home.set
• ✅ heliosadmin.warp.use
• ✅ heliosadmin.spawn.use
• ✅ heliosadmin.tpa
• ✅ heliosadmin.kit.use

Everything else defaults to false — staff opt-in only.

💡 Suggested LuckPerms Setup

# ────────────── Helper / Trial Mod ──────────────
/lp group helper permission set heliosadmin.command.kick true
/lp group helper permission set heliosadmin.command.mute true
/lp group helper permission set heliosadmin.command.tempmute true
/lp group helper permission set heliosadmin.command.unmute true
/lp group helper permission set heliosadmin.command.warn true
/lp group helper permission set heliosadmin.command.warnings true
/lp group helper permission set heliosadmin.command.history true
/lp group helper permission set heliosadmin.command.invsee true
/lp group helper permission set heliosadmin.command.ecsee true
/lp group helper permission set heliosadmin.command.vanish true
/lp group helper permission set heliosadmin.command.whois true
/lp group helper permission set heliosadmin.command.freeze true

# ────────────── Moderator ──────────────
/lp group mod parent add helper
/lp group mod permission set heliosadmin.command.ban true
/lp group mod permission set heliosadmin.command.tempban true
/lp group mod permission set heliosadmin.command.unban true
/lp group mod permission set heliosadmin.command.clearwarnings true
/lp group mod permission set heliosadmin.command.broadcast true

# ────────────── Admin (everything) ──────────────
/lp group admin permission set heliosadmin.admin true

🌐 Web Dashboard

HeliosAdmin contributes a page to the HeliosCore live dashboard. From your browser you can:

• 📡 Stream real-time audit logs via SSE
• 💾 Create, list, delete, and restore world backups with one click
• 👥 See live server status and player counts
• 🔒 Access role-gated actions (OWNER / ADMIN / STAFF) configured in config.yml

💡 First-time setup: run /hcore setup to create the dashboard owner account. The dashboard will display a coloured prompt if you haven't done this yet.

⚙️ Configuration

Key sections in plugins/HeliosAdmin/config.yml:

# Storage backend (inherits from HeliosCore by default)
storage:
  inherit-core: true

# Per-feature toggles
features:
  homes: true
  warps: true
  kits: true
  tpa: true
  backups: true

# Cooldowns & warm-ups (in seconds)
teleport:
  warmup: 3
  cooldown: 5
  cancel-on-move: true
  cancel-on-damage: true

# Dashboard role gating for actions
dashboard:
  permissions:
    actions:
      createBackup: ADMIN
      deleteBackup: OWNER
      restoreBackup: OWNER
      kickPlayer: STAFF
      banPlayer: ADMIN

# Punishment formatting (MiniMessage)
messages:
  prefix: "<gradient:#F4A623:#FFD580>[Helios]</gradient> <white>"
  ban-screen: "<red>You are banned: <white><reason>"

🔄 Run /hadmin reload to apply changes without restarting.

🚀 Quick-Start Examples

# ━━━━━━━━━━━ First boot ━━━━━━━━━━━
/hcore setup                                  # Initialise dashboard owner

# ━━━━━━━━━━━ Daily moderation ━━━━━━━━━━━
/ha ban Steve Griefing spawn
/ha tempban Steve 7d X-ray
/ha mute Alex 1h Spam in chat
/ha warn Alex Caps abuse
/ha history Alex
/ha freeze Steve
/ha invsee Alex

# ━━━━━━━━━━━ Player utilities ━━━━━━━━━━━
/sethome base
/home base
/warp shop
/tpa Alex
/kit starter

# ━━━━━━━━━━━ Server operations ━━━━━━━━━━━
/ha backup create world Pre-event
/ha backup list
/ha backup restore world_2026-05-08_14-30-00_Pre-event.zip
/ha audit 25
/ha reload

❓ FAQ

💬 Support