GitHub Helper
基于 Mirai Console 的 GitHub Notice 订阅插件
Release
Downloads
MiraiForum
GitHub Client Test
使用前应该查阅的相关文档或项目
User Manual
Permission Command
Chat Command
指令
注意: 使用前请确保可以 在聊天环境执行指令
<...>中的是指令名，例如/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, GRAPH
GitHubIssuesCommand
指令
描述
/<issues> <add> [contact]?
添加订阅
/<issues> <remove> [contact]?
移除订阅
/<issues> <interval> [millis]
设置订阅轮询间隔
/<issues> <format> [type]
设置订阅消息格式
/<issues> <list> [contact]?
查看订阅列表
/<issues> <test> [type] [contact]?
测试订阅
这个指令用于获取当前用户的issues，所以需要有效 token
GitHubRepoCommitCommand
指令
描述
/<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]?
测试订阅
GitHubRepoIssueCommand
指令
描述
/<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]?
测试订阅
GitHubRepoPullCommand
指令
描述
/<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]?
测试订阅
GitHubRepoReleaseCommand
指令
描述
/<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]?
测试订阅
GitHubStatsCommand
指令
描述
/<stats> <card> [name]
查看状态
/<stats> <contribution> [name]
查看贡献
/<stats> <trophy> [name]
查看奖杯
设置
GithubConfig
proxy Format
http://127.0.0.1:8080 or socks://127.0.0.1:1080
doh Dns Over Https Url
github_token
Personal Access Tokens
reply_type URL解析回复的消息格式
timeout Http 访问超时时间，单位秒
percentage_member_join 加群放行 GitHub 活跃等级（百分制），默认0，不开启功能
percentages 加群放行 GitHub 活跃等级（百分制），默认0，不开启功能
sign_member_join 加群放行提示信息
github_readme_stats stats card 绘制参数
安装
MCL 指令安装
请确认 mcl.jar 的版本是 2.1.0+
./mcl --update-package io.github.gnuf0rce:github-helper --channel maven-stable --type plugins
手动安装
从
Releases 或者
Maven 下载 mirai2.jar
将其放入 plugins 文件夹中
