Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wechaty/wechaty-puppet-padplus

DEPRECATED: One puppet based on iPad protocal for Wechaty
https://github.com/wechaty/wechaty-puppet-padplus

chatbot wechaty wechaty-puppet

Last synced: 4 days ago
JSON representation

DEPRECATED: One puppet based on iPad protocal for Wechaty

Host: GitHub
URL: https://github.com/wechaty/wechaty-puppet-padplus
Owner: wechaty
Created: 2019-09-06T12:29:15.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-07-05T02:52:15.000Z (over 1 year ago)
Last Synced: 2024-05-13T12:04:42.013Z (8 months ago)
Topics: chatbot, wechaty, wechaty-puppet
Language: TypeScript
Homepage: https://wechaty.js.org/docs/puppet-services/
Size: 1.06 MB
Stars: 309
Watchers: 16
Forks: 64
Open Issues: 47
Metadata Files:
- Readme: readme.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # THIS REPO HAS BEEN DEPRECATED

Learn more about Wechaty Puppet Services from 

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](https://img.shields.io/badge/Powered%20By-Wechaty-blue.svg)](https://github.com/chatie/wechaty)

[![NPM Version](https://badge.fury.io/js/wechaty-puppet-padplus.svg)](https://www.npmjs.com/package/wechaty-puppet-padplus)

[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-padplus/next.svg)](https://www.npmjs.com/package/wechaty-puppet-padplus?activeTab=versions)

[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)

[![Linux/Mac Build Status](https://travis-ci.com/wechaty/wechaty-puppet-padplus.svg?branch=master)](https://travis-ci.com/wechaty/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.

See more: [Token Support](https://github.com/juzibot/Welcome/wiki/Support-Developers), [Everything about wechaty](https://github.com/juzibot/Welcome/wiki/Everything-about-Wechaty)

## Install

### 1. Init

#### 1.1. Check your `Node` version first

```shell

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:

```shell

npm install -g windows-build-tools

npm install -g node-gyp

```

#### 1.2. Create your bot folder and do some init config

```shell

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

```shell

npm install wechaty@latest

npm install wechaty-puppet-padplus@latest

```

Or some new features developing version:

```shell

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

```shell

npm install qrcode-terminal

...

```

### 4. Run

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

```shell

BROLOG_LEVEL=silly ts-node bot.ts

```

or

```shell

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:

```ts

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>>](https://www.npmjs.com/package/wechaty-puppet-cache#4-caution)*

### 6. Other Tips

> Set environment in windows

```shell

$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.

```shell

rm -rf node_modules package-lock.json

npm install

```

## Example

```ts

// 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.

```shell

PADPLUS_REPLAY_MESSAGE=true node bot.js

```

## Puppet Comparison

功能 | padpro | padplus | macpro

---|---|---|---

 **<消息>**|  |  |

 收发文本| ✅ |✅ |✅

 收发个人名片| ✅ |✅ |✅

 收发图文链接| ✅ |✅ |✅

 发送图片、文件| ✅ | ✅（对内容有大小限制，20M以下） |✅

 接收图片、文件| ✅ | ✅（对内容有大小限制，25M以下） |✅

 发送视频| ✅ | ✅ | ✅

 接收视频| ✅ | ✅ | ✅

 发送小程序| ❌ | ✅ | ✅

 接收动图| ❌ | ✅ | ✅

 发送动图| ❌ | ✅ | ✅

 接收语音消息| ✅ | ✅ | ✅

 发送语音消息| ✅ | ❌ | ❌

 转发文本| ✅ | ✅ | ✅

 转发图片| ✅ | ✅ | ✅

 转发图文链接| ✅ | ✅ | ✅

 转发音频| ✅ | ❌ | ✅

 转发视频| ✅ | ✅ | ✅

 转发文件| ✅ | ✅ | ✅

 转发动图| ❌ | ❌ | ❌

 转发小程序| ❌ | ✅ | ❌

 **<群组>**|  |  |

 创建群聊|✅|✅|✅

 设置群公告|✅|✅|✅

 获取群公告|❌|✅|❌

 群二维码|✅|✅|✅

 拉人进群|✅|✅|✅

 踢人出群|✅|✅|✅

 退出群聊|✅|✅|✅

 改群名称|✅|✅|✅

 入群事件|✅|✅|✅

 离群事件|✅|✅|✅

 群名称变更事件|✅|✅|✅

 @群成员|✅|✅|✅

 群列表|✅|✅|✅

 群成员列表|✅|✅|✅

 群详情|✅|✅|✅

 **<联系人>**|  |  |

 修改备注|✅|✅|✅

 添加好友|✅|✅|✅

 自动通过好友|✅|✅|❌

 添加好友|✅|✅|✅

 好友列表|✅|✅|✅

 好友详情|✅|✅|✅

 **<其他>**|  |  |

 登录微信|✅|✅|✅

 扫码状态|✅|✅|❌

 退出微信|✅|✅|✅

 依赖协议|iPad|iPad|Mac|