From eef9f285cacf7f3cb8b1d8e9f4fd6a88ec871b95 Mon Sep 17 00:00:00 2001 From: LamGC Date: Tue, 30 Jun 2020 08:58:08 +0800 Subject: [PATCH] =?UTF-8?q?[Update]=20README.md=20=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E4=B8=80=E4=BB=BD=E6=9B=B4=E8=A7=84=E8=8C=83=E7=9A=84Readme;?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 134 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 103 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 7a35887..a18c609 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,113 @@ -# ContentGrabbingJi # -Pixiv爬虫一只，同时也是一个机器人/插件！ +# ContentGrabbingJi - 色图姬 # +一个以高性能、高效率为目标，多平台/框架支持、持续维护的Pixiv聊天机器人 -## 支持的机器人平台 ## -- [Mirai](https://github.com/mamoe/mirai) -- [CoolQ](https://cqp.cc)(基于[`SpringCQ`](https://github.com/lz1998/spring-cq), 不支持多账号使用, 需要使用[`CQHttp`](https://cqhttp.cc/)插件) +色图姬存在的目的最初是作为**爬虫 + 机器人**的形式开发，在开发过程中逐渐以多聊天平台，高效率为目标进行。 -## Usage ## -> 注意: 运行色图姬前, 你需要准备一个Pixiv账号的会话Cookie存储文件, 否则色图姬将无法运行. -> 详见[PixivLoginProxyServer](https://github.com/LamGC/PixivLoginProxyServer)项目的[Readme](https://github.com/LamGC/PixivLoginProxyServer/blob/master/README.md). +## 安装 ## +### 通过Jar文件部署 ### +1. 从项目的[版本页面](https://github.com/LamGC/ContentGrabbingJi/releases)下载最新版色图姬主程序jar文件 +2. 准备一个目录, 用于存放运行数据(这里以`./runData`为例子). +3. 将通过PixivLoginProxyServer获得的Pixiv登录会话文件放置在目录中(`./runData/cookies.store`). +4. 使用命令`java -jar buildPassword -password "QQ机器人账号的密码"`构造一个登录用的密码. +5. 在数据目录创建一个配置文件`bot.properties`, 并添加如下内容: + ```properties + bot.qq=<机器人QQ账号> + bot.password=<通过buildPassword获得的密码> + ``` +6. 在数据目录创建新文件夹`setting`, 并创建一个全局配置文件`global.properties`, 然后设置如下内容: + ```properties + # 该配置为全局配置文件, 当群组没有特定配置时, 将使用全局配置. + # 管理员QQ (必填) + admin.adminId=<管理员QQ号> + # 是否允许r18作品 + image.allowR18=false + # 查询排行榜默认的长度(比如15就是发送1~15名的作品), 该选项请适当调整, 设置过长可能导致超出聊天平台的最长消息长度, 导致发送失败! + ranking.itemCountLimit=15 + # 排行榜图片数量(比如排行榜长度为15, 可以设置前10名有图片, 后5名没有图片), 调整该配置可有效控制消息发送所需时间. + ranking.imageCountLimit=15 + # 搜索结果缓存时间, 默认2小时, 单位毫秒 + cache.searchBody.expire=7200000 + # 搜索结果长度. 该选项请适当调整, 设置过长可能导致超出聊天平台的最长消息长度, 导致发送失败! + search.itemCountLimit=8 + ``` +7. 配置完成后, 准备一台Redis服务端, 用于缓存数据. +8. Redis服务器准备好后, 使用命令启动色图姬：`java -jar botMode -botDataDir <数据目录> -redisAddress [-proxy 代理服务器地址]` +9. 完成！好好享受！ -### Arguments ### -> ENV参数名为环境变量名, 用于给Docker容器提供设置方式. +### 通过Docker部署 ### +使用Docker将可以更好的管理色图姬所使用的资源，和管理色图姬的运行。 +(正在完善中...) -- 通用参数 - - `-proxy` / `ENV: CGJ_PROXY`: (**可选**) 设置代理 - - 格式: `协议://地址:端口` - - 示例: `socks5://127.0.0.1:1080` -- 机器人参数 - - `-botDataDir` / `ENV: CGJ_BOT_DATA_DIR`: (**可选**) 设置`botMode`运行模式下机器人数据存储目录 - - 格式: `路径` - - 示例: `./data` - - 默认: `./` - - `-redisAddress` / `ENV: CGJ_REDIS_URI`: (**必填, 计划支持可选**) Redis服务器地址 - - 格式: `地址:端口` - - 示例: `127.0.0.1:6379` +## 使用 ## +### 普通用户 ### +将色图姬部署完成，并且让色图姬在某个平台登录完成后，你就可以通过聊天平台向色图姬发起会话了！ +使用 `.cgj` 向色图姬询问帮助信息！ -> 例如以BotMode启动应用: `java -jar CGJ.jar botMode -proxy "socks5://127.0.0.1:1080 -redisAddress 127.0.0.1:6379` +另外，由于色图姬在开发过程中直接使用了原本应用在命令行中的参数解析工具，所以你需要了解一下色图姬命令的格式， +色图姬的命令格式为： +```bash +.cgj <命令> -<参数名> <参数值> ... +``` +如果色图姬无法识别你的命令，那么它会发送一次帮助信息给你。 -### Commands ### -- `pluginMode`: CoolQ插件模式(依赖[酷Q机器人](https://cqp.cc/), 支持与CoolQ其他插件共存, 性能耗损大) -- `botMode`: Mirai独立模式(机器人独立运行, 不支持与其他插件共存, 性能耗损小) -- `collectionDownload`: 收藏下载, 以原图画质下载Cookie所属账号的所有收藏作品 -- `getRecommends`: 将访问主页获得的推荐作品全部以原图画质下载 -- `getRankingIllust`: 以原图画质下载指定排行榜类型的全部作品 -- `search`: 搜索指定内容并获取相关作品信息(不下载) +### 管理员用户 ### +你应该注意到了，在部署过程中，你需要设置一个管理员QQ的配置，色图姬支持通过命令来管理色图姬的运行。 +目前支持的管理员命令： +```bash +# 清除缓存 +.cgjadmin cleanCache -> 注意: 除去机器人模式外, 其他功能后续可能会出现改动. +# 设置配置项 +# 如果不使用group参数, 则设置全局配置 +.cgjadmin setProperty <-key 配置项名> <-value 配置项新值> [-group 指定群组] + +# 查询配置项 +# 如果不使用group参数, 则查询全局配置 +.cgjadmin getProperty <-key 配置项名> [-group 指定群组] + +# 保存所有配置 +.cgjadmin saveProperties + +# 读取所有配置 +# 使用 reload 参数将会重载所有配置, 而不是覆盖读取 +.cgjadmin loadProperties [-reload] + +# 运行定时更新任务 +# 可指定要更新数据的日期 +.cgjadmin runUpdateTask [-date yyyy-MM-dd] + +# 增加群组作品推送 +# 如果增加了original参数, 则图片为原图发送 +# 如果不指定group参数, 则群组为命令发送所在群组 +.cgjadmin addPushGroup [-group 指定群组号] [-minTime 最小] [-floatTime 随机时间范围] [-rankingStart 排行榜起始排名] [-rankingStop 排行榜结束排名] [-mode 排行榜模式] [-type 排行榜类型] [-original] + +# 删除群组推送功能 +# 如果不指定group参数, 则群组为命令发送所在群组 +.cgjadmin removePushGroup [-group 指定群组号] + +# 加载作品推送配置 +.cgjadmin loadPushList + +# 保存作品推送配置 +.cgjadmin savePushList + +# 获取被报告的作品列表 +# 该命令会返回被其他用户报告其存在问题的作品列表 +.cgjadmin getReportList + +# 解封被报告的作品 +.cgjadmin unBanArtwork <-id 被ban作品的Id> + +``` + +## 贡献 ## +向色图姬贡献不一定需要编程知识，向色图姬项目提出意见，反馈问题同样会为色图姬项目提供很大的帮助！ +如果你在使用色图姬的过程中，遇到了Bug，可以通过色图姬项目的**Issues**使用[Bug反馈模板](https://github.com/LamGC/ContentGrabbingJi/issues/new?assignees=&labels=bug&template=Bug_Report.md&title=)向色图姬提供Bug信息。 +如果是为色图姬提供一些新功能想法，或者对色图姬有什么意见，则可以直接通过Issues发起讨论。 + +如果你会Java开发，又想为色图姬提供一些新功能，可以通过Fork仓库的方法，实现后发起PR，合并到色图姬项目中！ +向色图姬贡献代码，需要遵循一些贡献事项，如果你的代码不符合这些事项，PR有可能会被关闭！ +> 注意：色图姬的初衷并没有任何恶意的意图，如果尝试向色图姬提供恶意功能或代码，PR将会被拒绝、关闭。 ## LICENSE ## 本项目基于 `GNU Affero General Public License 3.0` 开源许可协议开源，