From b4c7a83f575ec6c2ee0583f459d4ecbed11ff200 Mon Sep 17 00:00:00 2001 From: shanmiteko Date: Sat, 6 Nov 2021 15:16:50 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 83 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 53 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 9bdf6f9..6c99f26 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # AutoScript + - [AutoScript](#autoscript) - [操作步骤](#操作步骤) - [获取COOKIE](#获取cookie) @@ -13,6 +14,7 @@ - [检测未读信息, 已读未读信息](#检测未读信息-已读未读信息) - [中奖推送(可选)](#中奖推送可选) - [设置说明](#设置说明) + - [Awesome](#awesome) [Github仓库链接](https://github.com/shanmiteko/LotteryAutoScript) @@ -21,6 +23,7 @@ [![Publishing to NPM](https://github.com/shanmiteko/LotteryAutoScript/actions/workflows/npmp.yml/badge.svg)](https://github.com/shanmiteko/LotteryAutoScript/actions/workflows/npmp.yml) 已实现功能: + - 监控用户转发 - 监控话题页面 - 监控专栏合集 @@ -71,7 +74,7 @@ Chrome浏览器: .join('; ') .split() .forEach(it => copy(it) || console.log(it)) - ``` + ``` 也可以采用**其他方式获取**所需的Cookie @@ -84,7 +87,9 @@ Chrome浏览器: ### 本地运行 #### 可执行文件 + 1. [[下载](https://github.com/shanmiteko/LotteryAutoScript/releases)|[cnpmjs镜像下载](https://github.com.cnpmjs.org/shanmiteko/LotteryAutoScript/releases)|[Fastgit镜像下载](https://hub.fastgit.org/shanmiteko/LotteryAutoScript/releases)]压缩包并解压后 + ``` ~/nlts-linux-x64 => tree @@ -94,10 +99,12 @@ Chrome浏览器: ├── my_config.js (自定义设置文件) (!使用前必读) └── README.md (说明文件) ``` + 2. 用记事本或其他编辑器修改`env.js`和`my_config.js`文件(右键选择用记事本打开) 3. 在`env.js`中填入`COOKIE`和推送参数 4. 在`my_config.js`中自定义设置 5. 在当前目录下**打开终端**运行可执行文件`lottery`(勿直接点击`lottery`) + ```sh # unix-like ## 进入脚本所在目录 @@ -117,6 +124,7 @@ Chrome浏览器: ## 把`./`换成`.\`或去掉 ## 已自带*.bat可直接点击 ``` + 7. 运行截图 ![lottery_start](https://gitee.com/shanmite/LotteryAutoScript/raw/main/doc/pic/lottery_start.png) @@ -183,23 +191,27 @@ npm i && npm run clear 脚本已内置定时运行功能 ##### Linux + [linux系统配置与定时运行](./doc/linux_schedule.md) ### Docker + 1.初始化 ```bash -$ curl -fsSL https://cdn.staticaly.com/gh/shanmiteko/LotteryAutoScript/main/script/docker/init.sh | sh +curl -fsSL https://cdn.staticaly.com/gh/shanmiteko/LotteryAutoScript/main/script/docker/init.sh | sh ``` 进入`lottery`文件夹 + ```bash -$ cd lottery +cd lottery ``` 编辑`env.js`与`my_config.js`文件 + - env.js 设置必要环境变量 - my_config.js 你的设置 @@ -207,8 +219,9 @@ $ cd lottery > start,check,clear 例如: + ```bash -$ ./start.sh +./start.sh ``` 2.更新 @@ -222,26 +235,28 @@ $ ./start.sh 进入lottery上一级目录 ```bash -$ docker image rm -f shanmite/lottery_auto_docker -$ rm -rf lottery/ +docker image rm -f shanmite/lottery_auto_docker +rm -rf lottery/ ``` ---------------------------------------- ## 防重复转发 + ~~存储在专栏草稿~~ ~~脚本将转发过的动态和被过滤的动态都写入`dyids/dyid*.txt`文件中~~ 是否点赞 - ---------------------------------------- ## 检测中奖 + ### 检测未读信息, 已读未读信息 判断依据 + - 通过`@`信息判断 - 通过私信判断 @@ -249,37 +264,45 @@ $ rm -rf lottery/ 关键词有限 可能会有**漏掉**的或**误报** ### 中奖推送(可选) + > 填写在env.js内 以下是支持的推送方式 -| Name | 归属 | 属性 | 说明 | -| :---------------: | :--------------------------------------------------------------------------------: | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `SCKEY` | 微信server酱推送(于2021/4月下线) | 非必须 | server酱的微信通知[官方文档](http://sc.ftqq.com/3.version) | -| `SENDKEY` | 微信server酱(Turbo版)推送 | 非必须 | [获取SENDKEY](https://sct.ftqq.com/sendkey) [选择消息通道](https://sct.ftqq.com/forward) | -| `BARK_PUSH` | [BARK推送](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865) | 非必须 | IOS用户下载BARK这个APP,填写内容是app提供的`设备码`，例如：https://api.day.app/123 ，那么此处的设备码就是`123`，再不懂看 [这个图](https://gitee.com/shanmite/LotteryAutoScript/raw/main/doc/pic/bark.jpg)（注：支持自建填完整链接即可） | -| `BARK_SOUND` | [BARK推送](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865) | 非必须 | bark推送声音设置，例如`choo`,具体值请在`bark`-`推送铃声`-`查看所有铃声` | -| `TG_BOT_TOKEN` | telegram推送 | 非必须 | tg推送(需设备可连接外网),`TG_BOT_TOKEN`和`TG_USER_ID`两者必需,填写自己申请[@BotFather](https://t.me/BotFather)的Token,如`10xxx4:AAFcqxxxxgER5uw` , [具体教程](doc/TG_PUSH.md) | -| `TG_USER_ID` | telegram推送 | 非必须 | tg推送(需设备可连接外网),`TG_BOT_TOKEN`和`TG_USER_ID`两者必需,填写[@getuseridbot](https://t.me/getuseridbot)中获取到的纯数字ID, [具体教程](doc/TG_PUSH.md) | -| `TG_PROXY_HOST` | Telegram 代理的 IP | 非必须 | 代理类型为 http。例子：http代理 http://127.0.0.1:1080 则填写 127.0.0.1 | -| `TG_PROXY_PORT` | Telegram 代理的端口 | 非必须 | 例子：http代理 http://127.0.0.1:1080 则填写 1080 | -| `DD_BOT_TOKEN` | 钉钉推送 | 非必须 | 钉钉推送(`DD_BOT_TOKEN`和`DD_BOT_SECRET`两者必需)[官方文档](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq) ,只需`https://oapi.dingtalk.com/robot/send?access_token=XXX` 等于`=`符号后面的XXX即可 | -| `DD_BOT_SECRET` | 钉钉推送 | 非必须 | (`DD_BOT_TOKEN`和`DD_BOT_SECRET`两者必需) ,密钥，机器人安全设置页面，加签一栏下面显示的SEC开头的`SECXXXXXXXXXX`等字符 , 注:钉钉机器人安全设置只需勾选`加签`即可，其他选项不要勾选,再不懂看 [这个图](https://gitee.com/shanmite/LotteryAutoScript/raw/main/doc/pic/DD_bot.png) | -| `IGOT_PUSH_KEY` | iGot推送 | 非必须 | iGot聚合推送，支持多方式推送，确保消息可达。 [参考文档](https://wahao.github.io/Bark-MP-helper ) | -| `QQ_SKEY` | 酷推(Cool Push)推送 | 非必须 | 推送所需的Skey,登录后获取Skey [参考文档](https://cp.xuthus.cc/) | -| `QQ_MODE` | 酷推(Cool Push)推送 | 非必须 | 推送方式(send或group或者wx，默认send) [参考文档](https://cp.xuthus.cc/) | -| `QYWX_KEY` | 企业微信推送 | 非必须 | 密钥，企业微信推送 webhook 后面的 key [详见官方说明文档](https://work.weixin.qq.com/api/doc/90000/90136/91770) | -| `PUSH_PLUS_TOKEN` | pushplus推送 | 非必须 | 微信扫码登录后一对一推送或一对多推送下面的token(您的Token) [官方网站](http://pushplus.hxtrip.com/) | -| `PUSH_PLUS_USER` | pushplus推送 | 非必须 | 一对多推送的“群组编码”（一对多推送下面->您的群组(如无则新建)->群组编码）注:(1、需订阅者扫描二维码 2、如果您是创建群组所属人，也需点击“查看二维码”扫描绑定，否则不能接受群组消息推送)，只填`PUSH_PLUS_TOKEN`默认为一对一推送 | -| `SMTP_HOST` | 电子邮件 | 非必须 | smtp服务器的主机名 如: `smtp.qq.com` | -| `SMTP_PORT` | 电子邮件 | 非必须 | smtp服务器的端口 如: `465` | -| `SMTP_USER` | 电子邮件 | 非必须 | 发送方的电子邮件 如: `xxxxxxxxx@qq.com` | -| `SMTP_PASS` | 电子邮件 | 非必须 | smtp服务对应的授权码 | -| `SMTP_TO_USER` | 电子邮件 | 非必须 | 接收方电子邮件 | +| Name | 归属 | 属性 | 说明 | +| :---------------: | :--------------------------------------------------------------------------------: | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `SCKEY` | 微信server酱推送(于2021/4月下线) | 非必须 | server酱的微信通知[官方文档](http://sc.ftqq.com/3.version) | +| `SENDKEY` | 微信server酱(Turbo版)推送 | 非必须 | [获取SENDKEY](https://sct.ftqq.com/sendkey) [选择消息通道](https://sct.ftqq.com/forward) | +| `BARK_PUSH` | [BARK推送](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865) | 非必须 | IOS用户下载BARK这个APP,填写内容是app提供的`设备码`，例如： ，那么此处的设备码就是`123`，再不懂看 [这个图](https://gitee.com/shanmite/LotteryAutoScript/raw/main/doc/pic/bark.jpg)（注：支持自建填完整链接即可） | +| `BARK_SOUND` | [BARK推送](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865) | 非必须 | bark推送声音设置，例如`choo`,具体值请在`bark`-`推送铃声`-`查看所有铃声` | +| `TG_BOT_TOKEN` | telegram推送 | 非必须 | tg推送(需设备可连接外网),`TG_BOT_TOKEN`和`TG_USER_ID`两者必需,填写自己申请[@BotFather](https://t.me/BotFather)的Token,如`10xxx4:AAFcqxxxxgER5uw` , [具体教程](doc/TG_PUSH.md) | +| `TG_USER_ID` | telegram推送 | 非必须 | tg推送(需设备可连接外网),`TG_BOT_TOKEN`和`TG_USER_ID`两者必需,填写[@getuseridbot](https://t.me/getuseridbot)中获取到的纯数字ID, [具体教程](doc/TG_PUSH.md) | +| `TG_PROXY_HOST` | Telegram 代理的 IP | 非必须 | 代理类型为 http。例子：http代理 则填写 127.0.0.1 | +| `TG_PROXY_PORT` | Telegram 代理的端口 | 非必须 | 例子：http代理 则填写 1080 | +| `DD_BOT_TOKEN` | 钉钉推送 | 非必须 | 钉钉推送(`DD_BOT_TOKEN`和`DD_BOT_SECRET`两者必需)[官方文档](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq) ,只需`https://oapi.dingtalk.com/robot/send?access_token=XXX` 等于`=`符号后面的XXX即可 | +| `DD_BOT_SECRET` | 钉钉推送 | 非必须 | (`DD_BOT_TOKEN`和`DD_BOT_SECRET`两者必需) ,密钥，机器人安全设置页面，加签一栏下面显示的SEC开头的`SECXXXXXXXXXX`等字符 , 注:钉钉机器人安全设置只需勾选`加签`即可，其他选项不要勾选,再不懂看 [这个图](https://gitee.com/shanmite/LotteryAutoScript/raw/main/doc/pic/DD_bot.png) | +| `IGOT_PUSH_KEY` | iGot推送 | 非必须 | iGot聚合推送，支持多方式推送，确保消息可达。 [参考文档](https://wahao.github.io/Bark-MP-helper ) | +| `QQ_SKEY` | 酷推(Cool Push)推送 | 非必须 | 推送所需的Skey,登录后获取Skey [参考文档](https://cp.xuthus.cc/) | +| `QQ_MODE` | 酷推(Cool Push)推送 | 非必须 | 推送方式(send或group或者wx，默认send) [参考文档](https://cp.xuthus.cc/) | +| `QYWX_KEY` | 企业微信推送 | 非必须 | 密钥，企业微信推送 webhook 后面的 key [详见官方说明文档](https://work.weixin.qq.com/api/doc/90000/90136/91770) | +| `PUSH_PLUS_TOKEN` | pushplus推送 | 非必须 | 微信扫码登录后一对一推送或一对多推送下面的token(您的Token) [官方网站](http://pushplus.hxtrip.com/) | +| `PUSH_PLUS_USER` | pushplus推送 | 非必须 | 一对多推送的“群组编码”（一对多推送下面->您的群组(如无则新建)->群组编码）注:(1、需订阅者扫描二维码 2、如果您是创建群组所属人，也需点击“查看二维码”扫描绑定，否则不能接受群组消息推送)，只填`PUSH_PLUS_TOKEN`默认为一对一推送 | +| `SMTP_HOST` | 电子邮件 | 非必须 | smtp服务器的主机名 如: `smtp.qq.com` | +| `SMTP_PORT` | 电子邮件 | 非必须 | smtp服务器的端口 如: `465` | +| `SMTP_USER` | 电子邮件 | 非必须 | 发送方的电子邮件 如: `xxxxxxxxx@qq.com` | +| `SMTP_PASS` | 电子邮件 | 非必须 | smtp服务对应的授权码 | +| `SMTP_TO_USER` | 电子邮件 | 非必须 | 接收方电子邮件 | ---------------------------------------- ## 设置说明 + 详见[env.example.js](./env.example.js)文件内部注释 详见[my_config.example.js](./my_config.example.js)文件内部注释 + +## Awesome +相关项目 + +- [LotteryAutoScript_Station](https://github.com/spiritLHL/LotteryAutoScript_Station) - @spiritLHL +- [sync_lottery](https://github.com/spiritLHL/sync_lottery) - @spiritLHL \ No newline at end of file