Skip to content

Latest commit

 

History

History
264 lines (191 loc) · 7.11 KB

readme.md

File metadata and controls

264 lines (191 loc) · 7.11 KB
Raw

THIS REPO HAS BEEN DEPRECATED

Learn more about Wechaty Puppet Services from https://wechaty.js.org/docs/puppet-services

You can use Wechaty with other puppet services like WXWork, Rock, PadLocal, etc as well.

通知 (Nov, 2020)

亲爱的开发者，您好！

为了更好的提供服务，JuziBot Puppet Service 计划于11月30日进行一次 wechaty-puppet-padplus 重大升级。

如您正在使用 wechaty-puppet-padplus服务, 则需要进行如下升级操作。（如未使用 wechaty-puppet-padplus,可安全的忽视本通知）

wechaty-puppet-padplus 升级说明如下:

  1. 卸载 wechaty-puppet-padplus, 安装 wechaty-puppet-hostie
  2. 代码中启动wechaty的 wechaty-puppet-padplus 更换成 wechaty-puppet-hostie

详细说明： wechaty-puppet-padplus 将会在11月30日下线，已付费的用户可以升级到下面的两个puppet:

  1. wechaty-puppet-donut: 基于 windows 的个人微信，除了 padplus 的基础功能外，还支持接受企业微信消息，详细信息见 https://github.com/juzibot/donut-tester
  2. wechaty-puppet-wxwork: 基于 windows 客户端的企业微信，详细信息见 https://github.com/juzibot/wxwork-tester

如在11月30日前没有升级代码库，wechaty-puppet-padplus 服务将会在12月1日00:00停止服务，导致您托管的微信不可用，所以强烈建议提前进行代码升级，以避免机器人意外终止服务。

如果您有任何问题，请及时与我们的客服联系，微信：juzibot

详情见：https://github.com/wechaty/puppet-service-providers/issues/11

WECHATY-PUPPET-PADPLUS

Powered by Wechaty NPM Version npm (tag) TypeScript Linux/Mac Build Status

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.

See more: Token Support, Everything about wechaty

Install

1. Init

1.1. Check your Node version first

node --version // v10.16.0

for windows system

To make sure you could install wechaty-puppet-padplus successfully, you have to start PowerShell as Administrator and run these commands:

npm install -g windows-build-tools

npm install -g node-gyp

1.2. Create your bot folder and do some init config

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

npm init -y

npm install ts-node typescript -g

tsc --init --target ES6

touch bot.ts // copy the example code to it

2. Install Wechaty Dependencies

npm install wechaty@latest

npm install wechaty-puppet-padplus@latest

Or some new features developing version:

npm install wechaty@next

npm install wechaty-puppet-padplus@next

3. Install Other Dependencies

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

npm install qrcode-terminal
...

4. Run

If you want to see detail logs about your bot, just run:

BROLOG_LEVEL=silly ts-node bot.ts

or

BROLOG_LEVEL=silly node bot.js

5. Cache Option

wechaty-puppet-padplus use flash-store or mongo as cache store

  • flash-store[default]
  • mongo

If you want to use mongo as cache sotre, just set the cacheOption, like this:

const puppet: Puppet = new PuppetPadplus({
  token,
  cacheOption: {
    type: 'mongo',
    url: 'mongodb://127.0.0.1:27017/testdb',
  },
})

Caution

When you use mongo as cache store, wechaty-puppet-cache use some tables which have wechaty-cache prefix. detail>>

6. Other Tips

Set environment in windows

$Env:BROLOG_LEVEL='silly'
ts-node bot.ts

If step 1~3 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

// bot.ts
import { Contact, Message, Wechaty } from 'wechaty'
import { ScanStatus } from 'wechaty-puppet'
import { PuppetPadplus } from 'wechaty-puppet-padplus'
import QrcodeTerminal 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, status) => {
    if (status === ScanStatus.Waiting) {
      QrcodeTerminal.generate(qrcode, {
        small: true
      })
    }
  })
  .on('login', (user: Contact) => {
    console.log(`login success, user: ${user}`)
  })
  .on('message', (msg: Message) => {
    console.log(`msg : ${msg}`)
  })
  .on('logout', (user: Contact, reason: string) => {
    console.log(`logout user: ${user}, reason : ${reason}`)
  })
  .start()

How to emit the message that you sent

Please use environment variable PADPLUS_REPLAY_MESSAGE to activate this function.

PADPLUS_REPLAY_MESSAGE=true node bot.js

Puppet Comparison

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