puppet xp getting started
1.0.0
Этот проект основан на проекте puppet-xp сообщества чат-роботов с открытым исходным кодом Wechaty, предназначенном для быстрого запуска и лучших практик для чат-роботов WeChat. Он поддерживает версии клиента WeChat для Windows 3.3.0.115, 3.6.0.18 и 3.9.2.23.
преимущество:
Содержимое, опубликованное на этом складе, предназначено только для обучения и исследований, пожалуйста, не используйте его в незаконных или коммерческих целях! Если в результате возникнут какие-либо юридические споры, то автор тут ни при чем!
Запуск роботов WeChat может привести к блокировке аккаунта и другим последствиям. Пожалуйста, используйте на свой страх и риск. Только для изучения и исследования, пожалуйста, не используйте его в незаконных целях.
Это полностью зависит от уровня поддержки проекта puppet-xp. Последняя поддерживаемая в настоящее время версия WeChat — 3.9.2.23, а самая стабильная версия — 3.6.0.18.
| Версия | 3.3.0.115 | 3.6.0.18 | 3.9.2.23 |
|---|---|---|---|
| <сообщение> | |||
| получить текст | ✅ | ✅ | ✅ |
| получать фотографии | ✅ | ✅ | ✅ |
| получать файлы | ✅ | ✅ | ✅ |
| Получайте анимированные картинки | ✅ | ✅ | ✅ |
| получать смайлики | ✅ | ✅ | ✅ |
| Получите мини-карту программы | ✅ | ✅ | ✅ |
| Получить карточку контакта | ✅ | ✅ | ✅ |
| Получить карту местоположения | ✅ | ✅ | ✅ |
| Отправить текст | ✅ | ✅ | ✅ |
| Отправить фотографии | ✅ | ✅ | ✅ |
| Отправить файлы | ✅ | ✅ | ✅ |
| Отправить гифку | ✅ | ✅ | ✅ |
| <группа> | |||
| @участник группы | ✅ | ✅ | ✅ |
| Список групп | ✅ | ✅ | ✅ |
| Список участников группы | ✅ | ✅ | ✅ |
| Детали группы | ✅ | ✅ | ✅ |
| Советы по вступлению в группу | ✅ | ✅ | ✅ |
| <Контакт> | |||
| список друзей | ✅ | ✅ | ✅ |
| Сведения о друге | ✅ | ✅ | ✅ |
| <Другие> | |||
| Событие входа | ✅ | ✅ | ✅ |
| Сканируйте код, чтобы войти | ✅ |
wechaty-puppet-xp поддерживает использование только в операционной системе Windows, а версия WeChat должна соответствовать версии пакета npm. В Quick Start по умолчанию используется WeChat версии 3.9.2.23.
Проверьте, является ли версия WeChat на компьютере поддерживаемой версией (если нет необходимости загружать указанную версию, если она есть, то нет необходимости ее переустанавливать), войдите в WeChat обычным способом, если текущая версия WeChat на компьютер не соответствует, необходимо скачать WeChatSetup-v3.9.2.23.exe
Загрузите и установите nodejs версии 16LTS, проверьте версию узла >= v16.0.0.
node -v
PS C:UsersAdministratorDocumentsGitHubwechaty-puppet-xp-demo> node -v
v16.15.0
git clone https://github.com/atorber/puppet-xp-getting-started
cd puppet-xp-getting-started
npm i wechaty-puppet-xp@next
npm install
Если установка не удалась, вы можете вручную установить puppet-xp и запустить
npm i wechaty-puppet-xp@next
Убедитесь, что в WeChat на ПК выполнен вход, и убедитесь, что установлена версия v3.9.2.23.
npm run start
Индикация аналогична следующей, что указывает на успешный запуск.
PS C:UsersAdministratorDocumentsGitHubwechaty-puppet-xp-demo> npm run start
> [email protected] start
> cross-env NODE_OPTIONS="--no-warnings --loader=ts-node/esm" node ./src/index.ts
01:42:54 INFO options... {"version":"3.9.2.23"}
01:42:57 INFO StarterBot Starter Bot Started.
01:43:12 INFO onLogin Contact<大师> login
01:43:13 INFO 当前登录账号信息： Contact<大师>
01:43:13 INFO 微信号查找联系人： Contact<文件传输助手>
01:43:13 INFO 昵称查找联系人： Contact<文件传输助手>
01:43:13 INFO 备注名称查找联系人： 没有找到联系人
01:43:13 INFO 群ID查找群： Room<大师是群主>
01:43:13 INFO 群名称查找群： Room<大师是群主>
01:43:13 INFO 联系人数量： 6271
01:43:13 INFO 群数量： 53
| бегать | Соответствующая программа | иллюстрировать |
|---|---|---|
npm start | источник/indext.ts | пример кода тс |
npm run start:js | src/ding-dong-bot.js | пример js-кода |
#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
/**
* wechaty-puppet-xp示例代码，可以作为模版编写自己的业务逻辑.
*
**/
import 'dotenv/config.js'
import {
Contact,
Message,
ScanStatus,
WechatyBuilder,
log,
types,
} from 'wechaty'
import qrcodeTerminal from 'qrcode-terminal'
import { FileBox } from 'file-box'
const onScan = (qrcode: string, status: ScanStatus) => {
if (status === ScanStatus.Waiting || status === ScanStatus.Timeout) {
const qrcodeImageUrl = [
'https://wechaty.js.org/qrcode/',
encodeURIComponent(qrcode),
].join('')
log.info('onScan: %s(%s) - %s', ScanStatus[status], status, qrcodeImageUrl)
qrcodeTerminal.generate(qrcode, { small: true }) // show qrcode on console
} else {
log.info('onScan: %s(%s)', ScanStatus[status], status)
}
}
const onLogin = async (user: Contact) => {
log.info('onLogin', '%s login', user)
// 登录成功后调用bot
main()
}
const onLogout = (user: Contact) => {
log.info('onLogout', '%s logout', user)
}
const onMessage = async (msg: Message) => {
log.info('onMessage', JSON.stringify(msg))
// Message doc : https://wechaty.js.org/docs/api/message#messageage--number
const talker = msg.talker() // 发消息人
const listener = msg.listener() // 接收消息人
const room = msg.room() // 是否是群消息
const text = msg.text() // 消息内容
const type = msg.type() // 消息类型
const self = msg.self() // 是否自己发给自己的消息
log.info('talker', JSON.stringify(talker))
log.info('listener', listener||'undefined')
log.info('room', room || 'undefined')
log.info('text', text)
log.info('type', type)
log.info('self', self?'true':'false')
try {
switch (text) {
case 'ding': // 接收到的消息是ding，回复dong
await msg.say('dong')
break
case 'send text': // 接收到的消息是send text，发送文本消息
await msg.say('this is a test text')
break
case 'send image': // 接收到的消息是send image，发送图片
const image = FileBox.fromFile('file/ledongmao.jpg')
await msg.say(image)
break
case 'send file': // 接收到的消息是send file，发送文件
const fileBox = FileBox.fromUrl('https://wechaty.js.org/assets/logo.png')
await msg.say(fileBox)
break
case 'send video': // 接收到的消息是send video，发送视频
const video = FileBox.fromUrl('http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4')
await msg.say(video)
break
case 'send audio': // 接收到的消息是send audio，发送音频
const audio = FileBox.fromUrl('http://www.zhongguoyinhang.com/upload/2018-11/201811161154314128.mp3')
await msg.say(audio)
break
case 'send emotion': // 接收到的消息是send emotion，发送表情
const emotion = FileBox.fromUrl('https://res.wx.qq.com/mpres/htmledition/images/icon/emotion/0.gif')
await msg.say(emotion)
break
default:
break
}
} catch (e) {
console.log('回复消息失败...', e)
}
try{
switch (type) {
case types.Message.Text: // 接收到的消息是文本
log.info('接收到的消息是文本')
log.info('消息内容：', text)
break
case types.Message.Image: // 接收到的消息是图片
log.info('接收到的消息是图片')
const image = await msg.toImage().thumbnail() // Save the media message as a FileBox
const filePath = 'file/' + image.name
try {
image.toFile(filePath, true)
log.info(`Saved file: ${filePath}`)
} catch (e) {
log.error('保存文件错误：', e)
}
break
case types.Message.Attachment: // 接收到的消息是附件
log.info('接收到的消息是附件')
const attachment = await msg.toFileBox() // Save the media message as a FileBox
const attachmentPath = 'file/' + attachment.name
try {
attachment.toFile(attachmentPath, true)
log.info(`Saved file: ${attachmentPath}`)
} catch (e) {
log.error('保存文件错误：', e)
}
break
case types.Message.Video: // 接收到的消息是视频
log.info('接收到的消息是视频')
const video = await msg.toFileBox() // Save the media message as a FileBox
const videoPath = 'file/' + video.name
try {
video.toFile(videoPath, true)
log.info(`Saved file: ${videoPath}`)
} catch (e) {
log.error('保存文件错误：', e)
}
break
case types.Message.Audio: // 接收到的消息是音频
log.info('接收到的消息是音频')
break
case types.Message.Emoticon: // 接收到的消息是表情
log.info('接收到的消息是表情')
const emoticon = await msg.toFileBox() // Save the media message as a FileBox
const emoticonPath = 'file/' + emoticon.name
try {
emoticon.toFile(emoticonPath, true)
log.info(`Saved file: ${emoticonPath}`)
} catch (e) {
log.error('保存文件错误：', e)
}
break
case types.Message.Url: // 接收到的消息是链接
log.info('接收到的消息是链接')
try {
const urlLink = await msg.toUrlLink()
log.info('链接标题：', urlLink.title)
log.info('链接地址：', urlLink.url)
} catch (e) {
log.error('获取链接错误：', e)
}
break
case types.Message.MiniProgram: // 接收到的消息是小程序
log.info('接收到的消息是小程序')
try {
const miniProgram = await msg.toMiniProgram()
log.info('小程序标题：', miniProgram.title)
log.info('小程序描述：', miniProgram.description)
log.info('小程序页面地址：', miniProgram.pagePath)
log.info('小程序缩略图：', miniProgram.thumbUrl)
} catch (e) {
log.error('获取小程序错误：', e)
}
break
case types.Message.Transfer: // 接收到的消息是转账
log.info('接收到的消息是转账')
break
case types.Message.RedEnvelope: // 接收到的消息是红包
log.info('接收到的消息是红包')
break
case types.Message.Recalled: // 接收到的消息是撤回的消息
log.info('接收到的消息是撤回的消息')
break
case types.Message.Location: // 接收到的消息是位置
log.info('接收到的消息是位置')
break
case types.Message.GroupNote: // 接收到的消息是群公告
log.info('接收到的消息是群公告')
break
case types.Message.Contact: // 接收到的消息是联系人名片
log.info('接收到的消息是联系人名片')
break
case types.Message.ChatHistory: // 接收到的消息是聊天记录
log.info('接收到的消息是聊天记录')
break
case types.Message.Post: // 接收到的消息是公众号文章
log.info('接收到的消息是公众号文章')
break
case types.Message.Unknown: // 接收到的消息是未知类型
log.info('接收到的消息是未知类型')
break
default:
break
}
}catch(e){
console.log('处理消息失败...', e)
}
// 关键词回复,同时也是发送消息的方法
}
const bot = WechatyBuilder.build({
name: 'ding-dong-bot',
puppet: 'wechaty-puppet-xp',
puppetOptions: {
version: '3.9.2.23',
}
})
bot.on('scan', onScan)
bot.on('login', onLogin)
bot.on('logout', onLogout)
bot.on('message', onMessage)
bot.start()
.then(async () => {
log.info('StarterBot', 'Starter Bot Started.')
})
.catch(e => log.error('StarterBot', e))
const main = async () => {
// 获取当前登录微信信息
try {
const self = bot.currentUser
log.info('当前登录账号信息：', self)
} catch (e) {
log.error('get user failed', e)
}
// 通过微信号搜索联系人
try {
const contactById = await bot.Contact.find({
id: 'filehelper'
})
log.info('微信号查找联系人：', contactById)
// 向联系人发送消息
contactById?.say('向指定好友微信号发送消息')
} catch (e) {
log.error('contactByWeixin', e)
}
// 通过昵称搜索联系人
try {
const contactByName = await bot.Contact.find({
name: '文件传输助手'
})
log.info('昵称查找联系人：', contactByName)
// 向联系人发送消息
contactByName?.say('向指定好友昵称发送消息')
} catch (e) {
log.error('contactByName', e)
}
// 通过备注搜索联系人
try {
const contactByAlias = await bot.Contact.find({
alias: '超哥'
})
log.info('备注名称查找联系人：', contactByAlias || '没有找到联系人')
// 向联系人发送消息
contactByAlias?.say('向指定好友备注好友发送消息')
} catch (e) {
log.error('contactByAlias', e)
}
try {
// 通过群ID搜索群
const roomById = await bot.Room.find({
id: '21341182572@chatroom'
})
log.info('群ID查找群：', roomById)
// 向群里发送消息
roomById?.say('向指定群ID发送消息')
} catch (e) {
log.error('roomById', e)
}
try {
// 通过群名称搜索群
const roomByName = await bot.Room.find({
topic: '大师是群主'
})
log.info('群名称查找群：', roomByName || '没有找到群')
// 向群里发送消息
roomByName?.say('向指定群名称发送消息')
} catch (e) {
console.log('roomByName', e)
}
try {
// 获取所有联系人
const contactList = await bot.Contact.findAll()
// log.info('获取联系人列表：', contactList)
log.info('联系人数量：', contactList.length)
} catch (e) {
log.error('contactList', e)
}
try {
// 获取所有群
const roomList = await bot.Room.findAll()
// log.info('获取群列表：', roomList)
log.info('群数量：', roomList.length)
} catch (e) {
log.error('roomList', e)
}
}
Этот проект обновлен с помощью wechaty-puppet-xp и поддерживает несколько версий WeChat. Вы можете самостоятельно переключить версию WeChat и соответствующую версию npm.
| марионетка-XP | Загрузка клиента WeChat | установка пакета npm |
|---|---|---|
| 1.3.х | WeChat-v3.9.2.23 | НПМ я wechaty-puppet-xp@next |
| 1.12.7 | WeChat-v3.6.0.18 | НПМ я [email protected] |
| 1.11.14 | WeChat-v3.3.0.115 | НПМ я [email protected] |
исходный код проекта wechaty-puppet-xp
ChatFlow Система управления чат-роботами ChatFlow
Хорошие новости: для входа в систему используйте протокол настольной версии Windows WeChat, и скоро будет доступна бесплатная версия протокола wechaty, @atorber, 5 июля 2021 г.
Запущен новый кукольный проект Windows wechaty-puppet-xp, @atorber, 13 июля 2021 г.
Код похож на поэзию, бот — на песню, приключение новичка, инициированное Wechaty, @老张学技术, 5 июля 2021 г.
Официальный сайт Вечати
