ZZZ-Plugin/apps/help.js

import { rulePrefix } from "../lib/common.js";
import { ZZZPlugin } from "../lib/plugin.js";
import settings from "../lib/settings.js";
import _ from "lodash";
/**
 * @typedef {Object} HelpItem
 * @property {string} title
 * @property {string} desc
 * @property {boolean} needCK
 * @property {boolean} needSK
 * @property {string[]} commands
 */
/**
 * @typedef {Object} HelpData
 * @property {string} title
 * @property {'fire'|'ice'|'physdmg'|'thunder'|'dungeon'} icon
 * @property {HelpItem[]} items
 */

/**
 * @type {HelpData[]}
 * @description 帮助数据
 */
const helpData = [
  {
    title: "信息查询",
    icon: "fire",
    items: [
      {
        title: "基本信息",
        desc: "查看玩家的角色和邦布列表",
        needCK: true,
        needSK: false,
        commands: ["card", "卡片", "个人信息"],
      },
      {
        title: "便签",
        desc: "查看体力、刮刮卡、营业、每日任务完成情况等信息",
        needCK: true,
        needSK: false,
        commands: ["note", "便签", "便笺", "体力", "每日"],
      },
      {
        title: "单月月报/菲林/邦布券/母带统计",
        desc: "查看单月菲林、邦布券、加密/原装母带的收入情况（查询结果也会写入数据库）。其中，参数可以为空（默认为本月），也可以为年份月份或者月份，例如：2024年9月、9月、上月",
        needCK: true,
        needSK: false,
        commands: [
          "monthly+[参数]",
          "菲林+[参数]",
          "邦布券+[参数]",
          "收入+[参数]",
          "月报+[参数]",
        ],
      },
      {
        title: "查看全部月报/菲林/邦布券/母带统计",
        desc: "查看菲林、邦布券、加密/原装母带的收入总情况（会查询全部可查询月份+已保存数据，新旧数据会进行合并）。",
        needCK: true,
        needSK: false,
        commands: [
          "monthly统计",
          "菲林统计",
          "邦布券统计",
          "收入统计",
          "月报统计",
        ],
      },
    ],
  },
  {
    title: "抽卡记录",
    icon: "ice",
    items: [
      {
        title: "刷新抽卡记录",
        desc: "刷新抽卡记录，如果数据过多，可能需要等待很长一段时间，请等待回复后再%查看抽卡记录",
        needCK: true,
        needSK: true,
        commands: ["刷新/更新抽卡", "刷新/更新抽卡链接", "刷新/更新抽卡记录"],
      },
      {
        title: "获取抽卡记录链接",
        desc: "获取抽卡记录链接，获取链接后可以用于小程序等第三方工具查看抽卡记录",
        needCK: true,
        needSK: true,
        commands: ["获取抽卡链接"],
      },
      {
        title: "查看抽卡记录",
        desc: "查看抽卡记录，需要手动%刷新抽卡记录，否则读取的是缓存数据",
        needCK: false,
        needSK: false,
        commands: ["抽卡分析", "抽卡记录", "抽卡统计"],
      },
    ],
  },
  {
    title: "角色面板",
    icon: "thunder",
    items: [
      {
        title: "刷新角色面板",
        desc: "刷新角色面板",
        needCK: true,
        needSK: false,
        commands: ["刷新面板", "更新面板", "面板刷新", "面板更新"],
      },
      {
        title: "查看角色面板列表",
        desc: "查看已保存的角色面板列表",
        needCK: false,
        needSK: false,
        commands: ["面板", "面板列表"],
      },
      {
        title: "查看角色面板",
        desc: "查看角色详细面板信息",
        needCK: false,
        needSK: false,
        commands: ["角色名+面板"],
      },
      {
        title: "查看角色面板图",
        desc: "查看自定义角色面板图，在添加或者删除角色图后，会导致角色图的ID发生变化，此时需要重新获取图片列表来查看ID，否则可能会删除错误的图片",
        needCK: false,
        needSK: false,
        commands: ["查看+角色名+面板图[+页码]", "查看+角色名+角色图[+页码]"],
      },
      {
        title: "获取角色面板图",
        desc: "获取自定义角色面板图原图片，可以用于下载图片，直接回复面板图片的消息并携带指令即可",
        needCK: false,
        needSK: false,
        commands: ["原图"],
      },
      {
        title: "练度统计",
        desc: "查看角色练度统计（如果更新需要先%刷新面板）",
        needCK: false,
        needSK: false,
        commands: ["练度", "练度统计"],
      },
    ],
  },
  {
    title: "战绩查询",
    icon: "dungeon",
    items: [
      {
        title: "查看式舆防卫战",
        desc: "查看式舆防卫战(深渊)信息",
        needCK: true,
        needSK: false,
        commands: ["式舆防卫战", "防卫战", "式舆", "深渊", "防卫"],
      },
      {
        title: "查看上期式舆防卫战",
        desc: "查看上期式舆防卫战(深渊)信息",
        needCK: true,
        needSK: false,
        commands: [
          "上期式舆防卫战",
          "上期防卫战",
          "上期式舆",
          "上期深渊",
          "上期防卫",
        ],
      },
      {
        title: "查看危局强袭战",
        desc: "查看式危局强袭战信息",
        needCK: true,
        needSK: false,
        commands: ["危局强袭战", "危局", "强袭", "强袭战"],
      },
      {
        title: "查看上期危局强袭战",
        desc: "查看上期危局强袭战信息",
        needCK: true,
        needSK: false,
        commands: ["上期式舆防卫战", "上期危局", "上期强袭", "上期强袭战"],
      },
    ],
  },
  {
    title: "角色攻略",
    icon: "physdmg",
    items: [
      {
        title: "查看角色攻略",
        desc: "查看角色攻略，后面可以加0~7查看不同来源的攻略，其中0或者all为攻略合集",
        needCK: false,
        needSK: false,
        commands: ["角色名+攻略[+0~7]"],
      },
      {
        title: "更新角色攻略",
        desc: "当需要更新某个角色的攻略，或者某个角色攻略出现错误对不上时，可以使用此命令更新攻略",
        needCK: false,
        needSK: false,
        commands: ["更新+角色名+攻略[+0~7]"],
      },
      {
        title: "角色天赋图鉴",
        desc: "查看角色天赋，默认等级为12级，核心技等级为F，你可以在指令后面加上自定义等级，以英文句号点分隔，顺序依次为：普通攻击、闪避、支援技、特殊技、连携技、核心技，其中除核心技等级为0和A～F表示外，其他等级为1～16的数字。例如：%猫又天赋6.12.11.10.9.F",
        needCK: false,
        needSK: false,
        commands: ["角色名+天赋[+等级]"],
      },
      {
        title: "角色意象影画图鉴",
        desc: "查看角色命座图鉴",
        needCK: false,
        needSK: false,
        commands: ["角色名+命座", "角色名+意象", "角色名+影画"],
      },
    ],
  },
  {
    title: "其他",
    icon: "fire",
    items: [
      {
        title: "兑换码",
        desc: "获取前瞻兑换码",
        needCK: false,
        needSK: false,
        commands: ["code", "兑换码"],
      },
      {
        title: "绑定设备",
        desc: "用于尝试解决10041报错等问题（无法100%解决），需要发送设备信息，具体方法请发送%绑定设备帮助查看",
        needCK: true,
        needSK: false,
        commands: ["绑定设备"],
      },
      {
        title: "绑定设备帮助",
        desc: "查看如何绑定设备",
        needCK: false,
        needSK: false,
        commands: ["绑定设备帮助"],
      },
      {
        title: "解绑设备",
        desc: "解除绑定设备",
        needCK: false,
        needSK: false,
        commands: ["解绑设备"],
      },
      {
        title: "更新日志",
        desc: "查看插件的Commit日志",
        needCK: false,
        needSK: false,
        commands: ["[插件]更新日志"],
      },
      {
        title: "版本",
        desc: "查看插件版本日志",
        needCK: false,
        needSK: false,
        commands: ["[插件]版本"],
      },
      {
        title: "检查更新",
        desc: "检查插件是否更新",
        needCK: false,
        needSK: false,
        commands: ["[插件]检查更新"],
      },
    ],
  },
];
export class Help extends ZZZPlugin {
  constructor() {
    super({
      name: "[ZZZ-Plugin]Help",
      dsc: "zzzhelp",
      event: "message",
      priority: _.get(settings.getConfig("priority"), "help", 70),
      rule: [
        {
          reg: `${rulePrefix}(帮助|help)$`,
          fnc: "help",
        },
      ],
    });
  }
  async help() {
    if (this.e?.isMaster) {
      const _helpData = [
        ...helpData,
        {
          title: "管理功能",
          icon: "dungeon",
          items: [
            {
              title: "更新",
              desc: "更新绝区零插件",
              needCK: false,
              needSK: false,
              commands: ["[插件][强制]更新"],
            },
            {
              title: "下载资源",
              desc: "提前下载插件所需资源，查询时无需再次下载",
              needCK: false,
              needSK: false,
              commands: ["下载全部/所有资源"],
            },
            {
              title: "删除资源（需注意）",
              desc: "删除已经下载的资源，查询时需要再次下载（用于删除错误下载缓存）。",
              needCK: false,
              needSK: false,
              commands: ["删除全部/所有资源"],
            },
            {
              title: "设置默认攻略",
              desc: "设置查询的默认攻略来源，数字0~7对应不同的攻略来源，其中0或者all为攻略合集",
              needCK: false,
              needSK: false,
              commands: ["设置默认攻略+0~7"],
            },
            {
              title: "设置所有攻略显示个数",
              desc: "当查询攻略为0或者all时，设置发送的攻略个数，最大为7",
              needCK: false,
              needSK: false,
              commands: ["设置所有攻略显示个数+1~7"],
            },
            {
              title: "设置渲染精度",
              desc: "设置插件的渲染精度，可选值50~200，建议100",
              needCK: false,
              needSK: false,
              commands: ["设置渲染精度+50~200"],
            },
            {
              title: "刷新抽卡间隔",
              desc: "设置刷新抽卡记录的冷却时间，单位为秒，取值范围为0～1000",
              needCK: false,
              needSK: false,
              commands: ["刷新抽卡间隔+0~1000"],
            },
            {
              title: "刷新面板间隔",
              desc: "设置刷新面板的冷却时间，单位为秒，取值范围为0～1000",
              needCK: false,
              needSK: false,
              commands: ["刷新面板间隔+0~1000"],
            },
            {
              title: "添加角色别名",
              desc: "添加角色别名，方便查询角色信息",
              needCK: false,
              needSK: false,
              commands: ["添加+角色名+别名+角色别名"],
            },
            {
              title: "删除角色别名",
              desc: "删除角色别名",
              needCK: false,
              needSK: false,
              commands: ["删除别名+角色别名"],
            },
            {
              title: "上传角色面板图",
              desc: "上传自定义角色面板图，可以随消息附带图片，可以通过引用消息中的图片上传",
              needCK: false,
              needSK: false,
              commands: [
                "上传+角色名+面板图",
                "上传+角色名+角色图",
                "添加+角色名+面板图",
                "添加+角色名+角色图",
              ],
            },
            {
              title: "删除角色面板图",
              desc: "删除自定义角色面板图，在添加或者删除角色图后，会导致角色图的ID发生变化，此时需要重新获取图片列表来查看ID，否则可能会删除错误的图片",
              needCK: false,
              needSK: false,
              commands: ["删除+角色名+面板图", "删除+角色名+角色图"],
            },
            {
              title: "设置默认设备",
              desc: "设置默认设备信息，当用户没有绑定设备时，会使用默认设备信息",
              needCK: false,
              needSK: false,
              commands: ["设置默认设备"],
            },
            {
              title: "开启/关闭更新推送",
              desc: "开启/关闭更新推送，更新仅推送给第一个主人",
              needCK: false,
              needSK: false,
              commands: ["开启/关闭更新推送"],
            },
            {
              title: "设置检查自动更新时间",
              desc: "设置检查自动更新时间，cron表达式，如0 0/10 * * * ?",
              needCK: false,
              needSK: false,
              commands: ["设置检查更新时间+cron表达式"],
            },
          ],
        },
      ];
      await this.render("help/index.html", {
        helpData: _helpData,
      });
      return false;
    }
    await this.render("help/index.html", {
      helpData,
    });
    return false;
  }
}