WECHATY-PUPPET-PADPLUS

Notice

Our Mission: Make it easy to build a WeChat Chatbot for developers.

We provide a free token for the developers who have a strong will and ability to build a valuable chatbot for users.

Any developers can send info following the template to dev@juzi.bot

See more: https://github.com/wechaty/wechaty/wiki/Support-Developers

Install

1. Init

check your Node version first

node --version // v10.16.0 (BTW v10.0.0 < version < v11.0.0 is better)

mkdir my-padplus-bot && cd my-padplus-bot

npm init -y

2. Install the latest wechaty

npm install wechaty@next

3. Install wechaty-puppet-padplus

Notice: wechaty-puppet-padplus still in alpha test period, so we keep updating the package, you should install the latest packge by using @latest until we release the stable package.

npm install wechaty-puppet-padplus@latest

4. Install other dependency

There's no need to install wechaty-puppet in my-padplus-bot

npm install qrcode-terminal

5. Re-Install all related package

If step 1~4 can not help you install successfully, please try this suggestion, otherwise just skip it please.

rm -rf node_modules package-lock.json
npm install

Example

import { Wechaty       } from 'wechaty'
import { PuppetPadplus } from 'wechaty-puppet-padplus'
import { generate      } from 'qrcode-terminal'

const token = 'your-token'

const puppet = new PuppetPadplus({
  token,
})

const name  = 'your-bot-name'

const bot = new Wechaty({
  puppet,
  name, // generate xxxx.memory-card.json and save login data for the next login
})

bot
  .on('scan', (qrcode) => {
    generate(qrcode, {
      small: true
    })
  })
  .on('message', msg => {
    console.log(`msg : ${msg}`)
  })
  .start()

Puppet Comparision

功能	padpro	padplus	macpro
<消息>
收发文本	✅	✅	✅
收发个人名片	✅	✅	✅
收发图文链接	✅	✅	✅
发送图片、文件	✅	✅（对内容有大小限制，20M以下）	✅
接收图片、文件	✅	✅（对内容有大小限制，25M以下）	✅
发送视频	✅	✅（视频以链接形式发送）	✅
接收视频	✅	✅	✅
发送小程序	❌	❌	✅
接收动图	❌	✅	✅
发送动图	❌	✅	✅
接收语音消息	✅	✅	✅
发送语音消息	✅	❌	❌
转发文本	✅	✅	✅
转发图片	✅	✅	✅
转发图文链接	✅	✅	✅
转发音频	✅	❌	✅
转发视频	✅	✅	✅
转发文件	✅	✅	✅
转发动图	❌	❌	❌
转发小程序	❌	❌	❌
<群组>
创建群聊	✅	✅	✅
设置群公告	✅	✅	✅
获取群公告	❌	✅	❌
群二维码	✅	✅	✅
拉人进群	✅	✅	✅
踢人出群	✅	✅	✅
退出群聊	✅	✅	✅
改群名称	✅	✅	✅
入群事件	✅	✅	✅
离群事件	✅	✅	✅
群名称变更事件	✅	✅	✅
@群成员	✅	✅	✅
群列表	✅	✅	✅
群成员列表	✅	✅	✅
群详情	✅	✅	✅
<联系人>
修改备注	✅	✅	✅
添加好友	✅	✅	✅
自动通过好友	✅	✅	❌
添加好友	✅	✅	✅
好友列表	✅	✅	✅
好友详情	✅	✅	✅
<其他>
登录微信	✅	✅	✅
扫码状态	✅	✅	❌
退出微信	✅	❌	✅
依赖协议	iPad	iPad	Mac

graphbuster/wechaty-puppet-padplus