Skip to content

Latest commit

 

History

History
166 lines (116 loc) · 5.92 KB

README.md

File metadata and controls

166 lines (116 loc) · 5.92 KB
Raw

Rss Helper

基于 Mirai Console 的RSS订阅插件

Release Downloads MiraiForum

使用前应该查阅的相关文档或项目

指令

注意: 使用前请确保可以 在聊天环境执行指令
带括号的/前缀是可选的
<...>中的是指令名，由空格隔开表示或，选择其中任一名称都可执行例如 /rss add https://github.com/cssxsh.atom
[...]表示参数，当[...]后面带?时表示参数可选
{...}表示连续的多个参数

本插件指令权限ID 格式为 io.github.gnuf0rce.rss-helper:command.*, * 是指令的第一指令名
例如 /rss-mirai other 的权限ID为 io.github.gnuf0rce.rss-helper:command.rss-mirai

下列指令的 URL 参数可以使用 base64 编码 后的形式

RssBaseCommand

指令 描述
/<rss> <add> [url] 添加一个订阅
/<rss> <list> 列出订阅列表
/<rss> <interval> [url] [duration] 设置订阅间隔, 单位分钟
/<rss> <stop> [url] 取消一个订阅

RssGithubCommand

指令 描述
/<rss-github> <releases> [owner] [repo] 添加一个Releases订阅
/<rss-github> <commits> [owner] [repo] 添加一个Commits订阅
/<rss-github> <tags> [owner] [repo] 添加一个Tags订阅
/<rss-github> <activity> [user] 添加一个Activity订阅
/<rss-github> <private> [user] [secret] 添加一个Private订阅

RssMikanCommand

指令 描述
/<rss-mikan mikan> <my> [token] 添加一个MyBangumi订阅
/<rss-mikan mikan> <classic> 添加一个Classic订阅
/<rss-mikan mikan> <bangumi> [id] [sub]? 添加一个Bangumi订阅
/<rss-mikan mikan> <search> [word] 添加一个Search订阅

此指令基于 蜜柑计划

RssMoeCommand

指令 描述
/<rss-moe> <recent> 查看当季番剧TAG
/<rss-moe> <search> [name] 搜索TAG
/<rss-moe> <tags> {ids} 添加一个Tag订阅

此指令基于 萌番组

RssTestCommand

指令 描述
/<rss-test> <build> [url] [forward]? 测试一个订阅
/<rss-test> <ssl> 测试SSL
/<rss-test> <clear> 清空种子文件

RssMiraiCommand

指令 描述
/<rss-mirai mirai> <category> [value] 添加标签订阅
/<rss-mirai mirai> <plugin> 添加插件发布订阅
/<rss-mirai mirai> <other> 添加其他项目发布订阅

RssHubCommand

指令 描述
/<rss-hub rsshub> <add> 交互添加RssHub订阅

交互过程举例

1748(1438159989)  23:29:58
/rsshub add

QQBot(3337342367)  23:30:02
request returned 1899 routes

QQBot(3337342367)  23:30:03
请输入路由名

1748(1438159989)  23:30:07
755

QQBot(3337342367)  23:30:07
(0, /755/user/:username)

QQBot(3337342367)  23:30:08
/755/user/:username, 输入:username (置空可以输入#)

1748(1438159989)  23:30:21
akimoto-manatsu

QQBot(3337342367)  23:30:26
1748  
/rsshub add
RSS订阅任务[秋元真夏(乃木坂46) - 755]已添加

配置文件 RssHubConfig.yml 可以配置rsshub的域名，即可以配置rsshub的源
此配置只对新的rsshub订阅订阅行为有效

配置

RssHubConfig

  • domain rsshub 服务器的域名，默认为官方的 rsshub.app 此配置废除
  • host rsshub 服务器，默认为官方的 https://rsshub.app:443

HttpClientConfig

  • doh Dns Over Https Url (为空时关闭Doh，使用系统DNS since 1.0.0-dev-6)
  • sni 需要移除 SNI HostName 的域名的正则表达式列表
  • proxy 代理列表 host: proxy, host=127.0.0.1时是全局代理
  • ipv6 doh 开启ipv6 支持 (since 1.0.3)

设置默认代理

# MAP(host, proxy), default by host=127.0.0.1
proxy: 
  127.0.0.1: 'http://127.0.0.1:8080'

RssContentConfig

  • limit 订阅内容输出到QQ消息的最大长度，超过则只会输出 内容过长
  • forward 通过转发消息的形式发送

TODO

  • 翻译功能
  • 代理支持
  • Doh支持
  • 将Html转化为Mirai的MessageChain(主要目的是显示图片)

安装

MCL 指令安装

./mcl --update-package io.github.gnuf0rce:rss-helper --channel maven-stable --type plugin

手动安装

  1. 从 Releases 或者 Maven 下载 mirai2.jar
  2. 将其放入 plugins 文件夹中