Helios Core

插件

· 作者 Helios-Nine

HeliosCore 是整个 Helios 生态系统的基础插件,为存储、权限管理、消息传递、许可证验证、玩家资料以及所有 Helios 插件共用的实时 Web 仪表盘提供共享服务。

0 本站下载 0 关注 更新于 6 个月前

最新 1.0.0 · 26.1.2 · Bukkit / BungeeCord

一键开服(送7天)

☀️ 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 生态系统。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源