1. Run Installer to install NodeJS to your machine
## 2. Install Wechaty
Use `npm` to install Wechaty
## 2. Fork & Clone Wechaty
If you have no github account, you can just clone it via https:
```shell
npm install wechaty
git clone https://github.com/zixia/wechaty.git
```
This will install the last version of wechaty and all the dependents(dev).
This will clone wechaty source code to your current directory.
## 3. Run Demo Bot
```shell
cd node_modules/wechaty
cd wechaty
npm install
npm start
```
This will run `node example/ding-dong-bot.js`
After a little while, bot will show you a message of a url for Login QrCode. You need to scan this qrcode in your wechat in order to permit your bot login.
## 4. Done
Enjoy hacking Wechaty!
Please submit your issue if you have any, and a fork & pull is very welcome for showing your idea.
# Trouble Shooting
If wechaty is not run as expected, run unit test maybe help to find some useful message.
```shell
...
...
@@ -102,59 +115,68 @@ ECMAScript2015(ES6). I develop and test wechaty with Node.js v6.0.
# API Refference
## Class Wechaty
Main bot class.
I'll try my best to keep the api as sample as it can be.
```javascript
constbot=newWechaty()
```
## Events
### 1. Event: `scan`
A `scan` event will be emitted when the bot need to show you a QrCode for scaning.
### Wechaty.init()
Initialize the bot, return Promise.
```javascript
bot.init()
.then(()=>{
// do other staff with bot here
}
bot.on('scan',({code,url})=>{
console.log(`[${code}] Scan ${url} to login.`)
})
```
### Wechaty.getLoginQrImgUrl()
Get the login QrCode image url. Must be called after init().
1. url: {String} the qrcode image url
2. code: {Number} the scan status code. some known status of the code list here is:
1. 0 initial
2. 408 wait for scan
3. 201 scaned, wait for confirm
4. 200 login confirmed
Return a Promise, for url link.
`scan` event will be emit when it will detect a new code status change.
### 2. Event: `login`
After the bot login full successful, the event `login` will be emitted, with a [Contact](#class-contact) of current logined user.
```javascript
bot.getLoginQrImgUrl()
.then(url=>{
// show url
bot.on('login',user=>{
console.log(`user ${user} logined`)
})
```
### Event: `message`
### 3. Event: `logout`
`logout` will be emitted when bot detected it is logout.
### 4. Event: `message`
Emit when there's a new message.
```javascript
bot.on('message',callback)
bot.on('message',message=>{
console.log('message ${message} received')
})
```
Callback will get an instance of Message Class. (see `Class Message`)
The `message` here is a [Message](#class-message).
### Event: `login` & `logout`
1. After the bot login full successful, the event `login` will be emitted.
1. After the bot logout, the event `logout` will be emitted.
## Class Message
All messages will be encaped in Message.
### Message.ready()
A message may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
## Class Wechaty
Main bot class.
Return a Promise, will be resolved when all data is ready.
```javascript
constbot=newWechaty()
```
### Wechaty.init()
Initialize the bot, return Promise.
```javascript
message.ready()
bot.init()
.then(()=>{
// Here we can be sure all the data is ready for use.
})
// do other staff with bot here
}
```
## Class Message
All wechat messages will be encaped as a Message.
### Message.get(prop)
Get prop from a message.
...
...
@@ -179,19 +201,21 @@ Supported prop list: the same as `get(prop)`
```javascript
message.set('content','Hello, World!')
```
## Class Contact
### Contact.ready()
A Contact may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
### Message.ready()
A message may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
```javascript
contact.ready()
message.ready()
.then(()=>{
// Here we can be sure all the data is ready for use.
})
```
## Class Contact
### Contact.get(prop)
Get prop from a contact.
...
...
@@ -210,20 +234,21 @@ Supported prop list:
contact.get('name')
```
## Class Group
### Group.ready()
A group may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
### Contact.ready()
A Contact may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
```javascript
group.ready()
contact.ready()
.then(()=>{
// Here we can be sure all the data is ready for use.
})
```
## Class Group
### Group.get(prop)
Get prop from a group.
...
...
@@ -238,19 +263,36 @@ Supported prop list:
```javascript
group.get('members').length
```
### Group.ready()
A group may be not fully initialized yet. Call `ready()` to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
```javascript
group.ready()
.then(()=>{
// Here we can be sure all the data is ready for use.
})
```
# Test
Wechaty use [TAP protocol](http://testanything.org/) to test itself by [tape](https://github.com/substack/tape).
Wechaty use [TAP protocol](http://testanything.org/) to test itself by [tap](http://www.node-tap.org/).
To test Wechaty, run:
```bash
$ npm test
```shell
npm test
```
Know more about tape: [Why I use Tape Instead of Mocha & So Should You](https://medium.com/javascript-scene/why-i-use-tape-instead-of-mocha-so-should-you-6aa105d8eaf4#.qxrrf2938)
Know more about TAP: [Why I use Tape Instead of Mocha & So Should You](https://medium.com/javascript-scene/why-i-use-tape-instead-of-mocha-so-should-you-6aa105d8eaf4#.qxrrf2938)
# Version History
## v0.1.0 (2016/???)
1. use event `scan` to show login qrcode image url(and detect state change)
2. new example: Tuling123 bot
3. more unit tests
4. ...
## v0.0.5 (2016/5/11)
1. Receive & send message
1. Show contacts info
...
...
@@ -259,8 +301,9 @@ Know more about tape: [Why I use Tape Instead of Mocha & So Should You](https://
