getting started
1.0.0
Wechaty 是一款面向聊天机器人制造商的对话式 RPA（机器人流程自动化）SDK（软件开发套件）。它设计精良，具有易于使用的 API。它支持Linux、OSX、Win32、Docker等所有操作系统，以及微信、WeCom、Whatsapp、Lark、Gitter等多种IM（即时通讯服务）。
作为开发人员，您可以使用 Wechaty 轻松构建您的机器人，有效管理消息发送和接收、房间创建和发送邀请、联系朋友，并在用户和您的机器人之间愉快地添加人工智能。
如果您是微信的初学者，这个项目是您的最佳起点。您可以通过几个步骤在 Cloud IDE 上运行它，也可以在计算机上的本地设置上运行它，如以下部分所述。
如果您遇到困难或有任何疑问，欢迎您在我们的 Discord 社区寻求帮助：https://discord.gg/7q8NBZbQzt。
注意：Wechaty当前有效版本是v1.x，与大多数v0.x模块不兼容。
[email protected] - 要使用Wechaty v0.x，请访问Wechaty入门v0.x分支。ding消息时，会回复dong消息。
以上是使用微信、WhatsApp 和 WeCom 部署 ding-dong-bot 的简短流程。
开始使用 Wechaty 的最快方法是使用基于云的 IDE 来运行 Wechaty 入门项目。您可以使用 Gitpod 或 Google Cloud Shell。
如果您是初学者，那么我们推荐 Gitpod。
Gitpod 是一个在线开源平台，用于自动化和可立即编码的开发环境。您可以点击下面的按钮在 gitpod 上访问微信入门叮咚 BOT 项目的完整设置。如果您以前从未使用过 gitpod，则需要使用 gitHub 帐户登录。
您可以通过我们的博客了解有关 Gitpod ❤️ Wechaty 的更多信息：无需离开浏览器即可开始使用：Wechaty ❤️ Gitpod，@huan，2021 年 2 月 6 日
Google Cloud Shell 是一个在线开发和操作环境，可通过浏览器在任何地方访问。您可以通过单击下面的按钮在 Google Cloud Shell 上运行此项目。
通过 open-in-cloud-shell 生成
打开 Google Cloud Shell 编辑器后，右侧面板中应该有一个打开的教程，您可以按照该教程来了解有关 Wechaty 的更多信息。
通过我们的博客了解有关在 Google Cloud Shell 上运行此项目的更多信息：微信 Google Cloud Shell 教程，@huan，2021 年 2 月 20 日
为了在本地计算机上运行此项目，您需要：
在您的计算机上安装 Node.js v16+。您可以在终端上运行命令node -v来检查是否安装了Node.js如果你有它，你应该能够看到终端上打印的版本，例如v16.13.0 。您的版本可能与v16.13.0不同。如果未安装或您的版本低于16，您需要通过以下链接安装最新版本：
其他平台的 Node.js 可以在 https://nodejs.org/en/download/package-manager/ 找到
如果您想使用除 Web 之外的 RPA 协议，请拥有微信 Puppet 服务 TOKEN
您需要将此存储库克隆到本地计算机，然后通过运行以下命令切换到wechaty-getting-started目录。
git clone https://github.com/wechaty/getting-started.git
cd getting-started您需要通过运行以下命令来安装依赖项。
npm install在Linux中可以使用export来设置环境变量，在Windows中可以使用set 。如果运行此命令时遇到错误，请查看步骤 4 中的故障排除提示。
export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts set WECHATY_LOG=verbose
set WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts你已经准备好了！
如果您在执行上述步骤时遇到问题，请尝试以下选项。也欢迎您在我们的 gitter 聊天室提问。
如果您使用的是 Windows，您可能还需要 windows-build-tool：
npm install windows-build-tools在我们的入门示例中，当未设置WECHATY_PUPPET时，叮咚 BOT 使用 wechaty-puppet-wechat4u，这只是为了新手方便。
默认情况下，Wechaty 将使用 Puppet 服务登录您的机器人。您可以使用其他 Puppet Provider，例如 Whatsapp Web 协议（wechaty-puppet-whatsapp）。
如果您想将 Wechaty Puppet Provider 用于不同的协议，则需要通过设置WECHATY_PUPPET环境变量来指定 Puppet 服务提供程序名称（与其 NPM 名称相同）。
感谢我们社区的巨大贡献，现在有很多Wechaty Puppet可供Wechaty使用。他们帮助我们使用 Web、Pad、Mac 和 Windows 等协议。
| 协议 | 国家公共管理 |
|---|---|
| 傀儡服务 | wechaty-puppet-service |
| Whatsapp 网页 | wechaty-puppet-whatsapp |
| 微信网页版 | wechaty-puppet-wechat |
| 微信平板 | wechaty-puppet-padlocal |
访问我们的网站，了解有关微信傀儡服务提供商的更多信息
例如，如果您想使用padlocal puppet，则应在运行npm start之前设置WECHATY_PUPPET=wechaty-puppet-padlocal 。您还需要wechaty-puppet-padlocal的 TOKEN，您需要将其设置为WECHATY_PUPPET_PADLOCAL_TOKEN环境变量。您可以从这里申请PadLocal TOKEN。下面的代码片段说明了上面在 Linux/MacOS 和 Windows 上描述的内容。
export WECHATY_PUPPET=wechaty-puppet-padlocal
export WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start set WECHATY_PUPPET=wechaty-puppet-padlocal
set WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start从此博文了解有关在 Windows 上安装 Wechaty 的更多信息。
以上是10分钟的视频教程。它使用的是 0.14 版或更旧版本的 Wechaty，因此它也已经过时了。如果您是微信新手，这是一个很好的开始方式。
注意：在尝试更多示例之前，请确保您已经尝试过此存储库中的 wechaty 入门项目。
https://github.com/wechaty/docker-wechaty-getting-started
https://github.com/wechaty/heroku-wechaty-getting-started
https://wechaty.github.io
2017年之后注册的微信账号将无法通过Web API登录。了解更多信息请访问 wechaty/wechaty#872
解决方案：您可以使用Web API以外的Wechaty支持协议，例如pad。了解更多信息请访问 wechaty/wechaty#1296
Puppet是什么微信中的 Puppet 一词是一个用于实现协议插件的抽象类。插件是帮助微信控制微信的组件，这就是我们称之为傀儡的原因。
插件名为PuppetXXX ，例如 PuppetWeChat 使用 google puppeteer 通过 chrome 浏览器控制微信 Web API，PuppetPadchat 使用 WebSocket 协议连接协议服务器来控制 iPad 微信程序。欲了解更多详细信息，您可以访问 wiki 中的 Puppet。
通过 Wechaty Puppet 的文档了解有关 Wechaty Puppet 的更多信息
添加CQRS微信示例。
分支：v1.11：发布微信v1.11。
使用 Google Cloud Shell 进行快速设置！
使用 Gitpod 进行快速设置！
初始版本
@wechaty/贡献者
