mirai-console-jcf-plugin/README.md
2021-11-01 22:08:19 +08:00

55 lines
1.6 KiB
Markdown

# mirai-console-jcf-plugin
基于Mirai Console的Curseforge插件
## Introduction
允许用户通过`QQ`对[Curseforge](https://www.curseforge.com/)网站进行搜索查询
现在支持搜索`Minecraft`相关内容,可以通过命令搜索模组、整合包、资源包。
支持查看文件列表与其下载地址,单独查看文件的更新日志。
## Usage
- /jcf id <projectId> # 根据id查找
- /jcf help # 帮助
- /jcf ss \<filter\> # 直接搜索
- /jcf sspack \<filter\> # 搜索整合包
- /jcf ssmod \<filter\> # 搜索模组
- /jcf ssres \<filter\> # 搜索资源包
## Screenshots
![chat record image](/doc/contact.png)
![show search result image](/doc/show_search_result.png)
![show addon info image](/doc/show_addon_info.png)
![show changelog image](/doc/show_changelog.png)
## TODO List
- [x] **搜索资源**
- [x] 搜索模组
- [x] 搜索整合包
- [x] 搜索资源包
- [x] ~~搜索存档~~
- [x] 根据项目ID搜索
---
- [x] 分页选择
- [ ] 获取介绍
- [x] 获取文件列表
- [x] 获取最新文件
- [x] 获取文件的修改记录
- [x] 获取文件下载地址
- [ ] 获取依赖的项目
---
- [ ] 模组更新订阅,更新时通知订阅者
- [ ] 设置代理
## 鸣谢
- [Mirai](https://github.com/mamoe/mirai) 提供机器人平台
- [Mirai Console](https://github.com/mamoe/mirai-console) 开放插件接入
- [Curseforge API](https://github.com/Gaz492/CurseforgeAPI) 提供`Curseforge API`
- [Curseforge API Kotlin library](https://github.com/pearxteam/cursekt) 提供`Curseforge API`的`kotlin`封装