diff --git a/README.md b/README.md index 3b3f5d5..596c159 100644 --- a/README.md +++ b/README.md @@ -3,33 +3,37 @@ Pixiv爬虫一只,同时也是一个机器人/插件! ## 支持的机器人平台 ## - [Mirai](https://github.com/mamoe/mirai) -- [CoolQ](https://cqp.cc)(基于`SpringCQ`, 不支持多账号使用, 需要使用`CQHttp`插件) +- [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). ### Arguments ### +> ENV参数名为环境变量名, 用于给Docker容器提供设置方式. + - 通用参数 - - `proxy` / `CGJ_PROXY`: 设置代理 + - `-proxy` / `ENV: CGJ_PROXY`: 设置代理 - 格式: `协议://地址:端口` - 示例: `socks5://127.0.0.1:1080` - 机器人参数 - - `botDataDir` / `CGJ_BOT_DATA_DIR`: 设置`botMode`运行模式下机器人数据存储目录 + - `-botDataDir` / `ENV: CGJ_BOT_DATA_DIR`: 设置`botMode`运行模式下机器人数据存储目录 - 格式: `路径` - 示例: `./data` - 默认: `./` - - `redisAddress` / `CGJ_REDIS_URI`: Redis服务器地址 + - `-redisAddress` / `ENV: CGJ_REDIS_URI`: Redis服务器地址 - 格式: `地址:端口` - 示例: `127.0.0.1:6379` +> 例如以BotMode启动应用: `java -jar CGJ.jar botMode -proxy "socks5://127.0.0.1:1080 -redisAddress 127.0.0.1:6379` + ### Commands ### -- `pluginMode`: CoolQ插件模式(可支持与CoolQ其他插件共存, 性能耗损大) -- `botMode`: Mirai独立模式(推荐, 机器人独立运行, 不能与其他插件共存, 性能耗损小) +- `pluginMode`: CoolQ插件模式(依赖[酷Q机器人](https://cqp.cc/), 支持与CoolQ其他插件共存, 性能耗损大) +- `botMode`: Mirai独立模式(机器人独立运行, 不支持与其他插件共存, 性能耗损小) - `collectionDownload`: 收藏下载, 以原图画质下载Cookie所属账号的所有收藏作品 - `getRecommends`: 将访问主页获得的推荐作品全部以原图画质下载 - `getRankingIllust`: 以原图画质下载指定排行榜类型的全部作品 - `search`: 搜索指定内容并获取相关作品信息(不下载) - +> 注意: 除去机器人模式外, 其他功能后续可能会出现改动.