{"id":15013909,"url":"https://github.com/wechaty/puppet-xp","last_synced_at":"2025-05-14T18:07:21.317Z","repository":{"id":37388257,"uuid":"385589889","full_name":"wechaty/puppet-xp","owner":"wechaty","description":"Wechaty Puppet WeChat Windows Protocol","archived":false,"fork":false,"pushed_at":"2025-03-19T06:29:53.000Z","size":3085,"stargazers_count":505,"open_issues_count":78,"forks_count":119,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-05-10T11:07:07.682Z","etag":null,"topics":["frida","puppet","sidecar","wechat","wechaty","windows"],"latest_commit_sha":null,"homepage":"http://wechaty.js.org/docs/puppet-providers/xp","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","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":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-13T12:05:28.000Z","updated_at":"2025-04-22T07:05:23.000Z","dependencies_parsed_at":"2024-01-23T02:57:33.043Z","dependency_job_id":"9eb7b662-6825-4d8b-a0ac-81730c72ef00","html_url":"https://github.com/wechaty/puppet-xp","commit_stats":{"total_commits":376,"total_committers":18,"mean_commits":20.88888888888889,"dds":0.6808510638297872,"last_synced_commit":"2cd0438cf9cffbe9eb076262f6784bd58e8b52d3"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":"wechaty/puppet-mock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-xp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-xp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-xp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-xp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/puppet-xp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254198515,"owners_count":22030966,"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":["frida","puppet","sidecar","wechat","wechaty","windows"],"created_at":"2024-09-24T19:44:55.633Z","updated_at":"2025-05-14T18:07:16.302Z","avatar_url":"https://github.com/wechaty.png","language":"JavaScript","readme":"# Wechaty Puppet XP\n\n[![Join Wechaty Discord Developer Community](https://img.shields.io/discord/916984413944967180?logo=discord\u0026style=flat)](https://discord.gg/uE8Tb77VBm)\n[![NPM](https://github.com/wechaty/wechaty-puppet-xp/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty/actions?query=workflow%3ANPM)\n[![NPM Version](https://img.shields.io/npm/v/wechaty-puppet-xp?color=brightgreen)](https://www.npmjs.com/package/wechaty-puppet-xp)\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-xp/next.svg)](https://www.npmjs.com/package/wechaty-puppet-xp?activeTab=versions)\n[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/wechaty/wechaty)\n[![Powered by Sidecar](https://img.shields.io/badge/Powered%20By-Sidecar-red.svg)](https://github.com/huan/sidecar)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n[![Downloads](https://img.shields.io/npm/dm/wechaty-puppet-xp.svg?style=flat-square)](https://www.npmjs.com/package/wechaty)\n[![GitHub stars](https://img.shields.io/github/stars/wechaty/wechaty-puppet-xp.svg?label=github%20stars)](https://github.com/wechaty/wechaty)\n[![Gitter](https://badges.gitter.im/wechaty/wechaty.svg)](https://gitter.im/wechaty/wechaty?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n\u003cimg src=\"https://github.com/atorber/puppet-xp/assets/19552906/ac34b791-bfff-4beb-9631-088939d40465\" alt=\"chatie puppet xp\" width=\"300\" height=\"300\" align=\"bottom\" /\u003e\n\n- Official website: \u003chttps://wechaty.js.org/docs/puppet-providers/xp\u003e\n- Join XP Discord: \u003chttps://discord.gg/uE8Tb77VBm\u003e\n\n## WECHATY PUPPET YOUTH STAR\n\nwechaty-puppet-xp is a local puppet for Wechaty:\n\n1. If you are a user of Windows,You can use this puppet to implement your chatbot.\n1. It's a completely free service and doesn't need token.\n\n## GETTING STARTED\n\n- STEP 1: Install wechat client in your Windows computer.\n\n\u003e 1.13.+ is the latest version, only support WeChat v3.9.2.23. Note to use the npm package that matches the WeChat version.\n\n- STEP 2: Login the wechat client on the computer.\n- STEP 3: Getting Started with TypeScript/JavaScript (RECOMMENDED).\n\n```sh\ngit clone https://github.com/wechaty/wechaty-puppet-xp.git\ncd wechaty-puppet-xp\n\n# 安装依赖\nnpm install\n\n# 启动程序\nnpm start\n#\n# Do not forget to install WeChat with requried version and login.\n#\n```\n\n| Run | Source code | Description |\n| :------------- |:-------------| :-----|\n| `npm start` | [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts) | Puppet ding/dong |\n| `npm run start:ripe` | [examples/ripe-wechaty.ts](examples/ripe-wechaty.ts) | Wechaty ding/dong |\n| `npm run start:raw` | [examples/raw-sidecar.ts](examples/raw-sidecar.ts) | Sidecar ding/dong |\n\n## RUNNING WHITH NPM\n\npuppet-xp also have already released the installation package on NPM. Running with NPM and more examples can be referred to [wechaty-puppet-xp-getting-started](https://github.com/atorber/wechaty-puppet-xp-getting-started).\n\n## PUPPET COMPARISON\n\nXP is a young puppet,it keeps growing and improving.\n\n版本|3.3.0.115|3.6.0.18|3.9.2.23|3.9.10.27|\n:---|:---|:---|:---|:---|\n**\u003c消息\u003e**|\n接收文本|✅|✅|✅|✅\n接收图片|✅|✅|✅\n接收文件|✅|✅|✅|✅\n接收动图|✅|✅|✅|✅\n接收表情|✅|✅|✅|✅\n接收小程序卡片|✅|✅|✅\n接收联系人卡片|✅|✅|✅\n接收位置卡片|✅|✅|✅\n发送文本|✅|✅|✅|✅\n发送图片|✅|✅|✅\n发送文件|✅|✅|✅\n发送动图|✅|✅|✅\n**\u003c群组\u003e**|\n@群成员|✅|✅|✅\n群列表|✅|✅|✅|✅\n群成员列表|✅|✅|✅\n群详情|✅|✅|✅\n进群提示|✅|✅|✅\n**\u003c联系人\u003e**|\n好友列表|✅|✅|✅|✅\n好友详情|✅|✅|✅\n**\u003c其他\u003e**|\n登录事件|✅|✅|✅|✅\n扫码登录|||✅\n\n## VERSION SUPPORT\n\nNote: You need to install an NPM version that matches your WeChat client version.\n\npuppet-xp|wechat|npm install|\n|:---|:---|:---|\n|2.1.1|[WeChat-v3.9.10.27](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.9.10.27/WeChatSetup-3.9.10.27.exe)|npm i wechaty-puppet-xp@2.1.1|\n|1.13.12|[WeChat-v3.9.2.23](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.9.2.23/WeChatSetup-3.9.2.23.exe)|npm i wechaty-puppet-xp@1.3.12|\n|1.12.7|[WeChat-v3.6.0.18](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.6.0.18/WeChatSetup-3.6.0.18.exe)|npm i wechaty-puppet-xp@1.12.7|\n|1.11.14|[WeChat-v3.3.0.115](https://github.com/wechaty/wechaty-puppet-xp/releases/download/v0.5/WeChatSetup-v3.3.0.115.exe)|npm i wechaty-puppet-xp@1.11.14|\n\n## HISTORY\n\n### v2.1.1\n\n1. Support WeChat version 3.9.10.27\n2. Support list\n    - getMyselfInfo\n    - contactList\n    - sendMsg\n    - recvMsg\n\n### v2.0.0\n\n1. Support WeChat version 3.9.10.19\n2. Support list\n    - getMyselfInfo\n    - sendMsg\n    - recvMsg\n\n### v1.13.12\n\n1. Fixed the bug where the system crashes upon receiving a message before successful startup\n\n### v1.13.9\n\n1. Add setting for contact remark\n2. Optimize sample code\n\n### v1.13.0 (September 21, 2023)\n\n1. This version start to support WeChat v3.9.2.23,need to update WeChat on your pc to 3.9.2.23\n2. [WeChatSetup-v3.9.2.23.exe](https://github.com/tom-snow/wechat-windows-versions/releases/download/v3.9.2.23/WeChatSetup-3.9.2.23.exe)\n\n### main v1.12.7 (November 22, 2022)\n\n1. This version start to support WeChat v3.6.0.18,need to update WeChat on your pc to 3.6.0.18\n2. [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)\n\n### v1.11.14\n\nthe last version base WeChat 3.3.0.115, next version will support WeChat 3.6.0.18\n\n### v1.0\n\nwechaty 1.xx support\n\n### v0.5\n\n1. ES Module support\n2. [WeChatSetup-v3.3.0.115.exe](https://github.com/wechaty/wechaty-puppet-xp/releases/download/v0.5/WeChatSetup-v3.3.0.115.exe)\n\n### v0.4.7 (Aug 15, 2021)\n\n1. Support send files.\n2. Support forward text message.\n\n### v0.4.2 (Aug 10, 2021)\n\nSupport room.say(text, ...mentionList), you can at RoomMember.\n\n### v0.4 (Aug 9, 2021)\n\n1. Added some support for classes Contact and Room\n1. Support bot.Contact.findAll()/bot.Contact.find(query)\n1. Support bot.Room.findAll()/bot.Room.find(query)\n\n### v0.2 (July 23, 2021)\n\n1. Code clean\n1. Fix all unit tests\n1. Run unit testings under Windows\n1. Deploy to NPM with GitHub actions\n1. [examples/ding-dong-bot.ts](examples/ding-dong-bot.ts) works on Windows!\n1. [examples/raw-sidecar.ts](examples/raw-sidecar.ts) works on Windows!\n1. [wechaty-getting-started](https://github.com/wechaty/wechaty-getting-started) supports `WECHATY_PUPPET=wechaty-puppet-xp` now.\n\n### v0.0.1 (July 19, 2021)\n\nInitial version: \u003chttps://wechaty.js.org/docs/puppet-providers/xp\u003e\n\nBlogs:\n\n- [喜讯：使用Windows微信桌面版协议登录，wechaty免费版协议即将登场, @atorber, Jul 05, 2021](https://wechaty.js.org/2021/07/05/puppet-laozhang-wechat-bot/)\n- [全新的Windows puppet项目wechaty-puppet-xp启动, @atorber, Jul 13, 2021](https://wechaty.js.org/2021/07/13/wechaty-puppet-xp-start-up/)\n- [code如诗，bot如歌，由Wechaty引发的一个小白冒险之旅, @老张学技术, Jul 05, 2021](https://wechaty.js.org/2021/07/05/code-like-poetry-bot-like-song/)\n\n## Author\n\n1. Hua ZHANG [@cixingguangming55555](https://github.com/cixingguangming55555)\n2. Yuchao LU [@atorber](https://github.com/atorber)\n\n## Copyright \u0026 License\n\n- Code \u0026 Docs © 2021 Wechaty Contributors\n- Code released under the Apache-2.0 License\n- Docs released under Creative Commons\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-xp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fpuppet-xp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-xp/lists"}