diff --git a/README.md b/README.md index 6ead8b5..53725c4 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@
-# kmua-bot V2 +# kmua-bot v2 干啥啥不行，喵喵第一名
-## [阅读文档](https://krau.github.io/kmua-bot/) +## [文档](https://krau.github.io/kmua-bot/) demo: [@kmuav2bot](https://t.me/kmuav2bot) ## 鸣谢 - [python-telegram-bot](https://python-telegram-bot.org/) -- [rimochan/bnhhsh](https://github.com/RimoChan/bnhhsh) - [Kyomotoi/AnimeThesaurus](https://github.com/Kyomotoi/AnimeThesaurus) \ No newline at end of file diff --git a/docs/docs/aboutv1.md b/docs/docs/aboutv1.md deleted file mode 100644 index 7d4ab84..0000000 --- a/docs/docs/aboutv1.md +++ /dev/null @@ -1,3 +0,0 @@ -# 关于 V1 - -V1 暂时在还分支 main 上, 不再维护, 不推荐使用 , 因为是屎山 \ No newline at end of file diff --git a/docs/docs/help.md b/docs/docs/help.md index f0626c9..140d5b6 100644 --- a/docs/docs/help.md +++ b/docs/docs/help.md @@ -1,154 +1,5 @@ # 详细帮助 -## 功能 - -- Quote(载入史册) -- 群内文字命令互动 -- 获取群头衔/互赠头衔 -- 不能好好说话! -- 关键词回复 -- 今日老婆! -- 入群欢迎 -- 开发中... - -## 命令 - -| 命令 | 说明 | -| ----------------- | ----------------- | -| /help | 显示帮助信息 | -| /start | 开始使用 | -| /q | 载入史册 | -| /d | 移出史册 | -| /clear_chat_quote | 清空史册 | -| /t | 获取头衔/互赠头衔 | -| /setqp | 设置发名言概率 | -| /rank | 群统计信息 | -| /bnhhsh | 不能好好说话! | -| /waifu | 今日老婆 | -| /set_greet | 设置入群欢迎 | -| /clear_chat_data | 清空聊天数据 | - -## Quote - -使用 `/q` 回复一条消息, kmua 将会把这条消息置顶并记录到一个列表中, 每个群聊之间的列表相互独立 - -如果这条消息属于文字消息, kmua 将会生成一张图片, 示例如下(右下角是用户名,此处被码掉了) - -![quote图片示例](./images/quoteexp.png) - -当收到新消息时, kmua 有概率从列表中随机选择一条被记录的消息, 并转发 - -这个概率可以通过 `/setqp` 来设置, 默认为 0.1 , 范围是 [0,1] 的小数 - -### 内联查询 - -在任意输入栏艾特 kmua 即可查询自己的名言 - -当不输入其他内容时, 最多随机显示十条 - -![InlineQuery](./images/inlinequery.png) - -支持搜索 - -![InlineQueryWithQuery](./images/inlinequerywithquery.png) - -自己部署时, 需要私聊 [@BotFather](https://t.me/BotFather) 开启 Inline Mode - -## 群内互动 - -使用斜杠加文字 回复一条消息, 即可与所回复消息的发送者互动 - -示例: - -![interact1](./images/interact1.png) - -![interact2](./images/interact2.png) - -使用反斜杠可以主客(攻受)互换: - -![interact3](./images/interact3.png) - -如果不回复消息, 则是对自己使用: - -![interact4](./images/interact4.png) - -![interact5](./images/interact5.png) - -支持 GROUP, CHANNEL 等各种发言身份 - -如果你的互动内容中含有会被识别成 Bot 命令的内容(如 /rua 会被当作一个命令), 为了避免混乱, 此时 kmua 不会对其响应. - -你可以使用两个斜杠避免这个问题 ( //rua ) - -## 获取与互赠群头衔 - -为 kmua 赋予足够的管理员权限, 群员可以使用 `/t@` + 自定义内容 获取自定义头衔 - -如不指定自定义内容, 则默认为用户的用户名 - -可以互相赠予头衔, 使用 `/t@` + 自定义内容 回复一条消息即可, kmua 会将头衔赋予被回复者(如果已经有头衔, 则更改) - -互赠时, kmua 发送的内容是 "{当前用户}把{被回复用户}变成了{自定义头衔}!" - -当然, 你可以自己回复自己 - -## 不能好好说话 - -详见 [不能好好说话](https://github.com/RimoChan/bnhhsh) - -使用 /bnhhsh 加需要翻译的内容, 即可使用 - -在私聊中时, 不需要命令, 直接发送内容即可使用 - -## 关键词回复 - -kmua 可以对关键词进行回复, **当私聊时, 或回复 kmua 时, 或艾特 kmua 时** 响应 - -默认自带一个文爱词库, 来自 [AnimeThesaurus](https://github.com/Kyomotoi/AnimeThesaurus) - -词库是 json 文件, 格式示例: - -```json -{ - "早": - [ - "早喵~", - "早上好的说~~", - "欸..早..早上好(揉眼睛", - "早上要说我爱你！" - ], - "晚安": - [ - "晚安好梦哟~", - "晚安哦" - ] -} -``` - -将你自己的词库文件放入 `data / word_dicts` 文件夹下, 即可加载 - -如果不同词库文件存在相同的键, 它们的值将会被合并 - - -## 今日老婆 - -从 kmua 的数据记录中抽取一位群员当你的老婆! - -![today_waifu](./images/today_waifu.png) - -一般情况下, 每人每天在一个群组中只能抽取一位. 每日 UTC+8 4:00 刷新此数据. - -如果抽取到了奇怪的人, 群主可以清除此人的数据, 用户就可以重新抽取. - -由于 Telegram Bot API 的限制, 如果群组开启了隐藏群成员, 请赋予 kmua 管理员权限, 否则无法正常工作. - -如果你不想被抽到时接收到 @ 通知, 可以在与 kmua 的私聊中关闭. - -## 入群欢迎 - -在群组中使用 `/set_greet` + 欢迎内容, 即可设置入群欢迎. - -同时支持一些变量: - -- `{user}`: 新入群的用户的用户名 -- `{chat}`: 群聊名 \ No newline at end of file +::: tip +Writing... +::: \ No newline at end of file diff --git a/docs/docs/images/grouprank.png b/docs/docs/images/grouprank.png deleted file mode 100644 index 7a1f576..0000000 Binary files a/docs/docs/images/grouprank.png and /dev/null differ diff --git a/docs/docs/images/inlinequery.png b/docs/docs/images/inlinequery.png deleted file mode 100644 index 7d7c9e7..0000000 Binary files a/docs/docs/images/inlinequery.png and /dev/null differ diff --git a/docs/docs/images/inlinequerywithquery.png b/docs/docs/images/inlinequerywithquery.png deleted file mode 100644 index 08c94d5..0000000 Binary files a/docs/docs/images/inlinequerywithquery.png and /dev/null differ diff --git a/docs/docs/images/interact1.png b/docs/docs/images/interact1.png deleted file mode 100644 index ff65eff..0000000 Binary files a/docs/docs/images/interact1.png and /dev/null differ diff --git a/docs/docs/images/interact2.png b/docs/docs/images/interact2.png deleted file mode 100644 index 7517662..0000000 Binary files a/docs/docs/images/interact2.png and /dev/null differ diff --git a/docs/docs/images/interact3.png b/docs/docs/images/interact3.png deleted file mode 100644 index e1a263f..0000000 Binary files a/docs/docs/images/interact3.png and /dev/null differ diff --git a/docs/docs/images/interact4.png b/docs/docs/images/interact4.png deleted file mode 100644 index e7b3a73..0000000 Binary files a/docs/docs/images/interact4.png and /dev/null differ diff --git a/docs/docs/images/interact5.png b/docs/docs/images/interact5.png deleted file mode 100644 index b28567b..0000000 Binary files a/docs/docs/images/interact5.png and /dev/null differ diff --git a/docs/docs/images/quoteexp.png b/docs/docs/images/quoteexp.png deleted file mode 100644 index c32d45e..0000000 Binary files a/docs/docs/images/quoteexp.png and /dev/null differ diff --git a/docs/docs/images/today_waifu.png b/docs/docs/images/today_waifu.png deleted file mode 100644 index 3faa6b3..0000000 Binary files a/docs/docs/images/today_waifu.png and /dev/null differ diff --git a/docs/docs/index.md b/docs/docs/index.md index 037c1ee..456050f 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -2,12 +2,10 @@ **此文档需要更新, 欢迎贡献** -Kmua-bot 是一只 Telegram 上的机器人, 使用 [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot) 开发, 以 MIT 协议开源 +kmua 是一只 Telegram 上的机器人, 使用 [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot) 开发, 以 MIT 协议开源 DEMO: [@kmuav2bot](https://t.me/kmuav2bot) -头像来自 Bilibili VUP [Miya猫猫](https://space.bilibili.com/846180) - 这是猫猫 ![猫猫](./images/miyaneko.jpg) diff --git a/docs/docs/self-host.md b/docs/docs/self-host.md index 81fcbd0..df741d3 100644 --- a/docs/docs/self-host.md +++ b/docs/docs/self-host.md @@ -11,19 +11,18 @@ version: "3" services: kmua: image: ghcr.io/krau/kmua-bot:v2 - container_name: kmua-v2-main - init: true + container_name: kmua-main + restart: always volumes: - - ./data:/kmua/data # 数据路径, 目前不支持修改 + - ./data:/kmua/data - ./logs:/kmua/logs environment: - TZ=Asia/Shanghai - KMUA_TOKEN="你的token" - - KMUA_OWNERS=[] # bot 的主人id, 是一个数组 - - KMUA_PICKLE_PATH="./data/data.pickle" # pickle 数据保存路径, 目前不支持修改 - - KMUA_LOG_LEVEL="INFO" # 日志等级 - - KMUA_RANDOM_FILTER=0.1 # 随机过滤器概率,会影响某些随机功能的概率. 如 不能好好说话 在群聊中的随机发送 - - KMUA_PICKLE_UPDATE_INTERVAL=60 # pickle 文件的刷新间隔, 单位秒 + - KMUA_OWNERS=[] # 主人id, 是一个数组 + - KMUA_LOG_LEVEL="INFO" + - KMUA_DB_URL="sqlite:///./data/kmua.db" + - KMUA_BILILINK_CONVERT_API="" # 可选，用于转换b站链接, 见 https://github.com/krau/bililink-converter ``` ## 源码运行 @@ -33,4 +32,4 @@ Python版本: 3.11+ 1. `git clone https://github.com/krau/kmua-bot` 2. pip install -r requirements.txt 3. edit settings.toml -4. python bot.py \ No newline at end of file +4. python -m kmua \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8c6885e..4bc382d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: Kmua-botV2 +site_name: kmua-bot v2 site_author: Krau -site_description: Kmua-botV2 官方文档 +site_description: kmua-bot v2 官方文档 repo_name: krau/kmua-bot repo_url: https://github.com/krau/kmua-bot copyright: CC BY-NC-SA 4.0 @@ -13,5 +13,4 @@ nav: - index.md - help.md - self-host.md - - license.md - - aboutv1.md \ No newline at end of file + - license.md \ No newline at end of file