Skip to content

W
wechaty

.www. / wechaty
与 Fork 源项目一致

Fork自 wechaty / wechaty

通知 1
Star 0
Fork 0
W
wechaty

体验新版 GitCode，发现更多精彩内容 >>

提交 df9c7aaf 编写于 作者: Huan (李卓桓)'s avatar Huan (李卓桓)
浏览文件
操作

chore(doc): add voice from @Gcaufy and rename Wechaty to Chatie

上级 26c57e68
隐藏空白更改
内联 并排
Showing with 76 addition and 73 deletion
README.md
浏览文件 @ df9c7aaf
[![Wechaty](https://raw.githubusercontent.com/wechaty/wechaty/master/image/wechaty-logo-en.png)](https://github.com/wechaty/wechaty)
[![Wechaty](https://raw.githubusercontent.com/Chatie/wechaty/master/image/wechaty-logo-en.png)](https://github.com/Chatie/wechaty)
# Wechaty
## Connecting ChatBots.
Wechaty is a Bot Framework for Wechat **Personal** Account which can help you create a bot in 6 lines of javascript by easy to use API, with cross-platform support include [Linux](https://travis-ci.org/wechaty/wechaty), [Windows](https://ci.appveyor.com/project/wechaty/wechaty), [Darwin(OSX/Mac)](https://travis-ci.org/wechaty/wechaty) and [Docker](https://circleci.com/gh/wechaty/wechaty).
Wechaty is a Bot Framework for Wechat **Personal** Account which can help you create a bot in 6 lines of javascript by easy to use API, with cross-platform support include [Linux](https://travis-ci.org/Chatie/wechaty), [Windows](https://ci.appveyor.com/project/Chatie/wechaty), [Darwin(OSX/Mac)](https://travis-ci.org/Chatie/wechaty) and [Docker](https://circleci.com/gh/Chatie/wechaty).
[![Join the chat at https://gitter.im/zixia/wechaty](https://badges.gitter.im/zixia/wechaty.svg)](https://gitter.im/zixia/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![node](https://img.shields.io/node/v/wechaty.svg?maxAge=604800)](https://nodejs.org/) [![Repo Size](https://reposs.herokuapp.com/?path=wechaty/wechaty)](https://github.com/wechaty/wechaty) [![Issue Stats](http://issuestats.com/github/wechaty/wechaty/badge/pr)](http://issuestats.com/github/wechaty/wechaty) [![Issue Stats](http://issuestats.com/github/wechaty/wechaty/badge/issue)](http://issuestats.com/github/wechaty/wechaty)
[![Join the chat at https://gitter.im/zixia/wechaty](https://badges.gitter.im/zixia/wechaty.svg)](https://gitter.im/zixia/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![node](https://img.shields.io/node/v/wechaty.svg?maxAge=604800)](https://nodejs.org/) [![Repo Size](https://reposs.herokuapp.com/?path=Chatie/wechaty)](https://github.com/Chatie/wechaty) [![Issue Stats](http://issuestats.com/github/Chatie/wechaty/badge/pr)](http://issuestats.com/github/Chatie/wechaty) [![Issue Stats](http://issuestats.com/github/Chatie/wechaty/badge/issue)](http://issuestats.com/github/Chatie/wechaty)
:octocat: <https://github.com/wechaty/wechaty>
:beetle: <https://github.com/wechaty/wechaty/issues>
:book: <https://github.com/wechaty/wechaty/wiki>
:octocat: <https://github.com/Chatie/wechaty>
:beetle: <https://github.com/Chatie/wechaty/issues>
:book: <https://github.com/Chatie/wechaty/wiki>
:whale: <https://hub.docker.com/r/zixia/wechaty>
## Voice of the Developer
> "The best wechat SDK I have seen in Github!" [link](https://github.com/wechaty/wechaty/issues/8#issuecomment-228971491)
> "The best wechat SDK I have seen in Github!" [link](https://github.com/Chatie/wechaty/issues/8#issuecomment-228971491)
> -- @JasLin, BotWave CTO
> "Wechaty简单的接口...和Docker化的封装...绝对是一个不错的选择" [link](http://mp.weixin.qq.com/s/o-4VMcAMz0K8yJVdNaUXow)
> -- @shevyan, Ghost Cloud CEO
> "Wechaty is great." [link](https://github.com/wechaty/wechaty/issues/36#issuecomment-251708382)
> "Wechaty is a great solution, I believe there would be much more users recognize it." [link](https://github.com/Chatie/wechaty/pull/310#issuecomment-285574472)
> -- @Gcaufy, Tencent
> "Wechaty is great." [link](https://github.com/Chatie/wechaty/issues/36#issuecomment-251708382)
> -- @Samurais, SnapLingo Director of Engineering
> "最好的微信开发库" [link](http://weibo.com/3296245513/Ec4iNp9Ld?type=comment)
......@@ -32,13 +35,13 @@ Wechaty is a Bot Framework for Wechat **Personal** Account which can help you cr
> "太好用，好用的想哭" -- @xinbenlv, Google Engineer, HaoShiYou.org Founder
> "Wechaty library fantastic!" [link](https://github.com/wechaty/wechaty/issues/9) - @ccaapton
> "Wechaty library fantastic!" [link](https://github.com/Chatie/wechaty/issues/9) - @ccaapton
> "it's quite cool!" [link](https://github.com/wechaty/wechaty/issues/4) - @ak5
> "it's quite cool!" [link](https://github.com/Chatie/wechaty/issues/4) - @ak5
> "Thanks for great SDK" [link](https://github.com/wechaty/wechaty/issues/57) - @naishstar
> "Thanks for great SDK" [link](https://github.com/Chatie/wechaty/issues/57) - @naishstar
> "Your docker solution is awesome!" [link](https://github.com/wechaty/wechaty/issues/164#issuecomment-278633203) - @ax4
> "Your docker solution is awesome!" [link](https://github.com/Chatie/wechaty/issues/164#issuecomment-278633203) - @ax4
# The World's Shortest ChatBot Code: 6 lines of JavaScript
......@@ -55,7 +58,7 @@ Wechaty.instance() // Singleton
This bot can log all message to console.
You can find more example from [Wiki](https://github.com/wechaty/wechaty/wiki/Example) and [Example Directory](https://github.com/wechaty/wechaty/blob/master/example/).
You can find more example from [Wiki](https://github.com/Chatie/wechaty/wiki/Example) and [Example Directory](https://github.com/Chatie/wechaty/blob/master/example/).
# Getting Started
......@@ -88,81 +91,81 @@ $ docker run -ti --rm --volume="$(pwd)":/bot zixia/wechaty mybot.js
> Wechaty Docker support to run TypeScript directly as well: just write in TypeScript and save to `mybot.ts`.
Get to know more about Wechaty Docker at [Wiki:Docker](https://github.com/wechaty/wechaty/wiki/Docker).
Get to know more about Wechaty Docker at [Wiki:Docker](https://github.com/Chatie/wechaty/wiki/Docker).
### NPM
[![NPM Version](https://badge.fury.io/js/wechaty.svg)](https://badge.fury.io/js/wechaty) [![Downloads][downloads-image]][downloads-url]
Get to know more about NPM at [Wiki:NPM](https://github.com/wechaty/wechaty/wiki/NPM)
Get to know more about NPM at [Wiki:NPM](https://github.com/Chatie/wechaty/wiki/NPM)
# API Reference
## [Wechaty Event](https://github.com/wechaty/wechaty/wiki/API#event)
## [Wechaty Event](https://github.com/Chatie/wechaty/wiki/API#event)
1. [scan](https://github.com/wechaty/wechaty/wiki/API#1-event-scan) Emit when the bot needs to show you a QR Code for scanning
2. [login](https://github.com/wechaty/wechaty/wiki/API#2-event-login) Emit when bot login full successful.
3. [logout](https://github.com/wechaty/wechaty/wiki/API#3-event-logout) Emit when bot detected log out.
4. [message](https://github.com/wechaty/wechaty/wiki/API#4-event-message) Emit when there's a new message.
5. [error](https://github.com/wechaty/wechaty/wiki/API#5-event-error) Emit when there's an error occurred.
6. [friend](https://github.com/wechaty/wechaty/wiki/API#6-event-friend) Emit when got a new friend request, or friendship is confirmed.
7. [room-join](https://github.com/wechaty/wechaty/wiki/API#7-event-room-join) Emit when someone join the room
8. [room-leave](https://github.com/wechaty/wechaty/wiki/API#8-event-room-leave) Emit when someone leave the room
9. [room-topic](https://github.com/wechaty/wechaty/wiki/API#9-event-room-topic) Emit when someone change the room's topic
1. [scan](https://github.com/Chatie/wechaty/wiki/API#1-event-scan) Emit when the bot needs to show you a QR Code for scanning
2. [login](https://github.com/Chatie/wechaty/wiki/API#2-event-login) Emit when bot login full successful.
3. [logout](https://github.com/Chatie/wechaty/wiki/API#3-event-logout) Emit when bot detected log out.
4. [message](https://github.com/Chatie/wechaty/wiki/API#4-event-message) Emit when there's a new message.
5. [error](https://github.com/Chatie/wechaty/wiki/API#5-event-error) Emit when there's an error occurred.
6. [friend](https://github.com/Chatie/wechaty/wiki/API#6-event-friend) Emit when got a new friend request, or friendship is confirmed.
7. [room-join](https://github.com/Chatie/wechaty/wiki/API#7-event-room-join) Emit when someone join the room
8. [room-leave](https://github.com/Chatie/wechaty/wiki/API#8-event-room-leave) Emit when someone leave the room
9. [room-topic](https://github.com/Chatie/wechaty/wiki/API#9-event-room-topic) Emit when someone change the room's topic
## [Wechaty](https://github.com/wechaty/wechaty/wiki/API#wechaty-class)
## [Wechaty](https://github.com/Chatie/wechaty/wiki/API#wechaty-class)
1. [instance(setting: PuppetSetting): Promise&lt;Wechaty&gt;](https://github.com/wechaty/wechaty/wiki/API#wechatyinstanceprofilestring-wechaty) get the bot instance
2. [init(): Promise&lt;void&gt;](https://github.com/wechaty/wechaty/wiki/API#wechatyinit-wechaty) Initialize the bot
3. [send(message: Message): Promise&lt;void&gt;](https://github.com/wechaty/wechaty/wiki/API#wechatysendmessage-message-wechaty) send a message
4. [say(content: string): Promise&lt;void&gt;](https://github.com/wechaty/wechaty/wiki/API#wechatysaycontent-string) send message to filehelper, just for logging/reporting usage for your convenience
1. [instance(setting: PuppetSetting): Promise&lt;Wechaty&gt;](https://github.com/Chatie/wechaty/wiki/API#wechatyinstanceprofilestring-wechaty) get the bot instance
2. [init(): Promise&lt;void&gt;](https://github.com/Chatie/wechaty/wiki/API#wechatyinit-wechaty) Initialize the bot
3. [send(message: Message): Promise&lt;void&gt;](https://github.com/Chatie/wechaty/wiki/API#wechatysendmessage-message-wechaty) send a message
4. [say(content: string): Promise&lt;void&gt;](https://github.com/Chatie/wechaty/wiki/API#wechatysaycontent-string) send message to filehelper, just for logging/reporting usage for your convenience
## [Message](https://github.com/wechaty/wechaty/wiki/API#message-class)
## [Message](https://github.com/Chatie/wechaty/wiki/API#message-class)
1. [from():Contact](https://github.com/wechaty/wechaty/wiki/API#1-messagefrom-contact) get the sender from a message
2. [from(contact:Contact):void](https://github.com/wechaty/wechaty/wiki/API#2-messagefromcontact-contact-void) set a sender to the message
4. [to():Contact](https://github.com/wechaty/wechaty/wiki/API#1-messageto-contact) get the destination of the message
5. [to(contact:Contact):void](https://github.com/wechaty/wechaty/wiki/API#2-messagetocontact-contact-void) set the destination as contact for the message
7. [content():string](https://github.com/wechaty/wechaty/wiki/API#1-messagecontent-string) get the content of the message
8. [content(content:string):string](https://github.com/wechaty/wechaty/wiki/API#2-messagecontentcontent-string-string) set the content for the message
9. [room():Room|null](https://github.com/wechaty/wechaty/wiki/API#1-messageroom-room--null) get the room from a message.
10. [room(room:Room):void](https://github.com/wechaty/wechaty/wiki/API#2-messageroomroom-room-void) set the room for a message.
12. [type():MsgType](https://github.com/wechaty/wechaty/wiki/API#messagetype-number) get the type of a Message.
13. [say(content:string):Promise](https://github.com/wechaty/wechaty/wiki/API#messagesaycontent-string-promise) reply a message to the sender.
14. [ready():Promise](https://github.com/wechaty/wechaty/wiki/API#messageready-promise) confirm get all the data needed, will be resolved when all message data is ready.
15. [self():boolean](https://github.com/wechaty/wechaty/wiki/API#messageselfmessage-message-boolean) check if a message is sent by self
1. [from():Contact](https://github.com/Chatie/wechaty/wiki/API#1-messagefrom-contact) get the sender from a message
2. [from(contact:Contact):void](https://github.com/Chatie/wechaty/wiki/API#2-messagefromcontact-contact-void) set a sender to the message
4. [to():Contact](https://github.com/Chatie/wechaty/wiki/API#1-messageto-contact) get the destination of the message
5. [to(contact:Contact):void](https://github.com/Chatie/wechaty/wiki/API#2-messagetocontact-contact-void) set the destination as contact for the message
7. [content():string](https://github.com/Chatie/wechaty/wiki/API#1-messagecontent-string) get the content of the message
8. [content(content:string):string](https://github.com/Chatie/wechaty/wiki/API#2-messagecontentcontent-string-string) set the content for the message
9. [room():Room|null](https://github.com/Chatie/wechaty/wiki/API#1-messageroom-room--null) get the room from a message.
10. [room(room:Room):void](https://github.com/Chatie/wechaty/wiki/API#2-messageroomroom-room-void) set the room for a message.
12. [type():MsgType](https://github.com/Chatie/wechaty/wiki/API#messagetype-number) get the type of a Message.
13. [say(content:string):Promise](https://github.com/Chatie/wechaty/wiki/API#messagesaycontent-string-promise) reply a message to the sender.
14. [ready():Promise](https://github.com/Chatie/wechaty/wiki/API#messageready-promise) confirm get all the data needed, will be resolved when all message data is ready.
15. [self():boolean](https://github.com/Chatie/wechaty/wiki/API#messageselfmessage-message-boolean) check if a message is sent by self
## [Contact](https://github.com/wechaty/wechaty/wiki/API#contact-class)
## [Contact](https://github.com/Chatie/wechaty/wiki/API#contact-class)
2. [name():string](https://github.com/wechaty/wechaty/wiki/API#contactname-string) get name from a contact
3. [remark():string](https://github.com/wechaty/wechaty/wiki/API#contactremark-string) get remark name from a contact
4. [remark(remark:string):Promise](https://github.com/wechaty/wechaty/wiki/API#contactremarkremark-string-promise) set remark name to a contact
5. [weixin():string](https://github.com/wechaty/wechaty/wiki/API#contactweixin-string) get weixin id from a contact
6. [star():boolean](https://github.com/wechaty/wechaty/wiki/API#contactstar-boolean) true for star friend, false for no star friend
7. [ready():Promise](https://github.com/wechaty/wechaty/wiki/API#contactready-promise) confirm get all the contact data needed, will be resolved when all data is ready
8. [say(content:string):Promise](https://github.com/wechaty/wechaty/wiki/API#contactsaycontent-string-promise) say content to a contact
2. [name():string](https://github.com/Chatie/wechaty/wiki/API#contactname-string) get name from a contact
3. [remark():string](https://github.com/Chatie/wechaty/wiki/API#contactremark-string) get remark name from a contact
4. [remark(remark:string):Promise](https://github.com/Chatie/wechaty/wiki/API#contactremarkremark-string-promise) set remark name to a contact
5. [weixin():string](https://github.com/Chatie/wechaty/wiki/API#contactweixin-string) get weixin id from a contact
6. [star():boolean](https://github.com/Chatie/wechaty/wiki/API#contactstar-boolean) true for star friend, false for no star friend
7. [ready():Promise](https://github.com/Chatie/wechaty/wiki/API#contactready-promise) confirm get all the contact data needed, will be resolved when all data is ready
8. [say(content:string):Promise](https://github.com/Chatie/wechaty/wiki/API#contactsaycontent-string-promise) say content to a contact
## [Room](https://github.com/wechaty/wechaty/wiki/API#class-room)
## [Room](https://github.com/Chatie/wechaty/wiki/API#class-room)
1. [say(content:string,replyTo:Contact|ContactArray):Promise](https://github.com/wechaty/wechaty/wiki/API#roomsaycontent-string-replyto-contactcontact-promise) say content inside Room.
2. [ready():Promise](https://github.com/wechaty/wechaty/wiki/API#roomready-promise) confirm get all the data needed, will be resolved when all data is ready
3. [refresh():Promise](https://github.com/wechaty/wechaty/wiki/API#roomrefresh-promise) reload data for Room
1. [say(content:string,replyTo:Contact|ContactArray):Promise](https://github.com/Chatie/wechaty/wiki/API#roomsaycontent-string-replyto-contactcontact-promise) say content inside Room.
2. [ready():Promise](https://github.com/Chatie/wechaty/wiki/API#roomready-promise) confirm get all the data needed, will be resolved when all data is ready
3. [refresh():Promise](https://github.com/Chatie/wechaty/wiki/API#roomrefresh-promise) reload data for Room
### [Room Event](https://github.com/wechaty/wechaty/wiki/API#room-events)
### [Room Event](https://github.com/Chatie/wechaty/wiki/API#room-events)
1. [join](https://github.com/wechaty/wechaty/wiki/API#event-join) Emit when someone join the room
2. [leave](https://github.com/wechaty/wechaty/wiki/API#event-leave) Emit when someone leave the room
3. [topic](https://github.com/wechaty/wechaty/wiki/API#event-topic) Emit when someone change the room topic
1. [join](https://github.com/Chatie/wechaty/wiki/API#event-join) Emit when someone join the room
2. [leave](https://github.com/Chatie/wechaty/wiki/API#event-leave) Emit when someone leave the room
3. [topic](https://github.com/Chatie/wechaty/wiki/API#event-topic) Emit when someone change the room topic
## [FriendRequest](https://github.com/wechaty/wechaty/wiki/API#class-friendrequest)
## [FriendRequest](https://github.com/Chatie/wechaty/wiki/API#class-friendrequest)
1. [hello:string](https://github.com/wechaty/wechaty/wiki/API#friendrequesthello-string) get content from friendrequest
2. [accept():Promise](https://github.com/wechaty/wechaty/wiki/API#friendrequestaccept-void) accept the friendrequest
3. [send(contact:Contact,hello:string):Promise](https://github.com/wechaty/wechaty/wiki/API#friendrequestsendcontact-contact-hello-string-void) send a new friend request
1. [hello:string](https://github.com/Chatie/wechaty/wiki/API#friendrequesthello-string) get content from friendrequest
2. [accept():Promise](https://github.com/Chatie/wechaty/wiki/API#friendrequestaccept-void) accept the friendrequest
3. [send(contact:Contact,hello:string):Promise](https://github.com/Chatie/wechaty/wiki/API#friendrequestsendcontact-contact-hello-string-void) send a new friend request
# Test
[![Linux/Mac Build Status](https://img.shields.io/travis/wechaty/wechaty.svg?label=Linux/Mac)](https://travis-ci.org/wechaty/wechaty) [![Windows Build status](https://img.shields.io/appveyor/ci/wechaty/wechaty/master.svg?label=Windows)](https://ci.appveyor.com/project/wechaty/wechaty) [![Docker CircleCI](https://img.shields.io/circleci/project/github/wechaty/wechaty.svg?label=Docker)](https://circleci.com/gh/wechaty/wechaty) [![Coverage Status](https://coveralls.io/repos/github/wechaty/wechaty/badge.svg?branch=master)](https://coveralls.io/github/wechaty/wechaty?branch=master) [![Known Vulnerabilities](https://snyk.io/test/github/wechaty/wechaty/badge.svg)](https://snyk.io/test/github/wechaty/wechaty)
[![Linux/Mac Build Status](https://img.shields.io/travis/Chatie/wechaty.svg?label=Linux/Mac)](https://travis-ci.org/Chatie/wechaty) [![Windows Build status](https://img.shields.io/appveyor/ci/Chatie/wechaty/master.svg?label=Windows)](https://ci.appveyor.com/project/Chatie/wechaty) [![Docker CircleCI](https://img.shields.io/circleci/project/github/Chatie/wechaty.svg?label=Docker)](https://circleci.com/gh/Chatie/wechaty) [![Coverage Status](https://coveralls.io/repos/github/Chatie/wechaty/badge.svg?branch=master)](https://coveralls.io/github/Chatie/wechaty?branch=master) [![Known Vulnerabilities](https://snyk.io/test/github/Chatie/wechaty/badge.svg)](https://snyk.io/test/github/Chatie/wechaty)
Wechaty use [AVA](https://github.com/avajs/ava) for unit testing
......@@ -171,30 +174,30 @@ To test Wechaty, run:
npm test
```
Get to know more about test from [Wiki:Test](https://github.com/wechaty/wechaty/wiki/Test)
Get to know more about test from [Wiki:Test](https://github.com/Chatie/wechaty/wiki/Test)
# Release Notes
* [Latest Release](https://github.com/wechaty/wechaty/releases/latest)(All releases [here](https://github.com/wechaty/wechaty/releases))
* [Changelog](https://github.com/wechaty/wechaty/blob/master/CHANGELOG.md)
* [Latest Release](https://github.com/Chatie/wechaty/releases/latest)(All releases [here](https://github.com/Chatie/wechaty/releases))
* [Changelog](https://github.com/Chatie/wechaty/blob/master/CHANGELOG.md)
# Powered By Wechaty
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/wechaty)
[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/Chatie/wechaty)
## Wechaty Badge
Get embed html/markdown code from [Wiki:PoweredByWechaty](https://github.com/wechaty/wechaty/wiki/PoweredByWechaty)
Get embed html/markdown code from [Wiki:PoweredByWechaty](https://github.com/Chatie/wechaty/wiki/PoweredByWechaty)
## Projects Use Wechaty
1. [Wechaty.io](https://www.wechaty.io) ChatBot Portal Manager for Wechaty
Know more about Projects Use Wechaty at [Wiki:PoweredByWechaty](https://github.com/wechaty/wechaty/wiki/PoweredByWechaty)
Know more about Projects Use Wechaty at [Wiki:PoweredByWechaty](https://github.com/Chatie/wechaty/wiki/PoweredByWechaty)
# Contributing
Howto [contribute](https://github.com/wechaty/wechaty/blob/master/CONTRIBUTING.md)
Howto [contribute](https://github.com/Chatie/wechaty/blob/master/CONTRIBUTING.md)
Contributions in any form are highly encouraged and welcome! Be it new or improved presets, optimized streaming code or just some cleanup. So start forking!
......@@ -222,13 +225,13 @@ You can directly submit pull requests for documentation changes.
Scan the following QR Code in WeChat, with secret code _wechaty_, you can join our **Wechaty Developers' Home**.
![Wechaty Developers' Home](https://raw.githubusercontent.com/wechaty/wechaty/master/image/BotQrcode.png)
![Wechaty Developers' Home](https://raw.githubusercontent.com/Chatie/wechaty/master/image/BotQrcode.png)
Scan now, then you can chat with other Wechaty developers! (secret code: _wechaty_)
# See Also
* [RelatedProject](https://github.com/wechaty/wechaty/wiki/RelatedProject)
* [RelatedProject](https://github.com/Chatie/wechaty/wiki/RelatedProject)
# Todo
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或