Everything you need to know about Wechaty.
Are you new to Wechaty or to programming? This is the place to start!
- From scratch: Quick start | Installation
- Tutorial: Live coding for beginners | Use Docker with Wechaty
- Advanced tutorials: Getting started with Wechaty the hard way
Having trouble? We'd like to help!
- Try the FAQ - it's got answers to many common questions.
- Looking for specific information? Try the Google search or Bing search!
- Not found anything? See FAQ: Getting help for information on getting support and asking questions to the community.
- Report bugs with Wechaty in our GitHub issues
Wechaty has a lot of documentation. A high-level overview of how it's organized will help you know where to look for certain things:
- Tutorials take you by the hand through a series of steps to create a Chatbot application. Start here if you are new to Wechaty or Chatbot application development. Also look at the "First steps".
- Explainations discuss key topics and concepts at a fairly high level and provide useful background information and explanation.
- Reference guides contain technical reference for APIs and other aspects of Wechaty's machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.
- How-to gtuides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how Wechaty works.
Wechaty provides an abstraction layer for structuring and manipulating the data of your Chatbot application. Learn more about it below:
- Wechaty Wechaty
- User Classes Message | Contact | ContactSelf | Room | Friendship | FileBox | RoomInvitation
Wechaty has the concept of "Puppet" to encapsulate the logic responsible for processing a IM's request and for returning the responses. Find all you need to know about puppets via the links below:
- The basics:Puppet specification | Providers
- Providers: WeChat | Whatsapp | Lark | WeChat Official Account | etc
- Advanced: Do-it-yourself: Create your Wechaty Puppet Provider
The service layer provides a multi-language frinedly way for re-using the source code across the programming languages. Learn how this service can be used by users and how it can be extended by programmers:
- The basics: Service specification | Services
- Services: WeWork | PadLocal | Paimon | Donut
- Advanced: Do-it-yourself: Create your Wechaty Puppet Service
Wechaty provides SDK in lots of programming languages, developed from the community, to the community, and for the community!
- The overview: Polyglot Wechaty
- Programming Languages: OpenAPI | TypeScript | Python | Go | Java | Scala | PHP ｜ .NET ｜ Rust
Learn about the various components and tools to help you in the development and testing of Wechaty chatbot applications:
- FileBox: helper module for easy processing files between the local filesystem and the network.
- Brolog: helper module for easy logging between the Node.js and the Browser environments. (Angular Dependency Injection supported)
- FlashStore: helper module for key-value persistant storage in both Node.js local filesystem and Browser(tbw). Follows the ES6 Map API.
- MemoryCard: help module for key-value persistant storage in cloud. (should be a cloud native module in the future). Follows the ES6 Map API.
Learn about some other core functionalities of the Wechaty:
Learn about the development process for the Wechaty project itself and about how you can contribute:
- Commmunity: How to get involved | Team organization | The Wechaty source code repository | Mailing lists | Gitter.im channel | Wechaty contributor program
- Documentation: About this documentation
- Wechaty over time: Release notes
You can join our Gitter network if you aren’t already a member.