【亲测免费】 WECHATY-PUPPET-PADLOCAL 技术文档

1. 安装指南

1.1 获取 PadLocal TOKEN

要开始使用 WECHATY-PUPPET-PADLOCAL，首先需要获取 PadLocal TOKEN。你可以通过访问 pad-local.com 获取一个为期7天的免费试用TOKEN。

1.2 安装依赖

确保你的开发环境已经安装了 Node.js 和 npm。然后，通过 npm 安装 wechaty-puppet-padlocal：

npm install wechaty-puppet-padlocal

1.3 配置环境变量

在项目根目录下创建一个 .env 文件，并添加以下内容：

WECHATY_PUPPET=wechaty-puppet-padlocal
WECHATY_PUPPET_PADLOCAL_TOKEN=your_padlocal_token

将 your_padlocal_token 替换为你从 pad-local.com 获取的 TOKEN。

2. 项目的使用说明

2.1 初始化项目

在你的项目中引入 wechaty-puppet-padlocal，并初始化 Wechaty 实例：

import { Wechaty } from 'wechaty'
import { PuppetPadlocal } from 'wechaty-puppet-padlocal'

const puppet = new PuppetPadlocal({
  token: process.env.WECHATY_PUPPET_PADLOCAL_TOKEN,
})

const bot = new Wechaty({
  puppet,
})

bot.on('scan', (qrcode, status) => {
  console.log(`Scan QR Code to login: ${status}\nhttps://wechaty.js.org/qrcode/${encodeURIComponent(qrcode)}`)
})

bot.on('login', user => {
  console.log(`User ${user} logged in`)
})

bot.on('message', message => {
  console.log(`Message: ${message}`)
})

bot.start()
  .then(() => console.log('Wechaty bot started.'))
  .catch(e => console.error(e))

2.2 运行项目

确保你的环境变量配置正确后，运行以下命令启动项目：

node your_script.js

3. 项目API使用文档

3.1 消息处理

3.1.1 发送文本消息

await bot.say('Hello, World!')

3.1.2 发送图片

await bot.say(new FileBox('path/to/image.png'))

3.1.3 发送文件

await bot.say(new FileBox('path/to/file.pdf'))

3.2 群组管理

3.2.1 创建群聊

const room = await bot.Room.create([contact1, contact2], 'Group Name')

3.2.2 设置群公告

await room.announce('New Group Announcement')

3.2.3 获取群公告

const announcement = await room.announce()

3.3 联系人管理

3.3.1 添加好友

await contact.add()

3.3.2 修改备注

await contact.alias('New Alias')

4. 项目安装方式

4.1 通过 npm 安装

npm install wechaty-puppet-padlocal

4.2 通过 yarn 安装

yarn add wechaty-puppet-padlocal

4.3 手动安装

如果你需要手动安装，可以克隆项目仓库并安装依赖：

git clone https://github.com/padlocal/wechaty-puppet-padlocal.git
cd wechaty-puppet-padlocal
npm install

通过以上步骤，你可以顺利安装并使用 WECHATY-PUPPET-PADLOCAL 项目。希望这篇文档能帮助你更好地理解和使用该项目。