From d66337d8c8cf291cf8ffbb9639c10ead5b41292a Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 02:17:59 +0000 Subject: [PATCH 1/6] =?UTF-8?q?=E4=BC=98=E5=8C=96=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/demo.ts | 2 +- examples/quick-start.ts | 2 +- examples/ripe-wechaty-Devo919-Gewechat.ts | 2 +- src/mod.ts | 22 +++++++++---------- ...s => puppet-bridge-atorber-fused-39825.ts} | 0 ...cixingguangming55555-wechat-bot-391027.ts} | 0 ...-cixingguangming55555-wechat-bot-39223.ts} | 0 .../puppet-bridge-ipad.ts} | 8 +++---- ...ts => puppet-bridge-jwping-wxbot-39825.ts} | 0 ...pet-bridge-lich0821-WeChatFerry-391027.ts} | 0 ...puppet-bridge-ttttupup-wxhelper-391019.ts} | 0 ... puppet-bridge-ttttupup-wxhelper-39223.ts} | 0 ... puppet-bridge-ttttupup-wxhelper-39581.ts} | 0 src/puppet/puppet-bridge.spec.ts | 2 +- 14 files changed, 19 insertions(+), 19 deletions(-) rename src/puppet/{puppet-bridge-atorber-fused.ts => puppet-bridge-atorber-fused-39825.ts} (100%) rename src/puppet/{puppet-bridge.ts => puppet-bridge-cixingguangming55555-wechat-bot-391027.ts} (100%) rename src/puppet/{puppet-bridge-cixingguangming55555-wechat-bot.ts => puppet-bridge-cixingguangming55555-wechat-bot-39223.ts} (100%) rename src/{puppet-bridge.ts => puppet/puppet-bridge-ipad.ts} (99%) rename src/puppet/{puppet-bridge-jwping-wxbot.ts => puppet-bridge-jwping-wxbot-39825.ts} (100%) rename src/puppet/{puppet-bridge-lich0821-WeChatFerry-3091027.ts => puppet-bridge-lich0821-WeChatFerry-391027.ts} (100%) rename src/puppet/{puppet-bridge-ttttupup-wxhelper-3091019.ts => puppet-bridge-ttttupup-wxhelper-391019.ts} (100%) rename src/puppet/{puppet-bridge-ttttupup-wxhelper-3090223.ts => puppet-bridge-ttttupup-wxhelper-39223.ts} (100%) rename src/puppet/{puppet-bridge-ttttupup-wxhelper.ts => puppet-bridge-ttttupup-wxhelper-39581.ts} (100%) diff --git a/examples/demo.ts b/examples/demo.ts index 11fa9a1..afff59a 100644 --- a/examples/demo.ts +++ b/examples/demo.ts @@ -17,7 +17,7 @@ import { import qrcodeTerminal from 'qrcode-terminal' import { FileBox } from 'file-box' -import { PuppetBridge } from '../src/puppet/puppet-bridge.js' +import { PuppetBridge } from '../src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-391027.js' const onScan = (qrcode: string, status: ScanStatus) => { if (status === ScanStatus.Waiting || status === ScanStatus.Timeout) { diff --git a/examples/quick-start.ts b/examples/quick-start.ts index 875acb0..700f45e 100644 --- a/examples/quick-start.ts +++ b/examples/quick-start.ts @@ -6,7 +6,7 @@ import { log, } from 'wechaty' import { FileBox } from 'file-box' -import { PuppetBridge } from '../src/puppet/puppet-bridge.js' +import { PuppetBridge } from '../src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-391027.js' async function onLogin (user: Contact) { log.info('onLogin', '%s login', user) diff --git a/examples/ripe-wechaty-Devo919-Gewechat.ts b/examples/ripe-wechaty-Devo919-Gewechat.ts index 73f92a0..2e6d6b8 100644 --- a/examples/ripe-wechaty-Devo919-Gewechat.ts +++ b/examples/ripe-wechaty-Devo919-Gewechat.ts @@ -11,7 +11,7 @@ import { } from 'wechaty' import { FileBox } from 'file-box' -import { PuppetBridge, PuppetBridgeOptions } from '../src/puppet-bridge.js' +import { PuppetBridge, PuppetBridgeOptions } from '../src/puppet/puppet-bridge-ipad.js' import qrcodeTerminal from 'qrcode-terminal' import * as fs from 'fs' import 'dotenv/config.js' diff --git a/src/mod.ts b/src/mod.ts index 070220e..ac4b382 100644 --- a/src/mod.ts +++ b/src/mod.ts @@ -1,18 +1,20 @@ import { VERSION } from './config.js' -import { PuppetBridge as PuppetBridgeCixingguangming55555WechatBotV3091027 } from './puppet/puppet-bridge.js' -import { PuppetBridge as PuppetBridgeJwpingWxbotV3090825 } from './puppet/puppet-bridge-jwping-wxbot.js' -import { PuppetBridge as PuppetBridgeCixingguangming55555WechatBotV3090223 } from './puppet/puppet-bridge-cixingguangming55555-wechat-bot.js' -import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3090581 } from './puppet/puppet-bridge-ttttupup-wxhelper.js' -import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3090223 } from './puppet/puppet-bridge-ttttupup-wxhelper-3090223.js' -import { PuppetBridge as PuppetBridgeAtorberFusedV3090825 } from './puppet/puppet-bridge-atorber-fused.js' -import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3091019 } from './puppet/puppet-bridge-ttttupup-wxhelper-3091019.js' +import { PuppetBridge as PuppetBridgeCixingguangming55555WechatBotV3091027 } from './puppet/puppet-bridge-cixingguangming55555-wechat-bot-391027.js' +import { PuppetBridge as PuppetBridgeJwpingWxbotV3090825 } from './puppet/puppet-bridge-jwping-wxbot-39825.js' +import { PuppetBridge as PuppetBridgeCixingguangming55555WechatBotV3090223 } from './puppet/puppet-bridge-cixingguangming55555-wechat-bot-39223.js' +import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3090581 } from './puppet/puppet-bridge-ttttupup-wxhelper-39581.js' +import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3090223 } from './puppet/puppet-bridge-ttttupup-wxhelper-39223.js' +import { PuppetBridge as PuppetBridgeAtorberFusedV3090825 } from './puppet/puppet-bridge-atorber-fused-39825.js' +import { PuppetBridge as PuppetBridgeTtttupupWxhelperV3091019 } from './puppet/puppet-bridge-ttttupup-wxhelper-391019.js' // import { PuppetBridge as PuppetBridgeLich0821WeChatFerryV3091027 } from './puppet-bridge-lich0821-WeChatFerry-3091027.js' -import { PuppetBridge } from './puppet/puppet-bridge-lich0821-WeChatFerry-3091027.js' -import { PuppetBridge as PuppetGeWe } from './puppet-bridge.js' +import { PuppetBridge } from './puppet/puppet-bridge-lich0821-WeChatFerry-391027.js' +import { PuppetBridge as PuppetGeWe } from './puppet/puppet-bridge-ipad.js' import { Client as Gewe } from './agents/Devo919-Gewechat/client/mod.js' export { VERSION, + PuppetGeWe, + PuppetBridge as PuppetWeChatFerryV391027, PuppetBridge, PuppetBridgeJwpingWxbotV3090825, PuppetBridgeCixingguangming55555WechatBotV3090223, @@ -22,7 +24,5 @@ export { PuppetBridgeTtttupupWxhelperV3091019, PuppetBridgeCixingguangming55555WechatBotV3091027, Gewe, - PuppetBridge as PuppetWeChatFerry, - PuppetGeWe, } export default PuppetBridge diff --git a/src/puppet/puppet-bridge-atorber-fused.ts b/src/puppet/puppet-bridge-atorber-fused-39825.ts similarity index 100% rename from src/puppet/puppet-bridge-atorber-fused.ts rename to src/puppet/puppet-bridge-atorber-fused-39825.ts diff --git a/src/puppet/puppet-bridge.ts b/src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-391027.ts similarity index 100% rename from src/puppet/puppet-bridge.ts rename to src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-391027.ts diff --git a/src/puppet/puppet-bridge-cixingguangming55555-wechat-bot.ts b/src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-39223.ts similarity index 100% rename from src/puppet/puppet-bridge-cixingguangming55555-wechat-bot.ts rename to src/puppet/puppet-bridge-cixingguangming55555-wechat-bot-39223.ts diff --git a/src/puppet-bridge.ts b/src/puppet/puppet-bridge-ipad.ts similarity index 99% rename from src/puppet-bridge.ts rename to src/puppet/puppet-bridge-ipad.ts index e636fce..951ae25 100644 --- a/src/puppet-bridge.ts +++ b/src/puppet/puppet-bridge-ipad.ts @@ -12,14 +12,14 @@ import { import { qrCodeForChatie, VERSION, -} from './config.js' +} from '../config.js' import type { MessageRaw, -} from './agents/wechat-bot/cixingguangming55555-wechat-bot.js' +} from '../agents/wechat-bot/cixingguangming55555-wechat-bot.js' -import { XmlDecrypt } from './pure-functions/xml-msgpayload.js' -import { Bridge } from './agents/Devo919-Gewechat/bridge/mod.js' +import { XmlDecrypt } from '../pure-functions/xml-msgpayload.js' +import { Bridge } from '../agents/Devo919-Gewechat/bridge/mod.js' export type PuppetBridgeOptions = PUPPET.PuppetOptions & { token: string diff --git a/src/puppet/puppet-bridge-jwping-wxbot.ts b/src/puppet/puppet-bridge-jwping-wxbot-39825.ts similarity index 100% rename from src/puppet/puppet-bridge-jwping-wxbot.ts rename to src/puppet/puppet-bridge-jwping-wxbot-39825.ts diff --git a/src/puppet/puppet-bridge-lich0821-WeChatFerry-3091027.ts b/src/puppet/puppet-bridge-lich0821-WeChatFerry-391027.ts similarity index 100% rename from src/puppet/puppet-bridge-lich0821-WeChatFerry-3091027.ts rename to src/puppet/puppet-bridge-lich0821-WeChatFerry-391027.ts diff --git a/src/puppet/puppet-bridge-ttttupup-wxhelper-3091019.ts b/src/puppet/puppet-bridge-ttttupup-wxhelper-391019.ts similarity index 100% rename from src/puppet/puppet-bridge-ttttupup-wxhelper-3091019.ts rename to src/puppet/puppet-bridge-ttttupup-wxhelper-391019.ts diff --git a/src/puppet/puppet-bridge-ttttupup-wxhelper-3090223.ts b/src/puppet/puppet-bridge-ttttupup-wxhelper-39223.ts similarity index 100% rename from src/puppet/puppet-bridge-ttttupup-wxhelper-3090223.ts rename to src/puppet/puppet-bridge-ttttupup-wxhelper-39223.ts diff --git a/src/puppet/puppet-bridge-ttttupup-wxhelper.ts b/src/puppet/puppet-bridge-ttttupup-wxhelper-39581.ts similarity index 100% rename from src/puppet/puppet-bridge-ttttupup-wxhelper.ts rename to src/puppet/puppet-bridge-ttttupup-wxhelper-39581.ts diff --git a/src/puppet/puppet-bridge.spec.ts b/src/puppet/puppet-bridge.spec.ts index 3d79b97..6678058 100644 --- a/src/puppet/puppet-bridge.spec.ts +++ b/src/puppet/puppet-bridge.spec.ts @@ -2,7 +2,7 @@ import { test } from 'tstest' -import { PuppetBridge } from './puppet-bridge.js' +import { PuppetBridge } from './puppet-bridge-cixingguangming55555-wechat-bot-391027.js' class PuppetBridgeTest extends PuppetBridge { } From ea3fdcb1ad70a4a6e14aa75831c72f671f8c3fad Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 02:49:35 +0000 Subject: [PATCH 2/6] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E6=8E=A8=E8=8D=90?= =?UTF-8?q?=EF=BC=9Awechatferry?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 47644c1..acb4bcb 100644 --- a/README.md +++ b/README.md @@ -177,3 +177,20 @@ wxhelper要求用户启动一个websoket服务接收数据，Puppet Bridge中已 ### v0.1.0 (2023-1-21) 初始化版本，适配 [cixingguangming55555/wechat-bot](https://github.com/cixingguangming55555/wechat-bot) 项目，支持v3.9.2.23版本 + +## 推荐 + +1. [wechatferry/wechatferry](https://github.com/wechatferry/wechatferry)项目完整的实现了[lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry)，并且作者制作了一个非常精美丰富的使用文档[https://wcferry.netlify.app/](https://wcferry.netlify.app/) + +```javascript +import { WechatferryPuppet } from '@wechatferry/puppet' +import { WechatyBuilder } from 'wechaty' + +const puppet = new WechatferryPuppet() +const bot = WechatyBuilder.build({ puppet }) + +bot.on('message', (msg) => { + msg.text() === 'ding' && msg.say('dong') +}) + .start() +``` From 8164a1712cea1a1a1b22df1fd15e7d1bdc9ebf7b Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 02:56:16 +0000 Subject: [PATCH 3/6] =?UTF-8?q?=E4=BC=98=E5=8C=96readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 118 +++++++----------------------------------------------- 1 file changed, 15 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index acb4bcb..0de4348 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,6 @@ wechaty-puppet-bridge 是一个全新的wechaty-puppet，它可以连接所有 > 最新功能清单查看[功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) -## 机器人支持 - -1. Wechat-bot 馈人玫瑰之手，历久犹有余香 [cixingguangming55555/wechat-bot](https://github.com/cixingguangming55555/wechat-bot) - -2. wxbot - 聊天机器人 [jwping/wxbot](https://github.com/jwping/wxbot) - -3. wxhelper - PC端微信逆向学习 [ttttupup/wxhelper](https://github.com/ttttupup/wxhelper) - -4. WeChatFerry - 一个玩微信的工具 [lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry) - -5. Gewechat - Gewechat🤖，个人微信免费开源框架 [Devo919/Gewechat](https://github.com/Devo919/Gewechat) - ## 快速开始 ### 使用[jwping/wxbot](https://github.com/jwping/wxbot) @@ -64,6 +52,18 @@ puppet-bridge 已经在NPM上发布了安装包，Wechaty用户可以直接安 npm i wechaty-puppet-bridge ``` +## 机器人支持 + +1. Wechat-bot 馈人玫瑰之手，历久犹有余香 [cixingguangming55555/wechat-bot](https://github.com/cixingguangming55555/wechat-bot) + +2. wxbot - 聊天机器人 [jwping/wxbot](https://github.com/jwping/wxbot) + +3. wxhelper - PC端微信逆向学习 [ttttupup/wxhelper](https://github.com/ttttupup/wxhelper) + +4. WeChatFerry - 一个玩微信的工具 [lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry) + +5. Gewechat - Gewechat🤖，个人微信免费开源框架 [Devo919/Gewechat](https://github.com/Devo919/Gewechat) + ## 更多示例代码 |源|WeChat版本|使用|安装| @@ -78,15 +78,9 @@ npm i wechaty-puppet-bridge ## API接口 -Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行修改，因此你依然可以使用底层bot的原生API进行开发，以下主要对wxhelper原生API进行说明 +Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行修改，因此你依然可以使用底层bot的原生API进行开发 -### HTTP API - -[3.9.9.43版本接口](https://github.com/ttttupup/wxhelper/blob/dev-3.9.10.19/doc/3.9.9.43.md)兼容3.9.10.19 - -### WEB HOOK - -wxhelper要求用户启动一个websoket服务接收数据，Puppet Bridge中已经启动了一个websoket服务并将从wxhelper接收到的数据转发给所有的客户端，你只需要连接该服务即可订阅消息推送，端口号保持wxhelper默认的19099 +[原生API使用说明](https://www.yuque.com/atorber/chatflow/wo5wzr75qdzs1t7p) ## 更新日志 @@ -94,89 +88,7 @@ wxhelper要求用户启动一个websoket服务接收数据，Puppet Bridge中已 - 支持lich0821/WeChatFerry -### v0.14.0 - -- 优化websoket服务为客户端模式，支持多端订阅 -- 保留wxhelper的原生API，其他编程语言可直接调用 -- 暂时移除[cixingguangming55555/wechat-bot](https://github.com/cixingguangming55555/wechat-bot)支持 - -### v0.12.0 - -- 增加wxhelper-3.9.10.19-v1.dll支持 - -### v0.11.0 - -- 增加wxhelper-3.9.2.23-v9.dll支持（部分接口暂未适配） - -### v0.10.4 - -- 修复wxbot无法发送图片bug - -### v0.10.3 - -- 修复注入文件路径错误问题 - -### v0.10.1 - -- 支持接收图片（注意当前的实现方式可能存在并发接收图片消息时接收不到或图片与消息不匹配的情况） - -### v0.10.0 - -- PuppetBridgeAtorberFusedV3090825支持[@all](https://www.yuque.com/atorber/chatflow/dnq7miho2gkfnmvk#l5ukp),使用方法room.say('Hi~', ...[SelfContact]) -- PuppetBridgeAtorberFusedV3090825支持[发送多个不同的@消息](https://www.yuque.com/atorber/chatflow/dnq7miho2gkfnmvk#keK3C)，使用方法room.say('{"chatRoomId":"xxxx","at":[{"wxid":"wxid_xxx","msg":"@xxx"}]}') - -### v0.9.0 - -- 修复npm包无法找到注入工具的问题 - -### v0.8.10 - -- 增加contactPayloadDirty更新联系人缓存 - -### v0.8.9 - -- 修复部分群成员查询失败导致无法出发登录事件的问题 - -### v0.8.8 - -- 修复__dirname重复定义的问题 - -### v0.8.7 - -- wxhelper类抽离，支持指定httpUrl -- fused类抽离，支持指定httpUrl - -### v0.8.2 - -- 优化注入逻辑，当设置了httpUrl时，不自动注入，默认为已完成手动注入 -- 当http服务已存在时不重复注入 - -### v0.7.0 - -- 升级atorber-fused仅需要[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper)启动 -- 拓展[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper)使用32.获取数据库句柄拓展支持： - - 47.获取群详情 - - 25.获取群成员 - - 60.获取群/群成员详情 -- 支持自动注入及自动登录 - -### v0.6.1 - -- 新增atorber-fused融合brisge，集合[jwping/wxbot](https://github.com/jwping/wxbot)和 [ttttupup/wxhelper](https://github.com/ttttupup/wxhelper)两个项目的3.9.8.25版本的功能合集 -- 支持自动注入及自动登录 - -### v0.6.0 - -- 适配 [ttttupup/wxhelper](https://github.com/ttttupup/wxhelper),支持v3.9.5.81版本，功能最全的免费机器人 -- 自动注入 - -### v0.4.0 (2023-2-1) - -适配 [jwping/wxbot](https://github.com/jwping/wxbot) 项目，支持v3.9.8.25版本 - -### v0.1.0 (2023-1-21) - -初始化版本，适配 [cixingguangming55555/wechat-bot](https://github.com/cixingguangming55555/wechat-bot) 项目，支持v3.9.2.23版本 +[更多版本记录详见](https://www.yuque.com/atorber/chatflow/hyy64kf0a0iguy68) ## 推荐 From 7bad168bd038ff005f4200e1f7939962b406f89d Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 03:09:00 +0000 Subject: [PATCH 4/6] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0de4348..e9dbded 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,6 @@ wechaty-puppet-bridge 是一个虚拟的Wechaty Puppet，实际上它只是一 获取更多信息[访问项目语雀文档](https://www.yuque.com/atorber/chatflow/mean34ibdoonvox4) -## 功能清单 - -wechaty-puppet-bridge 是一个全新的wechaty-puppet，它可以连接所有的通过ws、http、mqtt开放IM访问的聊天机器人. - -> 最新功能清单查看[功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) - ## 快速开始 ### 使用[jwping/wxbot](https://github.com/jwping/wxbot) @@ -64,6 +58,12 @@ npm i wechaty-puppet-bridge 5. Gewechat - Gewechat🤖，个人微信免费开源框架 [Devo919/Gewechat](https://github.com/Devo919/Gewechat) +## 功能清单 + +wechaty-puppet-bridge 是一个全新的wechaty-puppet，它可以连接所有的通过ws、http、mqtt开放IM访问的聊天机器人. + +> 最新功能清单查看[功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) + ## 更多示例代码 |源|WeChat版本|使用|安装| From 0a03ccb2704366cd84bb5c2305e55e29cececc85 Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 03:09:09 +0000 Subject: [PATCH 5/6] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 48 ++++++++++++------------------------------------ 1 file changed, 12 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index e9dbded..063d3b9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![NPM Version](https://img.shields.io/npm/v/wechaty-puppet-bridge?color=brightgreen)](https://www.npmjs.com/package/wechaty-puppet-bridge) [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-bridge/next.svg)](https://www.npmjs.com/package/wechaty-puppet-bridge?activeTab=versions) ![npm downloads](https://img.shields.io/npm/dm/wechaty-puppet-bridge.svg) -chatie puppet bridge + ## 简介 @@ -12,31 +12,19 @@ wechaty-puppet-bridge 是一个虚拟的Wechaty Puppet，实际上它只是一 如果你想方便且高效的使用免费的机器人，那么它是一个很好的选择，它不需要token同时又能使用Wechaty进行聊天机器人开发 -获取更多信息[访问项目语雀文档](https://www.yuque.com/atorber/chatflow/mean34ibdoonvox4) +> 获取更多信息[项目文档](https://www.yuque.com/atorber/chatflow/mean34ibdoonvox4) -## 快速开始 +## 示例代码 -### 使用[jwping/wxbot](https://github.com/jwping/wxbot) - -1. 在您的Windows电脑上安装客户端（需要版本v3.9.8.25,下载[v3.9.8.25](https://github.com/tom-snow/wechat-windows-versions/releases/tag/v3.9.8.25)） - -2. 在电脑上登录客户端 - -3. 运行以下指令启动程序 - -```sh -git clone https://github.com/atorber/puppet-bridg -cd puppet-bridge - -# 安装依赖 -npm install - -# 启动程序 -npm run start:ripe-bridge-jwping-wxbot:info -# -# Do not forget to install WeChat with requried version and login. -# -``` +|源|WeChat版本|使用|安装| +|--|--|--|--| +|[Devo919/Gewechat](https://github.com/Devo919/Gewechat)|iPad协议|[示例代码](./examples/ripe-wechaty-Devo919-Gewechat.ts) |npm i wechaty-puppet-bridge@0.16.0| +|[lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry)|v3.9.10.27|[示例代码](./examples/ripe-wechaty-lich0821-WeChatFerry-3091027.ts) |npm i wechaty-puppet-bridge@0.15.0| +|[jwping/wxbot](https://github.com/jwping/wxbot)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-jwping-wxbot-3090825.ts)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.2.23)|v3.9.2.23|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090223.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.5.81)|v3.9.5.81|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090581.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.8.25)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-atorber-fused-3090825.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.10.19)|v3.9.10.19|[示例代码](./examples/ripe-bridge-ttttupup-wxhelper-3091019.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| ## 使用NPM包 @@ -64,18 +52,6 @@ wechaty-puppet-bridge 是一个全新的wechaty-puppet，它可以连接所有 > 最新功能清单查看[功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) -## 更多示例代码 - -|源|WeChat版本|使用|安装| -|--|--|--|--| -|[Devo919/Gewechat](https://github.com/Devo919/Gewechat)|iPad协议|[示例代码](./examples/ripe-wechaty-Devo919-Gewechat.ts) |npm i wechaty-puppet-bridge@0.16.0| -|[lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry)|v3.9.10.27|[示例代码](./examples/ripe-wechaty-lich0821-WeChatFerry-3091027.ts) |npm i wechaty-puppet-bridge@0.15.0| -|[jwping/wxbot](https://github.com/jwping/wxbot)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-jwping-wxbot-3090825.ts)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.2.23)|v3.9.2.23|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090223.ts) (需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.5.81)|v3.9.5.81|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090581.ts) (需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.8.25)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-atorber-fused-3090825.ts) (需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.10.19)|v3.9.10.19|[示例代码](./examples/ripe-bridge-ttttupup-wxhelper-3091019.ts) (需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| - ## API接口 Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行修改，因此你依然可以使用底层bot的原生API进行开发 From bea5b6801ac2077038f50f7476820bc5273b23a5 Mon Sep 17 00:00:00 2001 From: atorber Date: Mon, 4 Nov 2024 04:12:56 +0000 Subject: [PATCH 6/6] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 063d3b9..b325145 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Wechaty Puppet Bridge +# Puppet Bridge GitHub stars badge GitHub forks badge [![NPM](https://github.com/atorber/puppet-bridge/workflows/NPM/badge.svg)](https://github.com/atorber/puppet-bridge/actions?query=workflow%3ANPM) [![NPM Version](https://img.shields.io/npm/v/wechaty-puppet-bridge?color=brightgreen)](https://www.npmjs.com/package/wechaty-puppet-bridge) @@ -8,30 +8,30 @@ ## 简介 -wechaty-puppet-bridge 是一个虚拟的Wechaty Puppet，实际上它只是一个桥接服务，它将GitHub中开源的机器人桥接到Wechaty，是开源IM bot搬运工 +puppet-bridge 是一个虚拟的第三方Wechaty Puppet，实际上它只是一个桥接服务，它将GitHub中开源的机器人桥接到Wechaty，是开源IM bot搬运工 -如果你想方便且高效的使用免费的机器人，那么它是一个很好的选择，它不需要token同时又能使用Wechaty进行聊天机器人开发 +如果你想方便且高效的使用免费的机器人，那么它是一个很好的选择，它不需要token同时又能使用Wechaty进行聊天机器人开发。 -> 获取更多信息[项目文档](https://www.yuque.com/atorber/chatflow/mean34ibdoonvox4) +获取更多信息 [项目文档](https://www.yuque.com/atorber/chatflow/mean34ibdoonvox4) ## 示例代码 -|源|WeChat版本|使用|安装| +|源项目|WeChat|实例代码|安装| |--|--|--|--| |[Devo919/Gewechat](https://github.com/Devo919/Gewechat)|iPad协议|[示例代码](./examples/ripe-wechaty-Devo919-Gewechat.ts) |npm i wechaty-puppet-bridge@0.16.0| |[lich0821/WeChatFerry](https://github.com/lich0821/WeChatFerry)|v3.9.10.27|[示例代码](./examples/ripe-wechaty-lich0821-WeChatFerry-3091027.ts) |npm i wechaty-puppet-bridge@0.15.0| |[jwping/wxbot](https://github.com/jwping/wxbot)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-jwping-wxbot-3090825.ts)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.2.23)|v3.9.2.23|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090223.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.5.81)|v3.9.5.81|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090581.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.8.25)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-atorber-fused-3090825.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| -|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.10.19)|v3.9.10.19|[示例代码](./examples/ripe-bridge-ttttupup-wxhelper-3091019.ts)
(需要【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.2.23)|v3.9.2.23|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090223.ts)
(【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.5.81)|v3.9.5.81|[示例代码](./examples/ripe-wechaty-ttttupup-wxhelper-3090581.ts)
(【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.8.25)|v3.9.8.25|[示例代码](./examples/ripe-wechaty-atorber-fused-3090825.ts)
(【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| +|[ttttupup/wxhelper](https://github.com/ttttupup/wxhelper/tree/dev-3.9.10.19)|v3.9.10.19|[示例代码](./examples/ripe-bridge-ttttupup-wxhelper-3091019.ts)
(【以管理员身份运行】WeChat客户端)|npm i wechaty-puppet-bridge@0.15.0| ## 使用NPM包 -puppet-bridge 已经在NPM上发布了安装包，Wechaty用户可以直接安装使用 +puppet-bridge 已经在[npmjs.com](https://www.npmjs.com/package/wechaty-puppet-bridge)上发布了安装包，Wechaty用户可以直接安装使用 ```shell -npm i wechaty-puppet-bridge +npm i wechaty-puppet-bridge@0.16.0 ``` ## 机器人支持 @@ -48,15 +48,11 @@ npm i wechaty-puppet-bridge ## 功能清单 -wechaty-puppet-bridge 是一个全新的wechaty-puppet，它可以连接所有的通过ws、http、mqtt开放IM访问的聊天机器人. - -> 最新功能清单查看[功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) +puppet-bridge可以连接所有的通过ws、http、mqtt开放IM访问的聊天机器人。最新功能清单查看 [功能清单](https://www.yuque.com/atorber/chatflow/imovlh1l8ypxmd9n#eTg6) ## API接口 -Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行修改，因此你依然可以使用底层bot的原生API进行开发 - -[原生API使用说明](https://www.yuque.com/atorber/chatflow/wo5wzr75qdzs1t7p) +Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行修改，因此你依然可以使用底层bot的原生API进行开发 [原生API使用说明](https://www.yuque.com/atorber/chatflow/wo5wzr75qdzs1t7p) ## 更新日志 @@ -64,7 +60,7 @@ Puppet Bridge是对开源bot项目的API封装，并不会对原生的API进行 - 支持lich0821/WeChatFerry -[更多版本记录详见](https://www.yuque.com/atorber/chatflow/hyy64kf0a0iguy68) +[查看更多版本记录](https://www.yuque.com/atorber/chatflow/hyy64kf0a0iguy68) ## 推荐