/wechaty-puppet-xp

Wechaty Puppet WeChat Windows Protocol

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Wechaty Puppet XP

NPM NPM Version npm (tag)

Powered by Wechaty Powered by Sidecar TypeScript Downloads GitHub stars Gitter

chatie puppet xp

WECHATY PUPPET YOUTH STAR

wechaty-puppet-xp is a local puppet for Wecaty:

  1. If you are a user of Windows,You can use this puppet to implement your chatbot.
  2. It's a completely free service and doesn't need token.

GETTING STARTED

  • STEP 1: Install wechat client in your Windows computer.
  • STEP 2: Login the wechat client on the computer.
  • STEP 3: Getting Started with TypeScript/JavaScript (RECOMMENDED).

QUICK START

git clone https://github.com/wechaty/wechaty-puppet-xp.git
cd wechaty-puppet-xp
npm install
#
# Do not forget to install WeChat with requried version and login.
#
Run Source code Description
npm start examples/ding-dong-bot.ts Puppet ding/dong
npm run start:ripe examples/ripe-wechaty.ts Wechaty ding/dong
npm run start:raw examples/raw-sidecar.ts Sidecar ding/dong

HISTORY

main v0.5

  1. ES Module support

v0.4.7 (Aug 15, 2021)

  1. Support send files.
  2. Support forward text message.

v0.4.2 (Aug 10, 2021)

Support room.say(text, ...mentionList), you can at RoomMember.

v0.4 (Aug 9, 2021)

  1. Added some support for classes Contact and Room
  2. Support bot.Contact.findAll()/bot.Contact.find(query)
  3. Support bot.Room.findAll()/bot.Room.find(query)

v0.2 (July 23, 2021)

  1. Code clean
  2. Fix all unit tests
  3. Run unit testings under Windows
  4. Deploy to NPM with GitHub actions
  5. examples/ding-dong-bot.ts works on Windows!
  6. examples/raw-sidecar.ts works on Windows!
  7. wechaty-getting-started supports WECHATY_PUPPET=wechaty-puppet-xp now.

v0.0.1 (July 19, 2021)

Initial version.

Author

  1. Hua ZHANG @cixingguangming55555
  2. Yuchao LU @atorber

Copyright & License

  • Code & Docs © 2021 Wechaty Contributors
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons