- Official website: https://wechaty.js.org/docs/puppet-providers/xp
- Join XP Discord: https://discord.gg/uE8Tb77VBm
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.
- STEP 1: Install wechat client in your Windows computer.
1.13.0+ is the latest version, only support WeChat v3.9.2.23. Note to use the npm package that matches the WeChat version.
- STEP 2: Login the wechat client on the computer.
- STEP 3: Getting Started with TypeScript/JavaScript (RECOMMENDED).
git clone https://github.com/wechaty/wechaty-puppet-xp.git
cd wechaty-puppet-xp
# 安装依赖
npm install
# 启动程序
npm start
#
# 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-xp also have already released the installation package on NPM. Running with NPM and more examples can be referred to wechaty-puppet-xp-getting-started.
XP is a young puppet,it keeps growing and improving.
版本 | 3.3.0.115 | 3.6.0.18 | 3.9.2.23 |
---|---|---|---|
<消息> | |||
接收文本 | ✅ | ✅ | ✅ |
接收图片 | ✅ | ✅ | ✅ |
接收文件 | ✅ | ✅ | ✅ |
接收动图 | ✅ | ✅ | ✅ |
接收表情 | ✅ | ✅ | ✅ |
接收小程序卡片 | ✅ | ✅ | ✅ |
接收联系人卡片 | ✅ | ✅ | ✅ |
接收位置卡片 | ✅ | ✅ | ✅ |
发送文本 | ✅ | ✅ | ✅ |
发送图片 | ✅ | ✅ | ✅ |
发送文件 | ✅ | ✅ | ✅ |
发送动图 | ✅ | ✅ | ✅ |
<群组> | |||
@群成员 | ✅ | ✅ | ✅ |
群列表 | ✅ | ✅ | ✅ |
群成员列表 | ✅ | ✅ | ✅ |
群详情 | ✅ | ✅ | ✅ |
进群提示 | ✅ | ✅ | ✅ |
<联系人> | |||
好友列表 | ✅ | ✅ | ✅ |
好友详情 | ✅ | ✅ | ✅ |
<其他> | |||
登录事件 | ✅ | ✅ | ✅ |
扫码登录 | ✅ |
Note: You need to install an NPM version that matches your WeChat client version.
puppet-xp | npm install | |
---|---|---|
1.3.x | WeChat-v3.9.2.23 | npm i wechaty-puppet-xp@next |
1.12.7 | WeChat-v3.6.0.18 | npm i [email protected] |
1.11.14 | WeChat-v3.3.0.115 | npm i [email protected] |
- Fixed the bug where the system crashes upon receiving a message before successful startup
- Add setting for contact remark
- Optimize sample code
- This version start to support WeChat v3.9.2.23,need to update WeChat on your pc to 3.9.2.23
- WeChatSetup-v3.9.2.23.exe
- 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
the last version base WeChat 3.3.0.115, next version will support WeChat 3.6.0.18
wechaty 1.xx support
- ES Module support
- WeChatSetup-v3.3.0.115.exe
- Support send files.
- Support forward text message.
Support room.say(text, ...mentionList), you can at RoomMember.
- Added some support for classes Contact and Room
- Support bot.Contact.findAll()/bot.Contact.find(query)
- Support bot.Room.findAll()/bot.Room.find(query)
- 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-xp
now.
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
- Hua ZHANG @cixingguangming55555
- Yuchao LU @atorber
- Code & Docs © 2021 Wechaty Contributors
- Code released under the Apache-2.0 License
- Docs released under Creative Commons