{"id":22207633,"url":"https://github.com/wechaty/wechaty-puppet-padplus","last_synced_at":"2025-04-06T02:09:58.075Z","repository":{"id":54465426,"uuid":"206789235","full_name":"wechaty/wechaty-puppet-padplus","owner":"wechaty","description":"DEPRECATED: One puppet based on iPad protocal for Wechaty","archived":false,"fork":false,"pushed_at":"2023-07-05T02:52:15.000Z","size":1115,"stargazers_count":309,"open_issues_count":47,"forks_count":64,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-05-13T12:04:42.013Z","etag":null,"topics":["chatbot","wechaty","wechaty-puppet"],"latest_commit_sha":null,"homepage":"https://wechaty.js.org/docs/puppet-services/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechaty.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2019-09-06T12:29:15.000Z","updated_at":"2024-04-29T11:02:17.000Z","dependencies_parsed_at":"2022-08-13T16:30:56.971Z","dependency_job_id":"cd815457-2263-4605-adbe-ca177e56a79d","html_url":"https://github.com/wechaty/wechaty-puppet-padplus","commit_stats":{"total_commits":562,"total_committers":11,"mean_commits":51.09090909090909,"dds":0.599644128113879,"last_synced_commit":"ee1f5d24a9c66b4e2c24a2302b578f16fc2f035a"},"previous_names":["botorange/wechaty-puppet-padplus"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fwechaty-puppet-padplus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fwechaty-puppet-padplus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fwechaty-puppet-padplus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fwechaty-puppet-padplus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/wechaty-puppet-padplus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271527,"owners_count":20911587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","wechaty","wechaty-puppet"],"created_at":"2024-12-02T19:13:53.699Z","updated_at":"2025-04-06T02:09:58.048Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# THIS REPO HAS BEEN DEPRECATED\n\nLearn more about Wechaty Puppet Services from \u003chttps://wechaty.js.org/docs/puppet-services\u003e\n\nYou can use Wechaty with other puppet services like WXWork, Rock, PadLocal, etc as well.\n\n## 通知 (Nov, 2020)\n\n亲爱的开发者，您好！\n\n为了更好的提供服务，JuziBot Puppet Service 计划于11月30日进行一次 wechaty-puppet-padplus 重大升级。\n\n如您正在使用 wechaty-puppet-padplus服务, 则需要进行如下升级操作。（如未使用 wechaty-puppet-padplus,可安全的忽视本通知）\n\nwechaty-puppet-padplus 升级说明如下:\n1. 卸载 wechaty-puppet-padplus, 安装 wechaty-puppet-hostie\n2. 代码中启动wechaty的 wechaty-puppet-padplus 更换成 wechaty-puppet-hostie\n\n详细说明：\nwechaty-puppet-padplus 将会在11月30日下线，已付费的用户可以升级到下面的两个puppet:\n1. wechaty-puppet-donut: 基于 windows 的个人微信，除了 padplus 的基础功能外，还支持接受企业微信消息，详细信息见 https://github.com/juzibot/donut-tester\n2. wechaty-puppet-wxwork: 基于 windows 客户端的企业微信，详细信息见 https://github.com/juzibot/wxwork-tester\n\n如在11月30日前没有升级代码库，wechaty-puppet-padplus 服务将会在12月1日00:00停止服务，导致您托管的微信不可用，所以强烈建议提前进行代码升级，以避免机器人意外终止服务。\n\n如果您有任何问题，请及时与我们的客服联系，微信：`juzibot`\n\n详情见：https://github.com/wechaty/puppet-service-providers/issues/11\n\n\n# WECHATY-PUPPET-PADPLUS\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-blue.svg)](https://github.com/chatie/wechaty)\n[![NPM Version](https://badge.fury.io/js/wechaty-puppet-padplus.svg)](https://www.npmjs.com/package/wechaty-puppet-padplus)\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-padplus/next.svg)](https://www.npmjs.com/package/wechaty-puppet-padplus?activeTab=versions)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n[![Linux/Mac Build Status](https://travis-ci.com/wechaty/wechaty-puppet-padplus.svg?branch=master)](https://travis-ci.com/wechaty/wechaty-puppet-padplus) \n\n## Notice\n\nOur Mission: Make it easy to build a WeChat Chatbot for developers.\n\nWe provide a **free** token for the developers who have a strong will and ability to build a valuable chatbot for users.\n\nSee more: [Token Support](https://github.com/juzibot/Welcome/wiki/Support-Developers), [Everything about wechaty](https://github.com/juzibot/Welcome/wiki/Everything-about-Wechaty)\n\n## Install\n\n### 1. Init\n\n#### 1.1. Check your `Node` version first\n\n```shell\nnode --version // v10.16.0\n```\n\n\u003e for windows system\n\nTo make sure you could install `wechaty-puppet-padplus` successfully, you have to start PowerShell as Administrator and run these commands:\n\n```shell\nnpm install -g windows-build-tools\n\nnpm install -g node-gyp\n```\n\n#### 1.2. Create your bot folder and do some init config\n\n```shell\nmkdir my-padplus-bot \u0026\u0026 cd my-padplus-bot\n\nnpm init -y\n\nnpm install ts-node typescript -g\n\ntsc --init --target ES6\n\ntouch bot.ts // copy the example code to it\n```\n\n### 2. Install Wechaty Dependencies\n\n```shell\nnpm install wechaty@latest\n\nnpm install wechaty-puppet-padplus@latest\n```\n\nOr some new features developing version:\n\n```shell\nnpm install wechaty@next\n\nnpm install wechaty-puppet-padplus@next\n```\n\n### 3. Install Other Dependencies\n\n\u003e There's no need to install `wechaty-puppet` in my-padplus-bot\n\n```shell\nnpm install qrcode-terminal\n...\n```\n\n### 4. Run\n\n\u003e If you want to see detail logs about your bot, just run:\n\n```shell\nBROLOG_LEVEL=silly ts-node bot.ts\n```\n\nor\n\n```shell\nBROLOG_LEVEL=silly node bot.js\n```\n\n\n### 5. Cache Option\n\n\u003e wechaty-puppet-padplus use flash-store or mongo as cache store\n\n- flash-store[default]\n- mongo\n\n\u003e If you want to use mongo as cache sotre, just set the cacheOption, like this:\n\n```ts\nconst puppet: Puppet = new PuppetPadplus({\n  token,\n  cacheOption: {\n    type: 'mongo',\n    url: 'mongodb://127.0.0.1:27017/testdb',\n  },\n})\n\n```\n\n#### Caution\n\n*When you use mongo as cache store, wechaty-puppet-cache use some tables which have `wechaty-cache` prefix. [detail\u003e\u003e](https://www.npmjs.com/package/wechaty-puppet-cache#4-caution)*\n\n### 6. Other Tips\n\n\u003e Set environment in windows\n\n```shell\n$Env:BROLOG_LEVEL='silly'\nts-node bot.ts\n```\n\n\u003e If step 1~3 can not help you install successfully, please try this suggestion, otherwise just skip it please.\n\n```shell\nrm -rf node_modules package-lock.json\nnpm install\n```\n\n## Example\n\n```ts\n// bot.ts\nimport { Contact, Message, Wechaty } from 'wechaty'\nimport { ScanStatus } from 'wechaty-puppet'\nimport { PuppetPadplus } from 'wechaty-puppet-padplus'\nimport QrcodeTerminal from 'qrcode-terminal'\n\nconst token = 'your-token'\n\nconst puppet = new PuppetPadplus({\n  token,\n})\n\nconst name  = 'your-bot-name'\n\nconst bot = new Wechaty({\n  puppet,\n  name, // generate xxxx.memory-card.json and save login data for the next login\n})\n\nbot\n  .on('scan', (qrcode, status) =\u003e {\n    if (status === ScanStatus.Waiting) {\n      QrcodeTerminal.generate(qrcode, {\n        small: true\n      })\n    }\n  })\n  .on('login', (user: Contact) =\u003e {\n    console.log(`login success, user: ${user}`)\n  })\n  .on('message', (msg: Message) =\u003e {\n    console.log(`msg : ${msg}`)\n  })\n  .on('logout', (user: Contact, reason: string) =\u003e {\n    console.log(`logout user: ${user}, reason : ${reason}`)\n  })\n  .start()\n```\n\n## How to emit the message that you sent\n\nPlease use environment variable `PADPLUS_REPLAY_MESSAGE` to activate this function.\n\n```shell\nPADPLUS_REPLAY_MESSAGE=true node bot.js\n```\n\n## Puppet Comparison\n\n功能 | padpro | padplus | macpro\n---|---|---|---\n **\u003c消息\u003e**|  |  |\n 收发文本| ✅ |✅ |✅\n 收发个人名片| ✅ |✅ |✅\n 收发图文链接| ✅ |✅ |✅\n 发送图片、文件| ✅ | ✅（对内容有大小限制，20M以下） |✅\n 接收图片、文件| ✅ | ✅（对内容有大小限制，25M以下） |✅\n 发送视频| ✅ | ✅ | ✅\n 接收视频| ✅ | ✅ | ✅\n 发送小程序| ❌ | ✅ | ✅\n 接收动图| ❌ | ✅ | ✅\n 发送动图| ❌ | ✅ | ✅\n 接收语音消息| ✅ | ✅ | ✅\n 发送语音消息| ✅ | ❌ | ❌\n 转发文本| ✅ | ✅ | ✅\n 转发图片| ✅ | ✅ | ✅\n 转发图文链接| ✅ | ✅ | ✅\n 转发音频| ✅ | ❌ | ✅\n 转发视频| ✅ | ✅ | ✅\n 转发文件| ✅ | ✅ | ✅\n 转发动图| ❌ | ❌ | ❌\n 转发小程序| ❌ | ✅ | ❌\n **\u003c群组\u003e**|  |  |\n 创建群聊|✅|✅|✅\n 设置群公告|✅|✅|✅\n 获取群公告|❌|✅|❌\n 群二维码|✅|✅|✅\n 拉人进群|✅|✅|✅\n 踢人出群|✅|✅|✅\n 退出群聊|✅|✅|✅\n 改群名称|✅|✅|✅\n 入群事件|✅|✅|✅\n 离群事件|✅|✅|✅\n 群名称变更事件|✅|✅|✅\n @群成员|✅|✅|✅\n 群列表|✅|✅|✅\n 群成员列表|✅|✅|✅\n 群详情|✅|✅|✅\n **\u003c联系人\u003e**|  |  |\n 修改备注|✅|✅|✅\n 添加好友|✅|✅|✅\n 自动通过好友|✅|✅|❌\n 添加好友|✅|✅|✅\n 好友列表|✅|✅|✅\n 好友详情|✅|✅|✅\n **\u003c其他\u003e**|  |  |\n 登录微信|✅|✅|✅\n 扫码状态|✅|✅|❌\n 退出微信|✅|✅|✅\n 依赖协议|iPad|iPad|Mac|\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fwechaty-puppet-padplus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fwechaty-puppet-padplus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fwechaty-puppet-padplus/lists"}