shift keyword 添加帮助

keyword/DES.md

@@ -1,2 +1,100 @@
 关键词回复。
-指令：,keyword
+
+指令：`,keyword`
+
+# 简介
+
+本插件提供关键词回复功能，此功能支持多种模式，并支持采取自选触发关键词后的操作。
+
+# 格式规约
+
+- 当设定消息内容的样式时（链接、加粗、斜体、代码块），内容需要遵从 HTML 格式，请见：https://docs.pyrogram.org/topics/text-formatting#html-style
+- `$mention`：此变量将自动被替换为 @ 该用户
+- `$code_id`：此变量将自动被替换为用户的 ID
+- `$code_name`：此变量将自动被替换为用户的昵称
+- `$delay_delete`：此变量将自动被替换为回复消息的自毁时间（单位为秒）。
+
+# 设置与示例
+
+## 添加关键词
+
+```
+,keyword 关键词
++++
+这是一个关键词回复的示例消息。
++++
+这里填写一些触发模式
++++
+这里填写一些触发操作
++++
+这里填写整数，代表消息自毁时间
+```
+
+设置关键词的匹配模式，默认为 `include`，并且大小写不敏感，如需指定多个模式，请将模式代号以空格分隔，可选的模式有：
+
+- `include`：包含匹配。
+- `exact`：全匹配。
+- `case`：大小写敏感。
+- `ignore_forward`：忽略被转发的消息。
+
+请注意，`include`，`exact` 模式互斥。
+
+设置关键词触发后应该执行的操作，默认为 `reply`，如需指定多个操作，请将操作以空格分隔，可选的操作有：
+
+- `reply`：回复预设内容。
+- `delete`：删除触发的消息。
+- `ban+n`：封禁用户 n 秒，小于 60 秒则永久封禁，例如 `ban+100`。
+- `restrict+n`：禁言用户 n 秒，例如 `restrict+100`。
+
+请注意，`ban*`、`restrict*` 操作互斥。
+
+设置关键词回复的自毁时间，默认不自毁：例如 `180`。
+
+```
+,keyword 关键词
++++
+回复的文字内容
++++
+include case
++++
+reply restrict+100
++++
+100
+```
+
+```
+,keyword 关键词
++++
+回复的文字内容
+```
+
+## 删除关键词
+
+`,keyword rm 关键词id`
+`,keyword rm 关键词id1,关键词id2`
+
+# 多个群组同步关键词
+
+## 添加同步关系
+
+首先需要获取被同步的 A 群组的 id
+
+`,id`
+
+在需要同步的 B 群组输入下面的命令
+
+`,keyword alias A群组id`
+
+至此，A 群组的所有关键词都会在 B 群组响应，如需修改关键词，请在 A 群组操作
+
+## 删除同步关系
+
+在需要删除同步的 B 群组输入下面的命令
+
+`,keyword alias rm`
+
+## 获取同步关系
+
+在需要获取同步关系的 B 群组输入下面的命令
+
+`,keyword alias`

list.json

@@ -172,13 +172,13 @@
         },
         {
             "name": "shift",
-            "version": "1.041",
+            "version": "1.042",
             "section": "daily",
             "maintainer": "xtaodada",
             "size": "5.3 kb",
             "supported": true,
             "des-short": "自动转发/备份频道消息",
-            "des": "自动转发频道新消息或者从零开始备份频道。\n指令：,shift\n查看帮助：,help shift"
+            "des": "自动转发频道新消息或者从零开始备份频道。\n\n指令：,shift\n\n# 设置转发\n\n当收到 from_channel_id 的新消息时，自动转发到 to_channel_id。\n\n需要加入 from_channel_id 和 to_channel_id。\n\n`, shift set [from channel_id] [to channel_id]`\n\n# 取消转发\n\n`, shift del [from channel_id]`\n\n# 备份频道\n\n`, shift backup [from channel_id] [to channel_id]`"
         },
         {
             "name": "dme",
@@ -308,7 +308,7 @@
             "size": "10.9 kb",
             "supported": true,
             "des-short": "关键词回复。",
-            "des": "关键词回复。\n指令：,keyword"
+            "des": "关键词回复。\n\n指令：`,keyword`\n\n# 简介\n\n本插件提供关键词回复功能，此功能支持多种模式，并支持采取自选触发关键词后的操作。\n\n# 格式规约\n\n- 当设定消息内容的样式时（链接、加粗、斜体、代码块），内容需要遵从 HTML 格式，请见：https://docs.pyrogram.org/topics/text-formatting#html-style\n- `$mention`：此变量将自动被替换为 @ 该用户\n- `$code_id`：此变量将自动被替换为用户的 ID\n- `$code_name`：此变量将自动被替换为用户的昵称\n- `$delay_delete`：此变量将自动被替换为回复消息的自毁时间（单位为秒）。\n\n# 设置与示例\n\n## 添加关键词\n\n```\n,keyword 关键词\n+++\n这是一个关键词回复的示例消息。\n+++\n这里填写一些触发模式\n+++\n这里填写一些触发操作\n+++\n这里填写整数，代表消息自毁时间\n```\n\n设置关键词的匹配模式，默认为 `include`，并且大小写不敏感，如需指定多个模式，请将模式代号以空格分隔，可选的模式有：\n\n- `include`：包含匹配。\n- `exact`：全匹配。\n- `case`：大小写敏感。\n- `ignore_forward`：忽略被转发的消息。\n\n请注意，`include`，`exact` 模式互斥。\n\n设置关键词触发后应该执行的操作，默认为 `reply`，如需指定多个操作，请将操作以空格分隔，可选的操作有：\n\n- `reply`：回复预设内容。\n- `delete`：删除触发的消息。\n- `ban+n`：封禁用户 n 秒，小于 60 秒则永久封禁，例如 `ban+100`。\n- `restrict+n`：禁言用户 n 秒，例如 `restrict+100`。\n\n请注意，`ban*`、`restrict*` 操作互斥。\n\n设置关键词回复的自毁时间，默认不自毁：例如 `180`。\n\n```\n,keyword 关键词\n+++\n回复的文字内容\n+++\ninclude case\n+++\nreply restrict+100\n+++\n100\n```\n\n```\n,keyword 关键词\n+++\n回复的文字内容\n```\n\n## 删除关键词\n\n`,keyword rm 关键词id`\n`,keyword rm 关键词id1,关键词id2`\n\n# 多个群组同步关键词\n\n## 添加同步关系\n\n首先需要获取被同步的 A 群组的 id\n\n`,id`\n\n在需要同步的 B 群组输入下面的命令\n\n`,keyword alias A群组id`\n\n至此，A 群组的所有关键词都会在 B 群组响应，如需修改关键词，请在 A 群组操作\n\n## 删除同步关系\n\n在需要删除同步的 B 群组输入下面的命令\n\n`,keyword alias rm`\n\n## 获取同步关系\n\n在需要获取同步关系的 B 群组输入下面的命令\n\n`,keyword alias`"
         },
         {
             "name": "voice_only_contact",

shift/DES.md

@@ -1,3 +1,19 @@
 自动转发频道新消息或者从零开始备份频道。
+
 指令：,shift
-查看帮助：,help shift
+
+# 设置转发
+
+当收到 from_channel_id 的新消息时，自动转发到 to_channel_id。
+
+需要加入 from_channel_id 和 to_channel_id。
+
+`, shift set [from channel_id] [to channel_id]`
+
+# 取消转发
+
+`, shift del [from channel_id]`
+
+# 备份频道
+
+`, shift backup [from channel_id] [to channel_id]`

shift/main.py

@@ -13,11 +13,11 @@ from pagermaid.listener import listener
 import contextlib
 
 
-@listener(is_plugin=False, outgoing=True, command="shift",
+@listener(command="shift",
           description='开启转发频道新消息功能',
-          parameters="set <from channel> <to channel> 自动转发频道新消息（可以使用频道用户名或者 id）\n"
+          parameters="set [from channel] [to channel] 自动转发频道新消息（可以使用频道用户名或者 id）\n"
-                     "del <from channel> 删除转发\n"
+                     "del [from channel] 删除转发\n"
-                     "backup <from channel> <to channel> 备份频道（可以使用频道用户名或者 id）")
+                     "backup [from channel] [to channel] 备份频道（可以使用频道用户名或者 id）")
 async def shift_set(client: Client, message: Message):
     if not 1 < len(message.parameter) < 4:
         await message.edit(f"{lang('error_prefix')}{lang('arg_error')}")