149 lines
5.5 KiB
Markdown
149 lines
5.5 KiB
Markdown
# Wechaty Puppet XP
|
||
|
||
[](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM)
|
||
[](https://www.npmjs.com/package/wechaty-puppet-xp)
|
||
[](https://www.npmjs.com/package/wechaty-puppet-xp?activeTab=versions)
|
||
[](https://github.com/Chatie/tsconfig/issues/16)
|
||
|
||
[](https://github.com/wechaty/wechaty)
|
||
[](https://github.com/huan/sidecar)
|
||
[](https://www.typescriptlang.org/)
|
||
[](https://www.npmjs.com/package/wechaty)
|
||
[](https://github.com/wechaty/wechaty)
|
||
[](https://gitter.im/wechaty/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
|
||
<img src="https://camo.githubusercontent.com/6c7c7e10053c8e1936c084d17ea74c3437759fd1c4d3e02acca9256e2bfe9bb3/68747470733a2f2f692e6c6f6c692e6e65742f323032302f30352f30392f4858436c49663541324570554734752e706e67" alt="chatie puppet xp" width="300" height="300" align="bottom" />
|
||
|
||
Official website: <https://wechaty.js.org/docs/puppet-providers/xp>
|
||
|
||
## WECHATY PUPPET YOUTH STAR
|
||
|
||
wechaty-puppet-xp is a local puppet for Wechaty:
|
||
|
||
1. If you are a user of Windows,You can use this puppet to implement your chatbot.
|
||
1. 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.
|
||
|
||
```sh
|
||
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](examples/ding-dong-bot.ts) | Puppet ding/dong |
|
||
| `npm run start:ripe` | [examples/ripe-wechaty.ts](examples/ripe-wechaty.ts) | Wechaty ding/dong |
|
||
| `npm run start:raw` | [examples/raw-sidecar.ts](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)
|
||
|
||
1. This version start to support WeChat v3.6.0.18,need to update WeChat on your pc to 3.6.0.18
|
||
2. [WeChatSetup-v3.6.0.18.exe](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.6.0.18/WeChatSetup-3.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
|
||
|
||
1. ES Module support
|
||
2. [WeChatSetup-v3.3.0.115.exe](https://github.com/wechaty/wechaty-puppet-xp/releases/download/v0.5/WeChatSetup-v3.3.0.115.exe)
|
||
|
||
### v0.4.7 (Aug 15, 2021)
|
||
|
||
1. Support send files.
|
||
2. Support forward text message.
|
||
|
||
### v0.4.2 (Aug 10, 2021)
|
||
|
||
Support room.say(text, ...mentionList), you can at RoomMember.
|
||
|
||
### v0.4 (Aug 9, 2021)
|
||
|
||
1. Added some support for classes Contact and Room
|
||
1. Support bot.Contact.findAll()/bot.Contact.find(query)
|
||
1. Support bot.Room.findAll()/bot.Room.find(query)
|
||
|
||
### v0.2 (July 23, 2021)
|
||
|
||
1. Code clean
|
||
1. Fix all unit tests
|
||
1. Run unit testings under Windows
|
||
1. Deploy to NPM with GitHub actions
|
||
1. [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts) works on Windows!
|
||
1. [examples/raw-sidecar.ts](examples/raw-sidecar.ts) works on Windows!
|
||
1. [wechaty-getting-started](https://github.com/wechaty/wechaty-getting-started) supports `WECHATY_PUPPET=wechaty-puppet-xp` now.
|
||
|
||
### v0.0.1 (July 19, 2021)
|
||
|
||
Initial version: <https://wechaty.js.org/docs/puppet-providers/xp>
|
||
|
||
Blogs:
|
||
|
||
- [喜讯：使用Windows微信桌面版协议登录，wechaty免费版协议即将登场, @atorber, Jul 05, 2021](https://wechaty.js.org/2021/07/05/puppet-laozhang-wechat-bot/)
|
||
- [全新的Windows puppet项目wechaty-puppet-xp启动, @atorber, Jul 13, 2021](https://wechaty.js.org/2021/07/13/wechaty-puppet-xp-start-up/)
|
||
- [code如诗，bot如歌，由Wechaty引发的一个小白冒险之旅, @老张学技术, Jul 05, 2021](https://wechaty.js.org/2021/07/05/code-like-poetry-bot-like-song/)
|
||
|
||
## Author
|
||
|
||
1. Hua ZHANG [@cixingguangming55555](https://github.com/cixingguangming55555)
|
||
2. Yuchao LU [@atorber](https://github.com/atorber)
|
||
|
||
## Copyright & License
|
||
|
||
- Code & Docs © 2021 Wechaty Contributors
|
||
- Code released under the Apache-2.0 License
|
||
- Docs released under Creative Commons
|