Skip to content

Commit

Permalink
🐛 更新文档,修复typing兼容性
Browse files Browse the repository at this point in the history
  • Loading branch information
kexue-z committed Aug 15, 2023
1 parent 6ac4bb5 commit b894c9e
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 12 deletions.
53 changes: 45 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,35 +66,47 @@ git clone https://github.com/kexue-z/nonebot-plugin-setu-now.git
```ini
setu_cd=
setu_path=
setu_porxy=
setu_proxy=
setu_withdraw=
setu_reverse_proxy=
setu_size=
setu_api_url=
setu_max=
setu_add_random_effect=
setu_minimum_send_interval=
setu_send_as_bytes=
```


- `setu_cd` CD(单位秒) 可选 默认`60`
- `setu_path` 保存路径 可选 按需填写, 可不填使用默认
- `setu_path` 保存路径 可选 可不填使用默认
- `setu_porxy` 代理地址 可选 当 pixiv 反向代理不能使用时可自定义
- `setu_reverse_proxy` pixiv 反向代理 可选 默认 `i.pixiv.re`
- `setu_withdraw` 撤回发送的色图消息的时间, 单位: 秒 可选 默认`关闭` 填入数字来启用, 建议 `10` ~ `120` **仅对于非合并转发使用**
- `setu_withdraw` 撤回发送的色图消息的时间, 单位: 秒 可选 默认 `关闭` 填入数字来启用, 建议 `10` ~ `120` **仅对于非合并转发使用**
- `setu_size` 色图质量 默认 `regular` 可选 `original` `regular` `small` `thumb` `mini`
- `setu_api_url` 色图信息 api 地址 默认`https://api.lolicon.app/setu/v2` 如果有 api 符合类型也能用
- `setu_max` 一次获取色图的数量 默认 `30` 如果你的服务器/主机内存吃紧 建议调小
- `setu_add_random_effect` 在发送失败时,随机添加线条效果或缩放模糊效果 **该选项目前已失效** 默认使用模糊缩放效果
- `setu_minimum_send_interval` 连续发送最小间隔(秒) 可选 默认 `3`
- `setu_send_as_bytes` 以bytes方式发送到客户端,默认 `False`
- `True` :Nonebot将会读取临时路径下的图片,并传到gocq等客户端。速度较慢
- `False` : 将会直接传输文件路径到gocq等客户端,并让客户端来读取。速度较快。如果 gocq 与 Nonebot 处于容器中,并且没有设定共享路径,则客户端将会无法读取图片,导致发送失败。

所有配置均可选,按需填写
> 有配置均可选,按需填写

## 使用

如果你能读懂正则就不用看了
### 获取色图

使用正则的方式获取

```r
^(setu|色图|涩图|来点色色|色色|涩涩|来点色图)\s?([x|✖️|×|X|*]?\d+[张||份]?)?\s?(r18)?\s?\s?(tag)?\s?(.*)?
```

**解释:**

- 指令 以 `setu|色图|涩图|来点色色|色色|涩涩` 为开始
- 然后接上可选数量 `x10` `10张|个|份`
- 再接上可选 `r18`
Expand All @@ -111,8 +123,33 @@ setu_max=
- `色图 x20 tag 碧蓝航线 妹妹`
- `涩涩10份魅魔`

### 获取图片信息

```r
[回复消息] 信息
```

**解释:**

- 回复bot发送的图片,并且附上指令 `信息`
- 该指令为 `on_command` 即需要带有命令前缀(如果你设置了 `/` 则应该是 `[回复消息] /信息`


### R18 设置

- 如果要求发送 R18 图片时,则数量会被忽略,仅发送单张
- 私聊中 R18 无白名单限制
- 群聊中 R18 需开启白名单,由 `超级管理员` 权限开启

**开启白名单指令:**

- `开启涩涩` / `可以涩涩` / `开启色色` / `可以色色` / `r18开启`

**关闭白名单指令:**

- `关闭涩涩` / `不可以涩涩` / `关闭色色` / `不可以色色` / `r18关闭`

# 在吗?

- 这个是 `on_regex` 而不是 `on_command`(不需要带命令前缀)
- 本插件一般都经过测试后才发版,如果遇到了任何问题,请先自行解决
- 任何`不正确使用插件`的 issue 将会直接关闭
- 色图 `on_regex` 而不是 `on_command`(不需要带命令前缀)

5 changes: 3 additions & 2 deletions nonebot_plugin_setu_now/r18_whitelist.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from nonebot.log import logger
from typing import Optional

from nonebot.log import logger
from nonebot.plugin.on import on_command
from nonebot.permission import SUPERUSER
from nonebot.adapters.onebot.v11 import MessageEvent, GroupMessageEvent
Expand All @@ -9,7 +10,7 @@

async def get_group_white_list_record(
event: MessageEvent,
) -> GroupWhiteListRecord | None:
) -> Optional[GroupWhiteListRecord]:
if isinstance(event, GroupMessageEvent):
res = await GroupWhiteListRecord.get_or_none(group_id=event.group_id)
logger.debug(f"Database white list record: {res}")
Expand Down
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "nonebot-plugin-setu-now"
version = "0.6.3"
version = "0.6.4"
description = "另一个色图插件"
authors = [{ name = "kexue", email = "xana278@foxmail.com" }]
dependencies = [
Expand All @@ -14,7 +14,9 @@ dependencies = [
]
requires-python = ">=3.8,<4.0"
readme = "README.md"
license = { text = "MIT" }
license = { file = "LICENSE" }
keywords = ["nonebot2"]


[project.urls]
homepage = "https://github.com/kexue-z/nonebot-plugin-setu-now"
Expand Down

0 comments on commit b894c9e

Please sign in to comment.