diff --git a/README.md b/README.md new file mode 100644 index 0000000..a3652e4 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Telegram RSS Bot +## 开始使用 +安装依赖库,配置好设置里的`token`参数,然后运行`rssbot.py`即可。 +## 配置 +新建`settings.txt`文件,所有配置都按照`key=value`的格式写。 +如果值是布尔型,`true`对应`1`,`false`对应`0`。 +例如: +```text +token=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11 +maxCount=200 +downloadMediaFile=1 +sendFileURLScheme=0 +rssbotLib=rssbot.dll +``` +- [token](#token) +- [maxCount](#maxcount) +- [minTTL](#minttl) +- [maxTTL](#maxttl) +- [maxRetryCount](#maxretrycount) +- [telegramBotApiServer](#telegrambotapiserver) +- [downloadMediaFile](#downloadmediafile) +- [sendFileURLScheme](#sendfileurlscheme) +- [rssbotLib](#rssbotlib) +### token +必填参数。Telegram Bot API Token。向[@BotFather](https://t.me/BotFather)请求新建Bot,即可得到。 +### maxCount +可选参数。一个RSS订阅源中支持的最大条数,超出部分将会自动被忽略。默认值为100。 +### minTTL +可选参数。最小更新间隔。默认值为5。单位为分。 +### maxTTL +可选参数。最大更新间隔。默认值为1440。单位为分。如果该值小于`minTTL`,将会自动设为`minTTL`。 +### maxRetryCount +可选参数。使用Telegram Bot API发送信息发生错误时的最大重试次数。默认值为3。 +### telegramBotApiServer +可选参数。Telegram Bot API Server地址,例如`http://localhost:8081`。设置自建服务器地址后可以启用部分功能。[有关自建Telegram Bot API Server的信息。](https://core.telegram.org/bots/api#using-a-local-bot-api-server) +### downloadMediaFile +可选参数。在发送媒体文件前是否先下载。如果使用官方API地址,使用该方式最大可以发送50M的视频/文件和10M的图片。默认值为否(0)。 +### sendFileURLScheme +可选参数。是否使用本地文件(`file:///`)协议发送媒体。需要确保启用`downloadMediaFile`并且使用的是本地的Telegram Bot API Server(`telegramBotApiServer`)。默认值为否(0)。 +### rssbotLib +可选参数。[RSSBotLib](https://github.com/lifegpc/rssbotlib)的共享库位置。设置并且成功加载共享库后,默认启用以下功能: +- 发送视频时附带时长,视频分辨率大小信息(在视频文件大于10MB时非常有用)。