diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..4ec38d2 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,34 @@ +name: Build Plugin + +on: + push: + branches: [ master, main ] + pull_request: + branches: [ master, main ] + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + + steps: + - uses: actions/checkout@v4 + + - name: Set up JDK 11 + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'temurin' + + - name: Grant execute permission for gradlew + run: chmod +x gradlew + + - name: Build Plugin + run: ./gradlew buildPlugin + + - name: Upload Plugin Artifact + uses: actions/upload-artifact@v4 + with: + name: plugin + path: build/mirai/ diff --git a/README.md b/README.md index 2811d22..5ba5d8e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,55 @@ # mirai-console-jcf-plugin -基于Mirai Console的Curseforge插件 +基于Mirai Console的Curseforge与Modrinth插件 -# 请注意:本插件需要申请 [Curseforge Api Key](https://console.curseforge.com/) 才可使用!! +[![Build Plugin](https://github.com/jie65535/mirai-console-jcf-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/jie65535/mirai-console-jcf-plugin/actions/workflows/build.yml) + +# 请注意:使用 CurseForge 功能需要申请 [Curseforge Api Key](https://console.curseforge.com/)!Modrinth 功能无需 API Key 即可使用。 ## Introduction -允许用户通过`QQ`对[Curseforge](https://www.curseforge.com/)网站进行搜索查询 +允许用户通过`QQ`对[Curseforge](https://www.curseforge.com/)和[Modrinth](https://modrinth.com/)网站进行搜索查询 -现在支持搜索`Minecraft`相关内容,可以通过命令搜索模组、整合包、资源包。 +现在支持搜索`Minecraft`相关内容,可以通过命令搜索模组、整合包、资源包等。 支持查看文件列表与其下载地址,单独查看文件的更新日志。 +支持订阅项目更新,有新版本时自动推送通知。 + ## Usage 指令 - /jcf help # 查看帮助 - /jcf setApiKey # 设置Curseforge API Key +- /jcf setSubsSender \ # 设置订阅信息推送bot(qq id) +- /jcf setCheckInterval \ # 设置更新检查间隔(单位:秒) -分类搜索命令(可配置) +### CurseForge 分类搜索命令(可配置) - 搜索模组: cfmod \ - 搜索整合包: cfpack \ - 搜索资源包: cfres \ -- 搜索存档: cfword \ +- 搜索存档: cfworld \ - 搜索水桶服插件: cfbukkit \ - 搜索附加: cfaddon \ - 搜索定制: cfcustom \ +### Modrinth 分类搜索命令(可配置) +- 搜索模组: mrmod \ +- 搜索整合包: mrpack \ +- 搜索资源包: mrres \ +- 搜索光影: mrshader \ +- 搜索插件: mrplugin \ +- 搜索数据包: mrdata \ + +### 订阅管理命令 +**CurseForge 订阅** +- /jcf subStat # 查看 CurseForge 订阅处理状态 +- /jcf idleSubs # 使 CurseForge 订阅器闲置 +- /jcf runSubs # 使 CurseForge 订阅器恢复运行 + +**Modrinth 订阅** +- /jcf mrSubStat # 查看 Modrinth 订阅处理状态 +- /jcf mrIdleSubs # 使 Modrinth 订阅器闲置 +- /jcf mrRunSubs # 使 Modrinth 订阅器恢复运行 + ## Screenshots ![chat record image](/doc/contact.png) @@ -51,7 +76,11 @@ - [x] 获取文件下载地址 - [ ] 获取依赖的项目 --- -- [ ] 模组更新订阅,更新时通知订阅者 +- [x] 模组更新订阅,更新时通知订阅者 +- [x] 集成 [Modrinth](https://modrinth.com/) 平台 + - [x] 搜索模组、整合包、资源包、光影、插件、数据包 + - [x] 查看项目详情与版本列表 + - [x] 订阅项目更新通知 - [ ] 设置代理