From ef34b01182b743e6cbd0777080cddf2930baedd1 Mon Sep 17 00:00:00 2001 From: Administrator Date: Sat, 29 Nov 2025 22:21:29 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 71 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c061836..d1d5b78 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,72 @@ -# TPM +# 🤖 TPM - Telegram 管理员转发与防骚扰机器人 -💬 Telegram 私聊机器人 \ No newline at end of file +TPM 是一个基于 Cloudflare Workers 构建的 Telegram 中转机器人, +支持自动消息转发、管理员回复、屏蔽机制、人机验证、关键词拦截、以及远程拦截词表同步。 + +--- + +## 🚀 功能简介 + +- **管理员中转**:用户消息自动转发给管理员,管理员可直接回复。 +- **人机验证**:首次或超过 3 小时未验证的用户需点击按钮验证。 +- **屏蔽与解封**:管理员可 `/block` `/unblock` 用户。 +- **关键词过滤**:支持本地和远程拦截词(自动定时刷新)。 +- **多语言提示**:支持中英文自动识别。 +- **节流提醒**:用户等待提示每小时最多出现一次。 +- **Webhook 自动注册**:支持一键注册、注销、查看。 + +--- + +## ⚙️ 环境变量 + +| 变量名 | 示例值 | 说明 | +|--------|---------|------| +| `ENV_BOT_TOKEN` | `XXX:XXXXXX` | Telegram Bot Token | +| `ENV_BOT_SECRET` | `secret_value` | Webhook Secret Token | +| `ENV_ADMIN_UID` | `"123456789"` | 管理员的 Telegram UID(纯数字字符串) | + +--- + +## 🛠️ 部署步骤 + +1. 打开 [Cloudflare Dashboard](https://dash.cloudflare.com) → **Workers & Pages** → 新建 Worker +2. 将 `worker.js` 全部代码复制进去 +3. 在 “Settings → Variables → Environment Variables” 添加上述三个环境变量 +4. 绑定 KV: + - 命名空间名称任意 + - 绑定变量名固定为:`KV` +5. 部署后访问: + - `https://你的域名/registerWebhook` 注册 Webhook + - `https://你的域名/debugWebhook` 查看绑定状态 + +--- + +## 🧩 管理员命令 + +| 命令 | 说明 | +|------|------| +| `/block` | 屏蔽用户(需回复用户消息) | +| `/unblock` | 解除屏蔽(需回复用户消息) | +| `/checkblock` | 查看屏蔽状态 | +| `/addkw <关键词>` | 添加屏蔽关键词 | +| `/rmkw <关键词>` | 移除屏蔽关键词 | +| `/listkw` | 查看本地关键词 | +| `/reloadblock` | 强制刷新远程拦截词 | +| `/listkw_remote` | 查看远程词表前 100 条 | +| `/listkw_all` | 查看本地 + 远程合并词表 | +| `/version` | 查看当前提示文案版本 | +| `/notifytest` | 测试用户等待提醒内容 | +| `/resetnotify ` | 手动清理某个用户节流键 | + +--- + +## ⚡ 调试命令 + +| 路径 | 功能 | +|------|------| +| `/registerWebhook` | 重新注册 Webhook | +| `/unRegisterWebhook` | 注销 Webhook | +| `/debugWebhook` | 查看当前绑定状态 | +| `/setMenu` | 更新命令菜单 | + +--- \ No newline at end of file