如何快速上手 wechatferry：5分钟搭建你的第一个微信机器人

如何快速上手 wechatferry：5分钟搭建你的第一个微信机器人

【免费下载链接】wechatferry-项目地址: https://gitcode.com/gh_mirrors/wec/wechatferry

wechatferry 是 Node 生态下的第三方微信机器人客户端实现，基于 WechatFerry 底层框架开发，提供了简单易用的接入方式，让每个人都能轻松开发微信机器人。

准备工作

系统要求

• 64位 Windows 系统
• 微信版本：3.9.12.17

环境准备

1. 下载并安装指定版本的微信
2. 打开微信并登录机器人账号

安装 wechatferry

wechatferry 提供多种集成方式，可根据你的技术栈选择最适合的方案：

Node 基础集成

# 使用 pnpm 安装核心模块 pnpm add -D @wechatferry/agent # 或直接安装核心包 pnpm add -D @wechatferry/core

Wechaty 集成

如果你熟悉 Wechaty 生态，可直接使用 puppet 集成：

pnpm add wechaty @wechatferry/puppet

Nuxt 集成

如果你使用 Nuxt 框架，推荐使用 Nuxt 模块：

pnpx nuxi module add @wechatferry/nuxt

快速开始

Node 环境基础示例

// 导入 agent 模块 import { WechatferryAgent } from '@wechatferry/agent' // 创建实例 const agent = new WechatferryAgent() // 连接到微信 agent.connect() // 监听消息事件 agent.on('message', (msg) => { console.log('收到消息:', msg) // 简单回复逻辑 if (msg.text() === '你好') { msg.say('你好！我是基于 wechatferry 的微信机器人') } })

Wechaty 集成示例

import { WechatyBuilder } from 'wechaty' import { WechatferryPuppet } from '@wechatferry/puppet' const puppet = new WechatferryPuppet() const bot = WechatyBuilder.build({ puppet, name: 'wechatferry-bot' }) // 启动机器人 bot.start() .then(() => console.log('机器人启动成功')) .catch(console.error) // 监听消息 bot.on('message', async (msg) => { console.log(`收到消息: ${msg.text()}`) if (msg.text() === 'ping') { await msg.say('pong') } })

插件扩展功能

wechatferry 提供了丰富的插件系统，可轻松扩展机器人功能：

安装插件包

pnpm add -D @wechatferry/plugins

常用插件示例

群聊管理插件

import { wechatyPluginRoomKick } from '@wechatferry/plugins' // 添加踢人插件 bot.use(wechatyPluginRoomKick({ keywords: ['广告', '链接'], warningTimes: 2 }))

安全模式插件

import { createSafeModePuppet } from '@wechatferry/plugins' import { WechatferryPuppet } from '@wechatferry/puppet' // 创建安全模式的 puppet const puppet = createSafeModePuppet(WechatferryPuppet, { whiteList: ['filehelper', '好友昵称'] })

示例代码

所有示例代码可以在项目的/examples文件夹中找到，包括：

• 基础 agent 示例
• 机器人应用示例

注意事项

使用 wechatferry 开发微信机器人时，请务必遵守以下规范：

1. 本项目仅供学习交流使用，请勿用于非法用途
2. 尊重用户隐私，严禁窃取他人信息
3. 遵守微信使用条款，避免过度频繁操作

更多功能和详细 API 请参考官方文档和源码：

• 核心模块源码：packages/core/
• 插件源码：packages/plugins/
• Puppet 实现：packages/puppet/

【免费下载链接】wechatferry-项目地址: https://gitcode.com/gh_mirrors/wec/wechatferry