通过森空岛查询游戏数据
Project description
📖 介绍
通过森空岛查询游戏数据
[!NOTE] 本插件存在大量未经验证的数据结构
以及 💩 山如在使用过程中遇到问题,欢迎提 issue 帮助改进项目
Star History
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-skland
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pip
pip install nonebot-plugin-skland
pdm
pdm add nonebot-plugin-skland
uv
uv add nonebot-plugin-skland
poetry
poetry add nonebot-plugin-skland
conda
conda install nonebot-plugin-skland
打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入
plugins = ["nonebot_plugin_skland"]
⚙️ 配置
配置表
在 nonebot2 项目的.env文件中修改配置项
| 配置项 | 必填 | 默认值 | 说明 |
|---|---|---|---|
skland__github_proxy_url |
否 | "" |
GitHub 代理 URL |
skland__github_token |
否 | "" |
GitHub Token |
skland__check_res_update |
否 | False |
是否在启动时检查资源更新 |
skland__background_source |
否 | "default" |
背景图片来源 |
skland__rogue_background_source |
否 | "rogue" |
肉鸽战绩背景图片来源 |
skland__argot_expire |
否 | 300 |
暗语消息过期时间(秒) |
[!TIP] 以上配置项均
没什么用按需填写,GitHub Token 用于解决 fetch_file_list 接口到达免费调用上限,但不会有那么频繁的更新频率,99.98%的概率是用不上的。只是因为我开发测试的时候上限了,所以有了这项,本插件所使用的
干员半身像、技能图标等资源,均优先调用本地,不存在则从网络请求获取,所以本地资源更新非必要选项,按需填写,不想过多请求网络资源可以自动或指令手动更新下载本地资源。
background_source
skland__background_source 为背景图来源,可选值为字面量 default / Lolicon / random 或者结构 CustomSource 。 Lolicon 为网络请求获取随机带arknightstag 的背景图,random为从默认背景目录中随机, CustomSource 用于自定义背景图。 默认为 default。
rogue_background_source 为肉鸽战绩背景图来源,可选值为字面量 default / Lolicon / rogue 或者结构 CustomSource 。 rogue为根据肉鸽主题提供的一套默认背景图。
以下是 CustomSource 用法示例
在配置文件中设置 skland__background_source 为 CustomSource结构的字典
CustomSource配置示例
-
网络链接
uri可为网络图片 API,只要返回的是图片即可uri也可以为 base64 编码的图片,如data:image/png;base64,xxxxxx(一般也没人这么干)
skland__background_source = '{"uri": "https://example.com/image.jpg"}'
- 本地图片
uri也可以为本地图片路径,如imgs/image.jpg、/path/to/image.jpg- 如果本地图片路径是相对路径,会使用
nonebot-plugin-localstore指定的 data 目录作为根目录- 如果本地图片路径是目录,会随机选择目录下的一张图片作为背景图
skland__background_source = '{"uri": "/imgs/image.jpg"}'
🎉 使用
[!NOTE] 记得使用命令前缀哦
🪧 指令表
| 指令 | 权限 | 参数 | 说明 |
|---|---|---|---|
skland |
所有 | 无 or @ |
角色信息卡片 |
skland bind |
所有 | token or cred |
绑定森空岛账号 |
skland bind -u |
所有 | token or cred |
更新绑定的 token 或 cred |
skland qrcode |
所有 | 无 | 扫码绑定森空岛账号 |
skland arksign sign |
所有 | 无 | 个人角色明日方舟签到 |
skland arksign sign -u <uid> |
所有 | uid |
指定绑定的个人角色 UID 进行签到 |
skland arksign all |
超级用户 | 无 | 签到所有绑定到该 bot 的角色 |
skland arksign status |
所有 | 无 | 查询个人角色自动签到状态 |
skland arksign status --all |
超级用户 | 无 | 查询所有绑定到该 bot 的角色的签到状态 |
skland arksign sign --all |
所有 | 无 | 签到所有绑定角色 |
skland char update |
所有 | 无 | 更新森空岛绑定角色信息 |
skland sync |
超级用户 | 无 | 本地资源更新 |
skland rogue |
所有 | @ | topic |
肉鸽战绩查询 |
skland rginfo |
所有 | 战绩id |
根据 ID 查询最近战绩详情 |
skland rginfo -f |
所有 | 战绩id |
根据 ID 查询森空岛收藏的战绩详情 |
[!NOTE] Token 获取相关文档还没写
才不是懒得写可以参考
token获取获取本插件支持 cred 和 token 两种方式手动绑定,使用二维码绑定时会提供 token,请勿将 token 提供给不信任的 Bot 所有者
🎯 快捷指令
| 触发词 | 执行指令 |
|---|---|
| 森空岛绑定 | skland bind |
| 扫码绑定 | skland qrcode |
| 明日方舟签到 | skland arksign sign --all |
| 签到详情 | skland arksign status |
| 全体签到 | skland arksign all |
| 全体签到详情 | skland arksign status --all |
| 角色更新 | skland char update |
| 资源更新 | skland sync |
| 界园肉鸽 | skland rogue --topic 界园 |
| 萨卡兹肉鸽 | skland rogue --topic 萨卡兹 |
| 萨米肉鸽 | skland rogue --topic 萨米 |
| 水月肉鸽 | skland rogue --topic 水月 |
| 傀影肉鸽 | skland rogue --topic 傀影 |
| 战绩详情 | skland rginfo |
| 收藏战绩详情 | skland rginfo --favored |
🪄 自定义快捷指令
该特性依赖于 Alconna 快捷指令。自定义指令不带
COMMAND_START,若有必要需手动填写
# 增加
/skland --shortcut <自定义指令> /skland
# 删除
/skland --shortcut delete <自定义指令>
# 列出
/skland --shortcut list
[!NOTE] 自定义指令中包含空格,需要用引号
""包裹。
例子:
user: /skland --shortcut /兔兔签到 "/skland arksign sign --all"
bot: skland::skland 的快捷指令: "/兔兔签到" 添加成功
🫣 暗语表
[!NOTE] 🧭 暗语使用
指北暗语消息来自 nonebot-plugin-argot 插件
对暗语对象
回复对应的暗语指令即可获取暗语消息
| 暗语指令 | 对象 | 说明 |
|---|---|---|
background |
信息卡片 |
查看背景图 |
📸 效果图
🔮 游戏信息
🫖 肉鸽战绩
🏆 战绩详情
💖 鸣谢
Alconna: 简单、灵活、高效的命令参数解析器NoneBot2: 跨平台 Python 异步机器人框架yuanyan3060/ArknightsGameResource: 明日方舟常用素材KomoriDev/Starify:超棒的 GitHub Star Trace 工具 🌟📈KomoriDev/nonebot-plugin-argot: 优秀的 NoneBot2 暗语支持
贡献者们
📢 声明
本插件仅供学习交流使用,数据由 森空岛 提供,请勿用于商业用途。
使用过程中,任何涉及个人账号隐私信息(如账号 token、cred 等)的数据,请勿提供给不信任的 Bot 所有者(尤其是 token)。
📋 TODO
- 完善用户接口返回数据解析
- 使用
nonebot-plugin-htmlrender渲染信息卡片 - 从
yuanyan3060/ArknightsGameResource下载游戏数据、检查数据更新 - 绘制渲染粥游信息卡片
- 支持扫码绑定
- 优化资源获取形式
- 完善肉鸽战绩返回信息解析
- 绘制渲染肉鸽战绩卡片
- 粥游签到自动化
- 修正肉鸽战绩渲染中剧目/符号认知/符文板/思绪中的错误 ID
- 细化粥游信息卡片的部分信息展示
-
扬了不必要的 💩 - 待补充,欢迎 pr
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nonebot_plugin_skland-0.4.5.tar.gz.
File metadata
- Download URL: nonebot_plugin_skland-0.4.5.tar.gz
- Upload date:
- Size: 21.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2df2f5447eca5b9439b2cb8a9bdc6508c3823044a231221c2509721b9ec8adb4
|
|
| MD5 |
05adf1f1894bbff7731148c3c82d3615
|
|
| BLAKE2b-256 |
f84c9228e79bd8b2464ca1ce84be530f56aec86b1508407e770dd61730e32e48
|
File details
Details for the file nonebot_plugin_skland-0.4.5-py3-none-any.whl.
File metadata
- Download URL: nonebot_plugin_skland-0.4.5-py3-none-any.whl
- Upload date:
- Size: 21.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c29fdaf5f901be9a3edfebce53097082232238ce0838e43fb29c15c5fe6b11fe
|
|
| MD5 |
6117e2775f045972c348471b97fd7846
|
|
| BLAKE2b-256 |
16456829170549f374197081f2d1d3c7a6a60c10b8af7708c69f26fb707e5b79
|