diff --git a/README.md b/README.md index e1a29b0..9964d53 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,47 @@ -# JX3 +# 剑网三数据查询工具 -AstrBot 插件模板 +
-A template plugin for AstrBot plugin feature +![Python Version](https://img.shields.io/badge/Python-3.10.14%2B-blue) -# 支持 +
-[帮助文档](https://astrbot.app) +## 目录 + +- [剑网三数据查询工具](#-剑网三数据查询工具) + - [目录](#-目录) + - [简介](#-简介) + - [更新记录](#-更新记录) + - [功能特点](#-功能特点) + - [插件配置](#-插件配置) + +## 简介 + +仿照剑网三主流的机器人写了个插件,主要是自用。 + +插件功能绝大部分都是用AI写的,又进行了调试。 + +目前此插件能够完成绝大部分的功能查询,其他功能有空再说。 + +此插件的所有数据几乎全部依赖jx3api提供的API接口,所以进阶功能需要向其购买token才可使用。 +部分进阶功能除了购买token以外还需要自己去抓包推栏app,获得推栏token才可使用。 + +## 更新记录 + +version: 1.0.0:大部分重要功能已经实现 + +## 功能特点 + +- **后台循环请求**:通过后台一个任务循环请求接口,记录判断。推送最新消息状态 +- **处理接口数据**:将接口返回的数据处理成,玩家能读懂的消息发送 +- **HTML渲染图片**:利用astrbot里面的文转图服务,处理HTML页面渲染成图片 + +## 插件配置 + +要想正常使用插件,需要正常配置token和推栏标识。 + +下面两个推送功能可以手动开启或者关闭,配置询问的周期时间,以及消息要推送的对象,推送ID可在聊天中使用/std查看。 + +## 使用方式 + +在聊天中输入 **/剑三 帮助** 即可获取插件所有的功能使用说明。 \ No newline at end of file