☀️ HeliosCore
服务注册中心 • 统一存储 • 实时 Web 仪表板 • 许可证验证 • 共享 API
? 目录
✨ 为什么选择 HeliosCore?
所有 Helios 插件(HeliosAdmin、HeliosEconomy、HeliosChat、HeliosTab、NinezJobs、NinezSkills、NinezMarket、NinezGUI、NinezLogs 等)都必须依赖 HeliosCore。
与其让每个插件重复实现存储、权限、消息传递和仪表板功能,不如由 HeliosCore 一次性提供这些基础服务——从而使整个套件共享同一个事实来源(Single Source of Truth)。
| ? 服务注册中心 |
? 统一存储 |
? 权限服务 (PermissionService) |
| 简洁的跨插件 API |
Yaml / SQLite / MySQL / MariaDB |
运行时注册并附带描述信息 |
CoreServices.require(...) |
所有 Helios 插件共享使用 |
完美兼容 LuckPerms / GroupManager |
| ? 审计服务 (AuditService) |
? Web 仪表板 |
? 许可证 (开发中) |
| 只追加模式的审计日志 |
支持 HTTP + SSE 托管及令牌认证 |
单一许可证检查即可控制整个套件 |
| 被所有插件调用 |
可扩展的贡献者模块 |
离线宽容模式下软性失败 |
? 许可证功能仍在开发中。 许可证服务器、密钥发放以及运行时验证流程仍在完善中。目前 HeliosCore 处于永久离线宽容模式——您可以正常安装和使用该套件;许可证层将在未来的版本中自动激活。
✅ 原生支持 Adventure / MiniMessage • PlaceholderAPI 桥接 • Vault 适配器 • bStats 指标统计
? 需求
| 需求项 |
版本 |
| Minecraft |
1.21.x • 26.1.x (原生支持且已测试) |
| 服务端 |
Paper / Purpur (未官方支持 Spigot) |
| Java |
21+ |
| 软依赖 |
Vault • PlaceholderAPI • LuckPerms (均为可选) |
? HeliosCore 会自动优先于所有其他 Helios 插件加载(通过 loadbefore 指令实现)。
? 安装
1. 将 HeliosCore-x.y.z.jar 放入 → plugins/ 文件夹
2. 启动服务器(配置文件和数据文件夹将自动生成)
3. 运行 /hcore setup(生成一次性的仪表板管理员链接 — 必需步骤)
4. 在浏览器中打开控制台打印出的链接 → 设置用户名和密码
5. (可选)编辑 plugins/HeliosCore/config.yml 以配置存储、仪表板和许可证
6. 运行 /hcore reload
7. 安装其他 Helios 插件 — 它们将自动向 HeliosCore 注册
⚠️ 必须执行 /hcore setup。 在您运行该命令并完成管理员设置之前,仪表板将拒绝登录。
? 命令
别名: /hcore • /helioscore • /ncore • /ninezcore
| 命令 |
描述 |
权限 |
/hcore |
显示插件状态及已加载的服务 |
— |
/hcore about |
框架信息及版本号 |
helioscore.command.about |
/hcore reload |
重新加载框架配置及数据库设置 |
helioscore.command.reload |
/hcore services |
列出已加载的服务及其所属插件 |
helioscore.command.services |
/hcore database |
检查/测试配置的数据库后端 |
helioscore.command.database |
/hcore dashboard |
查看仪表板状态及访问 URL |
helioscore.command.dashboard |
/hcore doctor |
对整个生态系统运行诊断健康检查 |
helioscore.command.doctor |
/hcore update |
检查并应用生态系统的插件更新 |
helioscore.command.update |
/hcore setup |
为仪表板管理员生成一次性设置链接 |
helioscore.command.setup |
/hcore register |
为工作人员用户生成一次性注册链接 |
helioscore.command.register |
? 权限
HeliosCore 使用清晰的分层权限树,可直接集成到 LuckPerms、GroupManager、PermissionsEx 或原版 op 中。
? 层级结构
helioscore.admin (默认: op) ━ 授予所有权限
└── helioscore.command.all ━ 包含其下所有子节点
├── helioscore.command.about
├── helioscore.command.reload
├── helioscore.command.services
├── helioscore.command.database
├── helioscore.command.dashboard
├── helioscore.command.doctor
├── helioscore.command.update
├── helioscore.command.setup
└── helioscore.command.register
所有节点对非 op 玩家默认设为 false。授予 helioscore.admin 可获得完全访问权限,或为工作人员角色分配各个独立的子节点。
? 推荐的 LuckPerms 设置
? 点击展开 LuckPerms 命令示例
# ────────────── 所有者 — 完全控制权 ──────────────
/lp group owner permission set helioscore.admin true
# ────────────── 管理员 — 除设置/注册外的所有权限 ──────────────
/lp group admin permission set helioscore.command.all true
/lp group admin permission set helioscore.command.setup false
/lp group admin permission set helioscore.command.register false
# ────────────── 高级员工 — 只读诊断 ──────────────
/lp group senior permission set helioscore.command.about true
/lp group senior permission set helioscore.command.services true
/lp group senior permission set helioscore.command.dashboard true
/lp group senior permission set helioscore.command.doctor true
? Web 仪表盘
HeliosCore 内置了 HTTP + SSE 服务器。每个 Helios 插件均可通过 DashboardContributor API 挂载自己的页面、操作和实时数据流。
? 开箱即用功能…
- ? 服务器实时状态 — TPS、MSPT、内存使用量、运行时间、在线玩家数
- ? 审计日志流 — 跨所有插件的员工操作,实时同步
- ? 插件卡片 — 每个 Helios 插件一个卡片,显示其服务健康状况
- ? 备份控制 (通过 HeliosAdmin) — 创建、列出、删除、还原世界备份
- ? 角色访问控制 —
OWNER / ADMIN / STAFF 的操作在服务端进行校验
- ? 令牌认证 — 随时可通过
/hcore dashboard 轮换令牌
? 首次运行流程
1. /hcore setup → 控制台打印一次性链接
2. 在浏览器中打开链接 → 为 OWNER 设置用户名和密码
3. 登录 → 进入“设置”→“用户”以邀请员工
(或使用 /hcore register)
⚙️ 配置
plugins/HeliosCore/config.yml 中的关键部分:
# 存储后端 — 所有 Helios 插件共享
storage:
type: sqlite # yaml | sqlite | mysql | mariadb
mysql:
host: localhost
port: 3306
database: helios
username: helios
password: changeme
pool-size: 10
# Web 仪表盘
dashboard:
enabled: true
host: 0.0.0.0
port: 8765
public-url: "https://panel.example.com"
tls:
enabled: false
cert: ""
key: ""
# 授权许可 — 开发进行中
# 许可证服务器和密钥发放流程仍在构建中。
# 这些设置会被读取,但当前无实际作用;HeliosCore 将在离线宽限模式下运行。
license:
key: "PASTE-YOUR-LICENSE-HERE"
server-url: "https://license.helios.dev"
grace-period-hours: 72
# 审计日志
audit:
retention-days: 30
console-mirror: false
# 调试日志
debug:
enabled: false
verbose-services: false
? 运行 /hcore reload 即可应用更改,无需重启。
? 开发者 API
HeliosCore 通过一个简洁稳定的查找接口暴露各项服务:
import dev.ninez.core.api.CoreServices;
import dev.ninez.core.api.permission.PermissionService;
import dev.ninez.core.api.storage.StorageService;
import dev.ninez.core.api.message.MessageService;
import dev.ninez.core.api.audit.AuditService;
@Override
public void onEnable() {
PermissionService perms = CoreServices.require(this, PermissionService.class);
StorageService storage = CoreServices.require(this, StorageService.class);
MessageService msg = CoreServices.require(this, MessageService.class);
AuditService audit = CoreServices.require(this, AuditService.class);
perms.registerPermissions(MyPermissions.defaults());
audit.log(this, "Enabled MyPlugin");
}
在你的 plugin.yml 中将 HeliosCore 添加为硬依赖 (depend):
depend:
- HeliosCore
? 快速入门示例
# ━━━━━━━━━━━ 首次启动 ━━━━━━━━━━━
/hcore setup # 生成所有者设置链接(必需)
/hcore dashboard # 打印仪表盘 URL 及状态
# ━━━━━━━━━━━ 日常操作 ━━━━━━━━━━━
/hcore # 状态概览
/hcore services # 哪些插件注册了哪些服务
/hcore doctor # 诊断健康检查
/hcore database # 测试存储后端连接性
/hcore reload # 热重载配置
# ━━━━━━━━━━━ 维护操作 ━━━━━━━━━━━
/hcore update # 检查生态更新
/hcore register # 邀请新的仪表盘员工用户
❓ 常见问题
我必须使用 HeliosCore 吗?
如果你正在使用 任何 Helios 插件,是的。它是基础组件——没有它其他插件将无法启用。
我应该使用哪种数据库?
| 使用场景 |
推荐方案 |
| 单服务器,中小型玩家群体 |
sqlite (默认,零配置) |
| 多服务器 / 网络 / 大型玩家群体 |
mysql 或 mariadb (共享) |
| 小型测试服务器 |
yaml (人类可读,无需驱动) |
将仪表盘暴露在公网上安全吗?
安全——支持令牌认证、角色访问控制以及 TLS。在生产环境中,建议将其置于反向代理(nginx / Caddy)后方以启用 HTTPS。
授权许可是如何工作的?
? 状态:开发进行中。 Helios 许可证服务器和密钥发放流程仍在积极开发中。目前 HeliosCore 会读取 config.yml 中的 license: 区块,但始终运行在 离线宽限模式 下,因此在许可流程完成前,套件可完全正常使用。
正式发布后:将你的购买密钥粘贴到 config.yml 中。HeliosCore 会定期与 Helios 许可证服务器进行验证。如果许可证服务器不可达,插件将在配置的宽限期内继续以离线模式工作。
HeliosCore 会与 Vault / LuckPerms / PlaceholderAPI 冲突吗?
不会——它们是 软依赖。HeliosCore 会自动检测并与它们集成。
我可以编写自己的仪表盘页面吗?
是的——实现 DashboardContributor 并进行注册。你的插件将获得一个图块(tile)、页面以及 SSE/动作端点。请参阅开发者文档。
? 支持
| 渠道 |
链接 |
| ? Discord |
| ? 问题追踪器 |
使用此资源页面上的 Discussion 标签 |
| ? 文档 |
随附的 README.md 和开发者指南 |
☀️ HeliosCore
一个基础。一个许可证。一个仪表盘。
整个 Helios 生态系统。
☀️ HeliosCore
Service Registry • Unified Storage • Live Web Dashboard • License Validation • Shared API
? Table of Contents
✨ Why HeliosCore?
HeliosCore is required by every Helios plugin (HeliosAdmin, HeliosEconomy, HeliosChat, HeliosTab, NinezJobs, NinezSkills, NinezMarket, NinezGUI, NinezLogs, …).
Instead of every plugin re-implementing storage, permissions, messaging, and dashboards, HeliosCore provides them once — so your whole suite shares a single source of truth.
| ? Service Registry |
? Unified Storage |
? PermissionService |
| Clean cross-plugin APIs |
Yaml / SQLite / MySQL / MariaDB |
Runtime registration with descriptions |
CoreServices.require(...) |
Shared by every Helios plugin |
LuckPerms / GroupManager friendly |
| ? AuditService |
? Web Dashboard |
? Licensing (WIP) |
| Append-only audit log |
HTTP + SSE host with token auth |
One license check gates the suite |
| Used by every plugin |
Pluggable contributors |
Soft-fails in offline grace mode |
? Licensing is a work in progress. The License Server, key issuance, and runtime validation pipeline are still being finalized. HeliosCore currently runs in permanent offline grace mode — install and use the suite normally; the licensing layer will activate transparently in a future release.
✅ Adventure / MiniMessage native • PlaceholderAPI bridge • Vault adapter • bStats metrics
? Requirements
| Requirement |
Version |
| Minecraft |
1.21.x • 26.1.x (native & tested) |
| Server |
Paper / Purpur (Spigot not officially supported) |
| Java |
21+ |
| Soft-depends |
Vault • PlaceholderAPI • LuckPerms (all optional) |
? HeliosCore loads before all Helios plugins automatically (loadbefore directive).
? Installation
1. Drop HeliosCore-x.y.z.jar → plugins/
2. Start the server (config & data folder auto-generate)
3. Run /hcore setup (creates one-time dashboard owner link — REQUIRED)
4. Open the link printed in console → set username + password in your browser
5. (Optional) Edit plugins/HeliosCore/config.yml for storage, dashboard, license
6. Run /hcore reload
7. Install other Helios plugins — they register into HeliosCore automatically
⚠️ /hcore setup is required. Until you run it and complete owner setup, the dashboard refuses logins.
? Commands
Aliases: /hcore • /helioscore • /ncore • /ninezcore
| Command |
Description |
Permission |
/hcore |
Show plugin status & loaded services |
— |
/hcore about |
Framework information & version |
helioscore.command.about |
/hcore reload |
Reload framework configs and database settings |
helioscore.command.reload |
/hcore services |
List loaded services and their owning plugins |
helioscore.command.services |
/hcore database |
Inspect / test the configured database backend |
helioscore.command.database |
/hcore dashboard |
View dashboard status and access URL |
helioscore.command.dashboard |
/hcore doctor |
Run diagnostic health checks on the entire ecosystem |
helioscore.command.doctor |
/hcore update |
Check & apply ecosystem plugin updates |
helioscore.command.update |
/hcore setup |
Generate a one-time setup link for the dashboard owner |
helioscore.command.setup |
/hcore register |
Generate a one-time registration link for staff users |
helioscore.command.register |
? Permissions
HeliosCore uses a clean, hierarchical permission tree that drops straight into LuckPerms, GroupManager, PermissionsEx, or vanilla op.
? Hierarchy
helioscore.admin (default: op) ━ grants EVERYTHING
└── helioscore.command.all ━ all leaf nodes below
├── helioscore.command.about
├── helioscore.command.reload
├── helioscore.command.services
├── helioscore.command.database
├── helioscore.command.dashboard
├── helioscore.command.doctor
├── helioscore.command.update
├── helioscore.command.setup
└── helioscore.command.register
All nodes default to false for non-ops. Grant helioscore.admin for full access, or assign individual leaf nodes to staff roles.
? Suggested LuckPerms Setup
? Click to expand example LuckPerms commands
# ────────────── Owner — full control ──────────────
/lp group owner permission set helioscore.admin true
# ────────────── Admin — everything except setup/register ──────────────
/lp group admin permission set helioscore.command.all true
/lp group admin permission set helioscore.command.setup false
/lp group admin permission set helioscore.command.register false
# ────────────── Senior Staff — read-only diagnostics ──────────────
/lp group senior permission set helioscore.command.about true
/lp group senior permission set helioscore.command.services true
/lp group senior permission set helioscore.command.dashboard true
/lp group senior permission set helioscore.command.doctor true
? Web Dashboard
HeliosCore ships with a built-in HTTP + SSE server. Every Helios plugin can mount its own page, actions, and live data feeds via the DashboardContributor API.
? Out of the box you get…
- ? Live server status — TPS, MSPT, memory, uptime, online players
- ? Audit log stream — every staff action across every plugin, in real time
- ? Plugin tiles — one tile per Helios plugin showing its service health
- ? Backup controls (via HeliosAdmin) — create, list, delete, restore world backups
- ? Role gating —
OWNER / ADMIN / STAFF actions checked server-side
- ? Token authentication — rotate any time with
/hcore dashboard
? First-Run Flow
1. /hcore setup → console prints a one-time link
2. Open link in browser → set username & password for OWNER
3. Log in → Settings → Users to invite staff
(or use /hcore register)
⚙️ Configuration
Key sections in plugins/HeliosCore/config.yml:
# Storage backend — shared by every Helios plugin
storage:
type: sqlite # yaml | sqlite | mysql | mariadb
mysql:
host: localhost
port: 3306
database: helios
username: helios
password: changeme
pool-size: 10
# Web dashboard
dashboard:
enabled: true
host: 0.0.0.0
port: 8765
public-url: "https://panel.example.com"
tls:
enabled: false
cert: ""
key: ""
# Licensing — work in progress
# The license server and key issuance flow are still being built.
# These settings are read but currently no-op; HeliosCore runs in offline grace mode.
license:
key: "PASTE-YOUR-LICENSE-HERE"
server-url: "https://license.helios.dev"
grace-period-hours: 72
# Audit log
audit:
retention-days: 30
console-mirror: false
# Debug logging
debug:
enabled: false
verbose-services: false
? Run /hcore reload to apply changes without restarting.
? Developer API
HeliosCore exposes services through a tiny, stable lookup:
import dev.ninez.core.api.CoreServices;
import dev.ninez.core.api.permission.PermissionService;
import dev.ninez.core.api.storage.StorageService;
import dev.ninez.core.api.message.MessageService;
import dev.ninez.core.api.audit.AuditService;
@Override
public void onEnable() {
PermissionService perms = CoreServices.require(this, PermissionService.class);
StorageService storage = CoreServices.require(this, StorageService.class);
MessageService msg = CoreServices.require(this, MessageService.class);
AuditService audit = CoreServices.require(this, AuditService.class);
perms.registerPermissions(MyPermissions.defaults());
audit.log(this, "Enabled MyPlugin");
}
Add HeliosCore as a hard depend in your plugin.yml:
depend:
- HeliosCore
? Quick-Start Examples
# ━━━━━━━━━━━ First boot ━━━━━━━━━━━
/hcore setup # Generate owner setup link (REQUIRED)
/hcore dashboard # Print dashboard URL & status
# ━━━━━━━━━━━ Day-to-day ━━━━━━━━━━━
/hcore # Status overview
/hcore services # Which plugins registered which services
/hcore doctor # Diagnostic health checks
/hcore database # Test storage backend connectivity
/hcore reload # Hot reload config
# ━━━━━━━━━━━ Maintenance ━━━━━━━━━━━
/hcore update # Check for ecosystem updates
/hcore register # Invite a new dashboard staff user
❓ FAQ
Do I have to use HeliosCore?
If you're using any Helios plugin, yes. It's the foundation — they won't enable without it.
What database should I use?
| Use Case |
Recommended |
| Single server, small/medium playerbase |
sqlite (default, zero-config) |
| Multi-server / network / large playerbase |
mysql or mariadb (shared) |
| Tiny test servers |
yaml (human-readable, no driver) |
Is the dashboard safe to expose to the internet?
Yes — token authentication, role-gated actions, and TLS support. Put it behind a reverse proxy (nginx / Caddy) for HTTPS in production.
How does licensing work?
? Status: work in progress. The Helios License Server and key issuance flow are still under active development. Today HeliosCore reads the license: block in config.yml but always runs in offline grace mode, so the suite is fully usable while the licensing pipeline is finished.
Once shipped: paste your purchase key into config.yml. HeliosCore validates with the Helios License Server periodically. If the license server is unreachable, the plugin keeps working in offline grace mode for the configured period.
Will HeliosCore conflict with Vault / LuckPerms / PlaceholderAPI?
No — those are soft-depends. HeliosCore detects and integrates with them automatically.
Can I write my own dashboard page?
Yes — implement DashboardContributor and register it. Your plugin gets a tile, a page, and SSE/action endpoints. See the developer documentation.
? Support
| Channel |
Link |
| ? Discord |
| ? Issue Tracker |
Use the Discussion tab on this resource |
| ? Documentation |
Bundled README.md and developer guide |
☀️ HeliosCore
One foundation. One license. One dashboard.
The whole Helios ecosystem.
评论 0
登录后参与评分
还没有评论,来抢沙发吧