atorber / puppet-bridge

wehcat bot base Wechaty,3.9.10.19/3.9.8.25/3.9.2.23/3.9.5.81
Apache License 2.0
40 stars 10 forks source link

Wechaty Puppet Bridge

GitHub stars badge GitHub forks badge NPM NPM Version npm (tag) npm downloads

chatie puppet bridge

简介

wechaty-puppet-bridge 是一个虚拟的Wechaty Puppet,实际上它只是一个桥接服务,它将GitHub中开源的机器人桥接到Wechaty,是开源IM bot搬运工

如果你想方便且高效的使用免费的机器人,那么它是一个很好的选择,它不需要token同时又能使用Wechaty进行聊天机器人开发

获取更多信息访问项目语雀文档

功能清单

wechaty-puppet-bridge 是一个全新的wechaty-puppet,它可以连接所有的通过ws、http、mqtt开放IM访问的聊天机器人.

最新功能清单查看功能清单

功能清单

机器人支持

  1. Wechat-bot 馈人玫瑰之手,历久犹有余香 cixingguangming55555/wechat-bot

  2. wxbot - 聊天机器人 jwping/wxbot

  3. wxhelper - PC端微信逆向学习 ttttupup/wxhelper

快速开始

使用jwping/wxbot

  1. 在您的Windows电脑上安装客户端(需要版本v3.9.8.25,下载v3.9.8.25

  2. 在电脑上登录客户端

  3. 运行以下指令启动程序

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.
#

使用NPM包

puppet-bridge 已经在NPM上发布了安装包,Wechaty用户可以直接安装使用

npm i wechaty-puppet-bridge

更多示例代码

版本 使用
jwping/wxbot v3.9.8.25 示例代码
ttttupup/wxhelper v3.9.2.23 示例代码 (需要【以管理员身份运行】WeChat客户端)
ttttupup/wxhelper v3.9.5.81 示例代码 (需要【以管理员身份运行】WeChat客户端)
ttttupup/wxhelper v3.9.8.25 示例代码 (需要【以管理员身份运行】WeChat客户端)
ttttupup/wxhelper v3.9.10.19 示例代码 (需要【以管理员身份运行】WeChat客户端)

API接口

Puppet Bridge是对开源bot项目的API封装,并不会对原生的API进行修改,因此你依然可以使用底层bot的原生API进行开发,以下主要对wxhelper原生API进行说明

HTTP API

3.9.9.43版本接口兼容3.9.10.19

WEB HOOK

wxhelper要求用户启动一个websoket服务接收数据,Puppet Bridge中已经启动了一个websoket服务并将从wxhelper接收到的数据转发给所有的客户端,你只需要连接该服务即可订阅消息推送,端口号保持wxhelper默认的19099

更新日志

v0.14.0

v0.12.0

v0.11.0

v0.10.4

v0.10.3

v0.10.1

v0.10.0

v0.9.0

v0.8.10

v0.8.9

v0.8.8

v0.8.7

v0.8.2

v0.7.0

v0.6.1

v0.6.0

v0.4.0 (2023-2-1)

适配 jwping/wxbot 项目,支持v3.9.8.25版本

v0.1.0 (2023-1-21)

初始化版本,适配 cixingguangming55555/wechat-bot 项目,支持v3.9.2.23版本