基于 Mirai Console 的 GitHub Notice 订阅插件
使用前应该查阅的相关文档或项目
注意: 使用前请确保可以 在聊天环境执行指令
<...>中的是指令名,例如/repo-issue add mamoe/mirai
[...]表示参数,当[...]后面带?时表示参数可选
{...}表示连续的多个参数
本插件指令权限ID 格式为 io.github.gnuf0rce.github-helper:command.*, * 是指令的第一指令名
例如 /repo-issue add mamoe/mirai 的权限ID为 io.github.gnuf0rce.github-helper:command.repo-issue
[repo] 格式为 {owner}/{repo}, 举例 mamoe/mirai
[contact]?是可选的参数,会自动由当前环境填充,例如群聊填充群号,私聊填充QQ号
[type] 消息的格式,可选值为 OLD, TEXT, FORWARD
1.3.0 版本起,添加从 GitHub Release Latest 更新插件的功能
其配置文件位于 config/update.dict.json
| 指令 | 描述 |
|---|---|
/<issues> <add> [contact]? |
添加订阅 |
/<issues> <remove> [contact]? |
移除订阅 |
/<issues> <interval> [millis] |
设置订阅轮询间隔 |
/<issues> <format> [type] |
设置订阅消息格式 |
/<issues> <list> [contact]? |
查看订阅列表 |
/<issues> <test> [type] [contact]? |
测试订阅 |
这个指令用于获取当前用户的issues,所以需要有效 token
| 指令 | 描述 |
|---|---|
/<repo-commit> <add> [repo] [contact]? |
添加订阅 |
/<repo-commit> <remove> [repo] [contact]? |
移除订阅 |
/<repo-commit> <interval> [repo] [millis] |
设置订阅轮询间隔 |
/<repo-commit> <format> [repo] [type] |
设置订阅消息格式 |
/<repo-commit> <list> [contact]? |
查看订阅列表 |
/<repo-commit> <test> [repo] [type] [contact]? |
测试订阅 |
| 指令 | 描述 |
|---|---|
/<repo-issue> <add> [repo] [contact]? |
添加订阅 |
/<repo-issue> <remove> [repo] [contact]? |
移除订阅 |
/<repo-issue> <interval> [repo] [millis]? |
设置订阅轮询间隔 |
/<repo-issue> <format> [repo] [type] |
设置订阅消息格式 |
/<repo-issue> <list> [contact]? |
查看订阅列表 |
/<repo-issue> <test> [repo] [type] [contact]? |
测试订阅 |
- since 1.5.0 在
repo后可补充分支名,例如/repo-issue add Moyuyanli/HuYanSession:dev
| 指令 | 描述 |
|---|---|
/<repo-pull> <add> [repo] [contact]? |
添加订阅 |
/<repo-pull> <remove> [repo] [contact]? |
移除订阅 |
/<repo-pull> <interval> [repo] [millis]? |
设置订阅轮询间隔 |
/<repo-pull> <format> [repo] [type] |
设置订阅消息格式 |
/<repo-pull> <list> [contact]? |
查看订阅列表 |
/<repo-pull> <test> [repo] [type] [contact]? |
测试订阅 |
| 指令 | 描述 |
|---|---|
/<repo-release> <add> [repo] [contact]? |
添加订阅 |
/<repo-release> <remove> [repo] [contact]? |
移除订阅 |
/<repo-release> <interval> [repo] [millis]? |
设置订阅轮询间隔 |
/<repo-release> <format> [repo] [type] |
设置订阅消息格式 |
/<repo-release> <list> [contact]? |
查看订阅列表 |
/<repo-release> <test> [repo] [type] [contact]? |
测试订阅 |
| 指令 | 描述 |
|---|---|
/<stats> <card> [name] |
查看状态 |
/<stats> <contribution> [name] |
查看贡献 |
/<stats> <trophy> [name] |
查看奖杯 |
| 指令 | 描述 |
|---|---|
/<update> |
检查插件更新 |
1.1.7 起对接到 mirai-administrator 实现此功能
举例:
问题:GitHub ID ?
答案:cssxsh
机器人会检查 https://github.com/cssxsh 的活跃度是否满足要求,如满足要求则放行
proxyFormat http://127.0.0.1:8080 or socks://127.0.0.1:1080dohDns Over Https Urlgithub_tokenPersonal Access Tokensreply_typeURL解析回复的消息格式timeoutHttp 访问超时时间,单位秒percentage_member_join加群放行 GitHub 活跃等级(百分制),默认0,不开启功能percentages加群放行 GitHub 活跃等级(百分制),默认0,不开启功能sign_member_join加群放行提示信息github_readme_statsstats card 绘制参数auto_update启动时检查插件更新
请确认 mcl.jar 的版本是 2.1.0+
./mcl --update-package io.github.gnuf0rce:github-helper --channel maven-stable --type plugins