https://github.com/gnuf0rce/rss-helper
mirai-console 插件开发计划
https://github.com/gnuf0rce/rss-helper
qqbot rss
Last synced: 5 months ago
JSON representation
mirai-console 插件开发计划
- Host: GitHub
- URL: https://github.com/gnuf0rce/rss-helper
- Owner: gnuf0rce
- License: agpl-3.0
- Created: 2020-11-21T09:26:26.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T00:56:06.000Z (over 2 years ago)
- Last Synced: 2024-04-16T11:07:55.265Z (about 2 years ago)
- Topics: qqbot, rss
- Language: Kotlin
- Homepage: https://github.com/orgs/gnuf0rce/projects/1
- Size: 303 KB
- Stars: 47
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [Rss Helper](https://github.com/gnuf0rce/rss-helper)
> 基于 [Mirai Console](https://github.com/mamoe/mirai-console) 的RSS订阅插件
[](https://github.com/gnuf0rce/rss-helper/releases)
[](https://shields.io/category/downloads)
[](https://mirai.mamoe.net/topic/334)
**使用前应该查阅的相关文档或项目**
* [User Manual](https://github.com/mamoe/mirai/blob/dev/docs/UserManual.md)
* [Permission Command](https://github.com/mamoe/mirai/blob/dev/mirai-console/docs/BuiltInCommands.md#permissioncommand)
* [Chat Command](https://github.com/project-mirai/chat-command)
## 指令
注意: 使用前请确保可以 [在聊天环境执行指令](https://github.com/project-mirai/chat-command)
带括号的`/`前缀是可选的
`<...>`中的是指令名，由空格隔开表示或，选择其中任一名称都可执行例如 `/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
| 指令 | 描述 |
|:-------------------------------------|:-------------|
| `/ [url]` | 添加一个订阅 |
| `/ ` | 列出订阅列表 |
| `/ [url] [duration]` | 设置订阅间隔, 单位分钟 |
| `/ [url]` | 取消一个订阅 |
### RssGithubCommand
| 指令 | 描述 |
|:------------------------------------------|:---------------|
| `/ [owner] [repo]` | 添加一个Releases订阅 |
| `/ [owner] [repo]` | 添加一个Commits订阅 |
| `/ [owner] [repo]` | 添加一个Tags订阅 |
| `/ [user]` | 添加一个Activity订阅 |
| `/ [user] [secret]` | 添加一个Private订阅 |
### RssMikanCommand
| 指令 | 描述 |
|:-------------------------------------------|:----------------|
| `/ [token]` | 添加一个MyBangumi订阅 |
| `/ ` | 添加一个Classic订阅 |
| `/ [id] [sub]?` | 添加一个Bangumi订阅 |
| `/ [word]` | 添加一个Search订阅 |
此指令基于 [蜜柑计划](https://mikanani.me/)
### RssMoeCommand
| 指令 | 描述 |
|:-----------------------------|:----------|
| `/ ` | 查看当季番剧TAG |
| `/ [name]` | 搜索TAG |
| `/ {ids}` | 添加一个Tag订阅 |
此指令基于 [萌番组](https://bangumi.moe/)
### RssTestCommand
| 指令 | 描述 |
|:---------------------------------------|:-------|
| `/ [url] [forward]?` | 测试一个订阅 |
| `/ ` | 测试SSL |
| `/ ` | 清空种子文件 |
### RssMiraiCommand
| 指令 | 描述 |
|:----------------------------------------|:-----------|
| `/ [value]` | 添加标签订阅 |
| `/ ` | 添加插件发布订阅 |
| `/ ` | 添加其他项目发布订阅 |
### RssHubCommand
| 指令 | 描述 |
|:--------------------------|:-------------|
| `/ ` | 交互添加RssHub订阅 |
交互过程举例
```text
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 服务器，默认为官方的
### 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)
设置默认代理
```yaml
# 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
- [ ] 翻译功能
- [x] 代理支持
- [x] Doh支持
- [x] 将Html转化为Mirai的MessageChain(主要目的是显示图片)
## 安装
### MCL 指令安装
`./mcl --update-package io.github.gnuf0rce:rss-helper --channel maven-stable --type plugin`
### 手动安装
1. 从 [Releases](https://github.com/gnuf0rce/rss-helper/releases) 或者 [Maven](https://repo1.maven.org/maven2/io/github/gnuf0rce/rss-helper/) 下载 `mirai2.jar`
2. 将其放入 `plugins` 文件夹中