微信助手项目使用教程

微信助手项目使用教程

wechat-assistant微信助手，支持群发消息、定时任务、消息防撤回、聊天记录备份等功能项目地址:https://gitcode.com/gh_mirrors/wec/wechat-assistant

1. 项目的目录结构及介绍

微信助手项目的目录结构如下：

wechat-assistant/
├── config/
│   ├── default.json
│   └── production.json
├── src/
│   ├── bot.js
│   ├── index.js
│   └── utils/
│       └── helper.js
├── package.json
└── README.md

目录结构介绍

• config/: 存放项目的配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
• src/: 存放项目的源代码。
  • bot.js: 微信机器人的核心逻辑文件。
  • index.js: 项目的入口文件。
  • utils/: 存放工具函数。
    • helper.js: 辅助函数文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，该文件负责初始化微信机器人并启动服务。

启动文件代码示例

const { Wechaty } = require('wechaty')
const bot = require('./bot')

const main = async () => {
  const botInstance = Wechaty.instance()
  botInstance.on('scan', (qrcode, status) => {
    console.log(`Scan QR Code to login: ${status}\n${qrcode}`)
  })
  botInstance.on('login', user => {
    console.log(`User ${user} logged in`)
  })
  botInstance.on('message', message => {
    console.log(`Message: ${message}`)
  })
  await botInstance.start()
}

main().catch(console.error)

代码说明

• 引入 wechaty 库并创建一个微信机器人实例。
• 监听 scan 事件，输出登录二维码。
• 监听 login 事件，输出登录用户信息。
• 监听 message 事件，输出接收到的消息。
• 启动微信机器人实例。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 default.json 和 production.json。

配置文件示例

config/default.json:

{
  "token": "your_wechaty_token",
  "puppet": "wechaty-puppet-service"
}

config/production.json:

{
  "token": "your_production_wechaty_token",
  "puppet": "wechaty-puppet-service"
}

配置文件说明

• token: 微信机器人的访问令牌。
• puppet: 使用的微信机器人服务类型。

通过这些配置文件，可以灵活地管理不同环境下的配置信息。

wechat-assistant微信助手，支持群发消息、定时任务、消息防撤回、聊天记录备份等功能项目地址:https://gitcode.com/gh_mirrors/wec/wechat-assistant