Metadata-Version: 2.3
Name: nonebot-plugin-ba-gamekee
Version: 0.2.0
Summary: 蔚蓝档案 GameKee Wiki 攻略查询
Author: Misty02600
Author-email: Misty02600 <xiao02600@gmail.com>
Requires-Dist: httpx>=0.27.0,<1.0.0
Requires-Dist: nonebot-plugin-alconna>=0.60.0,<1.0.0
Requires-Dist: nonebot-plugin-apscheduler>=0.5.0,<1.0.0
Requires-Dist: nonebot-plugin-localstore>=0.7.4,<1.0.0
Requires-Dist: nonebot-plugin-uninfo>=0.10.0,<1.0.0
Requires-Dist: nonebot2>=2.4.2,<3.0.0
Requires-Dist: playwright>=1.58.0,<2.0.0
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/Misty02600/nonebot-plugin-ba-gamekee
Project-URL: Issues, https://github.com/Misty02600/nonebot-plugin-ba-gamekee/issues
Project-URL: Repository, https://github.com/Misty02600/nonebot-plugin-ba-gamekee.git
Description-Content-Type: text/markdown

<div align="center">
    <a href="https://v2.nonebot.dev/store">
    <img src="https://github.com/Misty02600/nonebot-plugin-template/releases/download/assets/NoneBotPlugin.png" width="310" alt="logo"></a>

## ✨ nonebot-plugin-ba-gamekee ✨
[![LICENSE](https://img.shields.io/github/license/Misty02600/nonebot-plugin-ba-gamekee.svg)](./LICENSE)
[![python](https://img.shields.io/badge/python-3.11+-blue.svg?logo=python&logoColor=white)](https://www.python.org)
[![Adapters](https://img.shields.io/badge/Adapters-OneBot%20v11-blue)](#supported-adapters)
<br/>

[![uv](https://img.shields.io/badge/package%20manager-uv-black?logo=uv)](https://github.com/astral-sh/uv)
[![ruff](https://img.shields.io/badge/code%20style-ruff-black?logo=ruff)](https://github.com/astral-sh/ruff)

</div>

## 📖 介绍

`nonebot-plugin-ba-gamekee` 是面向 Blue Archive / 蔚蓝档案的 GameKee Wiki 攻略查询插件。

当前已支持查询三服当前活动攻略与卡池评测入口，并会在后台同步 GameKee 首页入口缓存，减少实时请求压力。

## 💿 安装

<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-ba-gamekee --upgrade
使用 **pypi** 源安装

    nb plugin install nonebot-plugin-ba-gamekee --upgrade -i "https://pypi.org/simple"
使用**清华源**安装

    nb plugin install nonebot-plugin-ba-gamekee --upgrade -i "https://pypi.tuna.tsinghua.edu.cn/simple"


</details>

<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details open>
<summary>uv</summary>

    uv add nonebot-plugin-ba-gamekee
安装仓库 main 分支

    uv add git+https://github.com/Misty02600/nonebot-plugin-ba-gamekee@main
</details>

<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-ba-gamekee
安装仓库 main 分支

    pdm add git+https://github.com/Misty02600/nonebot-plugin-ba-gamekee@main
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-ba-gamekee
安装仓库 main 分支

    poetry add git+https://github.com/Misty02600/nonebot-plugin-ba-gamekee@main
</details>

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入

    plugins = ["nonebot_plugin_ba_gamekee"]

</details>

<details>
<summary>使用 nbr 安装(使用 uv 管理依赖可用)</summary>

[nbr](https://github.com/fllesser/nbr) 是一个基于 uv 的 nb-cli，可以方便地管理 nonebot2

    nbr plugin install nonebot-plugin-ba-gamekee
使用 **pypi** 源安装

    nbr plugin install nonebot-plugin-ba-gamekee -i "https://pypi.org/simple"
使用**清华源**安装

    nbr plugin install nonebot-plugin-ba-gamekee -i "https://pypi.tuna.tsinghua.edu.cn/simple"

</details>


## ⚙️ 配置

插件使用 [nonebot_plugin_localstore](https://github.com/nonebot/plugin-localstore) 储存数据和缓存，并使用 apscheduler 定时刷新 GameKee 首页入口。

可在 nonebot2 项目的 `.env` 文件中按需覆盖下表配置。

| 配置项  | 必填  | 默认值 |   说明   |
| :-----: | :---: | :----: | :------: |
| `ba_gamekee_refresh_interval_minutes` |  否   | `10` | 后台刷新当前攻略入口缓存的间隔，单位为分钟 |

## 🎉 使用
### 指令表
| 指令  | 权限  | 需要@ | 范围  |   说明   |
| :---: | :---: | :---: | :---: | :------: |
| `/ba活动 日服` | 群员 | 否 | 私聊/群聊 | 查询当前日服活动攻略 |
| `/ba活动 国际服` | 群员 | 否 | 私聊/群聊 | 查询当前国际服活动攻略 |
| `/ba活动 国服` | 群员 | 否 | 私聊/群聊 | 查询当前国服活动攻略 |
| `/ba卡池 日服` | 群员 | 否 | 私聊/群聊 | 查询当前日服卡池评测 |
| `/ba卡池 国际服` | 群员 | 否 | 私聊/群聊 | 查询当前国际服卡池评测 |
| `/ba卡池 国服` | 群员 | 否 | 私聊/群聊 | 查询当前国服卡池评测 |

`ba` 与子命令之间可以加空格，例如 `/ba 活动 国际服`、`/ba 卡池 国服`。子命令与服务器参数之间需要分隔。

### 🎨 效果图
如果有效果图的话
