安装指南

安装插件

  1. 访问 GitHub Releases 页面
  2. 下载最新版本的 JAR 文件(如 halo-plugin-steam-0.3.0.jar
  3. 登录 Halo 后台
  4. 进入「插件」页面
  5. 点击「安装插件」按钮
  6. 选择下载的 JAR 文件并上传
  7. 安装完成后,点击「启用」按钮

环境要求

项目 要求
Halo 版本 >= 2.22.1
Java 版本 JDK 21

安装后准备

插件安装完成后,需要进行以下配置才能正常使用:

  1. 获取 Steam API Key - 访问 Steam 开发者页面 注册
  2. 获取 Steam ID - 17 位数字格式,可通过 SteamID.io 查询
  3. 设置 Steam 隐私 - 确保个人资料和游戏详情为公开状态

详细配置说明请参考 配置说明

验证安装

安装成功后:

  1. 进入「插件」→「Steam 信息展示」→「设置」
  2. 填写 Steam API Key 和 Steam ID
  3. 点击「验证配置」按钮
  4. 如果验证通过,说明安装和配置正确

访问 Steam 页面

配置完成后,访问 /steam 即可查看 Steam 信息页面。

升级插件

  1. GitHub Releases 下载新版本
  2. 在 Halo 后台「插件」页面,找到 Steam 插件
  3. 点击「升级」按钮,上传新版本的 JAR 文件
  4. 升级完成后,插件会自动重启

⚠️ 升级前建议备份重要数据。插件升级不会影响已有配置和数据。

卸载插件

  1. 在 Halo 后台「插件」页面,找到 Steam 插件
  2. 点击「卸载」按钮
  3. 确认卸载

⚠️ 卸载插件会删除所有相关数据,包括热力图记录。如果可能重新安装,建议只禁用而不卸载。