Wechaty Puppet XP
Official website: https://wechaty.js.org/docs/puppet-providers/xp
WECHATY PUPPET YOUTH STAR
wechaty-puppet-xp is a local puppet for Wechaty:
- If you are a user of Windows,You can use this puppet to implement your chatbot.
- It's a completely free service and doesn't need token.
GETTING STARTED
- STEP 1: Install wechat client in your Windows computer.
- STEP 2: Login the wechat client on the computer.
- STEP 3: Getting Started with TypeScript/JavaScript (RECOMMENDED).
QUICK START
1.12.0+ is the latest version, only support WeChat v3.6.0.18, 1.11.14 is the last version base WeChat v3.3.0.115. Note to use the npm package that matches the WeChat version.
git clone https://github.com/wechaty/wechaty-puppet-xp.git
cd wechaty-puppet-xp
npm install
#
# Do not forget to install WeChat with requried version and login.
#| Run | Source code | Description |
|---|---|---|
npm start |
examples/ding-dong-bot.ts | Puppet ding/dong |
npm run start:ripe |
examples/ripe-wechaty.ts | Wechaty ding/dong |
npm run start:raw |
examples/raw-sidecar.ts | Sidecar ding/dong |
PUPPET COMPARISON
XP is a young puppet,it keeps growing and improving.
| Puppet | xp👍 |
|---|---|
| 支持账号 | 个人微信 |
| <消息> | |
| 接收文本 | ✅ |
| 接收图片 | ✅ |
| 接收文件 | ✅ |
| 接收动图 | ✅ |
| 接收表情 | ✅ |
| 接收小程序卡片 | ✅ |
| 接收联系人卡片 | ✅ |
| 接收位置卡片 | ✅ |
| 发送文本 | ✅ |
| 发送图片 | ✅ |
| 发送文件 | ✅ |
| 发送动图 | ✅（以文件形式发送） |
| <群组> | |
| @群成员 | ✅ |
| 群列表 | ✅ |
| 群成员列表 | ✅ |
| 群详情 | ✅ |
| 进群提示 | ✅ |
| <联系人> | |
| 好友列表 | ✅ |
| 好友详情 | ✅ |
| <其他> | |
| 登录事件 | ✅ |
| 依赖协议 | Windows |
HISTORY
main v1.12.0 (November 22, 2022)
- This version start to support WeChat v3.6.0.18,need to update WeChat on your pc to 3.6.0.18
- WeChatSetup-v3.6.0.18.exe
v1.11.14
the last version base WeChat 3.3.0.115, next version will support WeChat 3.6.0.18
v1.0
wechaty 1.xx support
v0.5
- ES Module support
- WeChatSetup-v3.3.0.115.exe
v0.4.7 (Aug 15, 2021)
- Support send files.
- Support forward text message.
v0.4.2 (Aug 10, 2021)
Support room.say(text, ...mentionList), you can at RoomMember.
v0.4 (Aug 9, 2021)
- Added some support for classes Contact and Room
- Support bot.Contact.findAll()/bot.Contact.find(query)
- Support bot.Room.findAll()/bot.Room.find(query)
v0.2 (July 23, 2021)
- Code clean
- Fix all unit tests
- Run unit testings under Windows
- Deploy to NPM with GitHub actions
- examples/ding-dong-bot.ts works on Windows!
- examples/raw-sidecar.ts works on Windows!
- wechaty-getting-started supports
WECHATY_PUPPET=wechaty-puppet-xpnow.
v0.0.1 (July 19, 2021)
Initial version: https://wechaty.js.org/docs/puppet-providers/xp
Blogs:
- 喜讯：使用Windows微信桌面版协议登录，wechaty免费版协议即将登场, @atorber, Jul 05, 2021
- 全新的Windows puppet项目wechaty-puppet-xp启动, @atorber, Jul 13, 2021
- code如诗，bot如歌，由Wechaty引发的一个小白冒险之旅, @老张学技术, Jul 05, 2021
Author
- Hua ZHANG @cixingguangming55555
- Yuchao LU @atorber
Copyright & License
- Code & Docs © 2021 Wechaty Contributors
- Code released under the Apache-2.0 License
- Docs released under Creative Commons