# wechaty-getting-started **Repository Path**: zkyt/wechaty-getting-started ## Basic Information - **Project Name**: wechaty-getting-started - **Description**: Wechaty Starter Project Template that Works Out-of-the-Box - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2019-12-26 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # WECHATY-GETTING-STARTED ![Node.js v10](https://img.shields.io/badge/node-%3E%3D10-green.svg) [![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-blue.svg)](https://github.com/chatie/wechaty) [![Build Status](https://travis-ci.com/wechaty/wechaty-getting-started.svg?branch=master)](https://travis-ci.com/wechaty/wechaty-getting-started) [![Windows Build Status](https://img.shields.io/appveyor/ci/Chatie/wechaty-getting-started/master.svg?label=Windows)](https://ci.appveyor.com/project/Chatie/wechaty-getting-started) [![Greenkeeper badge](https://badges.greenkeeper.io/wechaty/wechaty-getting-started.svg)](https://greenkeeper.io/) [Wechaty](https://github.com/Chatie/wechaty/) is a Wechat Bot SDK for Personal Account that lets you create software to extend the functionality of the Wechat, writen in Node.js with TypeScript, Support all platforms including Linux, OSX, Win32, and Docker. As a developer, you can use Wechaty to easily build your bot on top of Wechat Personal Account, effectively manage message sending/receiving, room creating/inviting, contact friendship, and delightful add artificial intellengence between users and your bot. This repository should work out-of-the-box, and is the best start point for Wechaty beginners. ## REQUIREMENTS 1. Node.js v10 or above 2. Build Tools for your Platform ## GETTING STARTED ### 0. Install Node.js (>=10) If you have not installed Node.js(or version is below 10),You need to install the latest version of Node.js first by following the links below: * [Windows](https://nodejs.org/en/download/package-manager/#windows) * [Linux(Debian/Ubuntu)](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions) * [macOS](https://nodejs.org/en/download/package-manager/#macos) > Instal Node.js for other platforms can be found at ### 1. Clone this Repository ```sh git clone https://github.com/lijiarui/wechaty-getting-started.git cd wechaty-getting-started ``` ### 2. Install Dependencies ```sh npm install ``` ### 3. Run the Bot ```sh npm start ``` Or use node to run bot directly ```shell # Linux: export WECHATY_LOG=verbose # Win32: set WECHATY_LOG=verbose node examples/starter-bot.js ``` You are all set! ## ADVANCED ### 1. TypeScript ```sh npm run start:ts ``` This will run `examples/starter-bot.ts` instead of `examples/starter-bot.js` for you. ### 2. Wechaty Tutorial
Above is a 10 minute video tutorial(a little outdated, it's running under v0.14 or older versions of Wechaty), which is a good way to start if you are new to Wechaty. ### 3. More Examples > Note: Please make sure you can run `npm start` with this repository first before you go furture with more examples! * [Official Wechaty Examples Directory](https://github.com/wechaty/wechaty-getting-started/tree/master/examples) ## API REFERENCE 1. JSDoc: ## SEE ALSO ### 1. Docker Wechaty Getting Started [![Docker](https://avatars0.githubusercontent.com/u/5429470?s=200)](https://github.com/Chatie/docker-wechaty-getting-started) ### 2. Heroku Wechaty Getting Started [![Heroku](https://avatars3.githubusercontent.com/u/23211?s=200)](https://github.com/Chatie/heroku-wechaty-getting-started) ## FAQ ### 1. I can not login with my Wechat account Wechat account that registered after 2017 will not be able to login via Web API. Learn more at Solution: Wechaty support protocols other than Web API, such as pad. Learn more at ### 2. What is a `Puppet` in Wechaty The term [Puppet](https://github.com/Chatie/wechaty/wiki/Puppet) in Wechaty is an Abstract Class for implementing protocol plugins. The plugins are the component that helps Wechaty to control the Wechat(that's the reason we call it puppet). The plugins are named `PuppetXXX`, like [PuppetPuppeteer](https://github.com/Chatie/wechaty-puppet-puppeteer) is using the [google puppeteer](https://github.com/GoogleChrome/puppeteer) to control the [WeChat Web API](https://wx.qq.com) via a chrome browser, [PuppetPadchat](https://github.com/lijiarui/wechaty-puppet-padchat) is using the WebSocket protocol to connect with a Protocol Server for controlling the iPad Wechat program. More detail you could go [Puppet in wiki](https://github.com/Chatie/wechaty/wiki/Puppet).