dotnet-wechaty (.NET Wechaty)

dotnet-wechaty (.NET Wechaty) is a Conversational SDK for chatbot makers written in C#

Connecting Chatbots

Wechaty is a RPA SDK for Wechat Individual Account that can help you create a chatbot in 6 lines of C#

Voice of the Developers

"Wechaty is a great solution, I believe there would be much more users recognize it." link
— @Gcaufy, Tencent Engineer, Author of WePY

"太好用，好用的想哭"
— @xinbenlv, Google Engineer, Founder of HaoShiYou.org

"最好的微信开发库" link
— @Jarvis, Baidu Engineer

"Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户，商业变现" link
— @lijiarui, Founder & CEO of Juzi.BOT.

"If you know js ... try Wechaty, it's easy to use."
— @Urinx Uri Lee, Author of WeixinBot(Python)

See more at Wiki:Voice Of Developer

History

dotnet-wechaty Versions

version: 0.2.0

1. sdk升级到net 5.0
2. Wechaty.Grpc 0.20.0
3. 更新grpc客户端nuget包为Grpc.Net.Client
4. Grpc.Net.Client Nuget Package
5. Microsoft docs for grpc

Join Us

Wechaty is used in many ChatBot projects by thousands of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code dotnet wechaty, join our Wechaty dotnet Developers' Home.

Scan now, because other Wechaty dotnet developers want to talk with you too! (secret code: dotnet wechaty)

The World's Shortest dotnet ChatBot: 7 lines of Code

C#

var wechaty = new Wechaty(options, logger).onScan((qrcode, status) => {
    Console.WriteLine($"Scan QR Code to login: {status} https://wechaty.github.io/qrcode/{(qrcode)}`");
}).OnLogin( user => {
    Console.WriteLine("User {user} logined");
}).OnMessage( message => {
    Console.WriteLine($"Message: {message}");
}).Start();

dotnet Wechaty Developing Plan

We already have Wechaty in TypeScript, It will be not too hard to translate the TypeScript(TS) to C# because wechaty has only 3,000 lines of the TS code, they are well designed and de-coupled by the wechaty-puppet abstraction. So after we have translated those 3,000 lines of TypeScript code, we will almost be done.

As we have already a ecosystem of Wechaty in TypeScript, so we will not have to implement everything in C#, especially, in the Feb 2020, we have finished the @chatie/grpc service abstracting module with the wechaty-puppet-hostie implmentation.

The following diagram shows out that we can reuse almost everything in TypeScript, and what we need to do is only the block located at the top right of the diagram: Wechaty (C#).

  +--------------------------+ +--------------------------+
  |                          | |                          |
  |   Wechaty (TypeScript)   | |      Wechaty (C#)        |
  |                          | |                          |
  +--------------------------+ +--------------------------+

  +-------------------------------------------------------+
  |                 Wechaty Puppet Hostie                 |
  |                                                       |
  |                (wechaty-puppet-hostie)                |
  +-------------------------------------------------------+

+---------------------  @chatie/grpc  ----------------------+

  +-------------------------------------------------------+
  |                Wechaty Puppet Abstract                |
  |                                                       |
  |                   (wechaty-puppet)                    |
  +-------------------------------------------------------+

  +--------------------------+ +--------------------------+
  |      Pad Protocol        | |      Web Protocol        |
  |                          | |                          |
  | wechaty-puppet-padplus   | |(wechaty-puppet-puppeteer)|
  +--------------------------+ +--------------------------+
  +--------------------------+ +--------------------------+
  |    Windows Protocol      | |       Mac Protocol       |
  |                          | |                          |
  | (wechaty-puppet-windows) | | (wechaty-puppet-macpro)  |
  +--------------------------+ +--------------------------+

Example: How to Translate TypeScript to C#

There's a 100 lines class named Image in charge of downloading the WeChat image to different sizes.

It is a great example for demonstrating how do we translate the TypeScript to C# in Wechaty Way:

Image Class Source Code

• TypeScript: https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
• C#: https://github.com/wechaty/dotnet-wechaty/blob/master/src/Wechaty/User/Image.cs

If you are interested in the translation and want to look at how it works, it will be a good start from reading and comparing those two Image class files in TypeScript and C# at the same time.

To-do List

• TS: TypeScript
• SLOC: Source Lines Of Code

Wechaty Internal Modules

1. Class Wechaty
   • TS SLOC(1160): https://github.com/wechaty/wechaty/blob/master/src/wechaty.ts
   • Code
   • Unit Tests
   • Documentation
2. Class Contact
   • TS SLOC(804): https://github.com/wechaty/wechaty/blob/master/src/user/contact.ts
   • Code
   • Unit Tests
   • Documentation
3. Class ContactSelf
   • TS SLOC(199): https://github.com/wechaty/wechaty/blob/master/src/user/contact-self.ts
   • Code
   • Unit Tests
   • Documentation
4. Class Message
   • TS SLOC(1054): https://github.com/wechaty/wechaty/blob/master/src/user/message.ts
   • Code
   • Unit Tests
   • Documentation
5. Class Room
   • TS SLOC(1194): https://github.com/wechaty/wechaty/blob/master/src/user/room.ts
   • Code
   • Unit Tests
   • Documentation
6. Class Image
   • TS SLOC(60): https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
   • Code
   • Unit Tests
   • Documentation
7. Class Accessory
   • TS SLOC(179): https://github.com/wechaty/wechaty/blob/master/src/accessory.ts
   • Code
   • Unit Tests
   • Documentation
8. Class Config
   • TS SLOC(187): https://github.com/wechaty/wechaty/blob/master/src/config.ts
   • Code
   • Unit Tests
   • Documentation
9. Class Favorite
   • TS SLOC(52): https://github.com/wechaty/wechaty/blob/master/src/user/favorite.ts
   • Code
   • Unit Tests
   • Documentation
10. Class Friendship
    • TS SLOC(417): https://github.com/wechaty/wechaty/blob/master/src/user/friendship.ts
    • Code
    • Unit Tests
    • Documentation
11. Class MiniProgram
    • TS SLOC(70): https://github.com/wechaty/wechaty/blob/master/src/user/mini-program.ts
    • Code
    • Unit Tests
    • Documentation
12. Class RoomInvitation
    • TS SLOC(317): https://github.com/wechaty/wechaty/blob/master/src/user/room-invitation.ts
    • Code
    • Unit Tests
    • Documentation
13. Class Tag
    • TS SLOC(190): https://github.com/wechaty/wechaty/blob/master/src/user/tag.ts
    • Code
    • Unit Tests
    • Documentation
14. Class UrlLink
    • TS SLOC(107): https://github.com/wechaty/wechaty/blob/master/src/user/url-link.ts
    • Code
    • Unit Tests
    • Documentation

Wechaty External Modules

1. Class FileBox
   • TS SLOC(638): https://github.com/huan/file-box/blob/master/src/file-box.ts
   • Code
   • Unit Tests
   • Documentation
2. Class MemoryCard
   • TS SLOC(376): https://github.com/huan/memory-card/blob/master/src/memory-card.ts
   • Code
   • Unit Tests
   • Documentation
3. Class WechatyPuppet
   • TS SLOC(1115): https://github.com/wechaty/wechaty-puppet/blob/master/src/puppet.ts
   • Code
   • Unit Tests
   • Documentation
4. Class WechatyPuppetHostie
   • TS SLOC(909): https://github.com/wechaty/wechaty-puppet-hostie/blob/master/src/client/puppet-hostie.ts
   • Code
   • Unit Tests
   • Documentation

Usage

WIP...

Requirements

1. .NET Core 3.1+

Install

Dependencies Restore

dotnet restore ./src/Wechaty.sln

History

master

v0.1 (Oct 28, 2020)

1. Decided to merged Jesn's implementation of .Net Wechaty to this one. (#4)

v0.0.1 (Jul 20, 2020)

1. Project created.
2. Welcome our first dotnet-wechaty contributor:
   • echofool https://github.com/echofool (https://github.com/wechaty/dotnet-wechaty)

Related Projects

• Wechaty - Conversatioanl AI Chatot SDK for Wechaty Individual Accounts (TypeScript)
• .NET Core Wechaty - .NET Core Wechaty Conversational AI Chatbot SDK for Wechat Individual Accounts (C#)
• Go Wechaty - Go Wechaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Go)
• Java Wechaty - Java Wechaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)
• Scala Wechaty - Scala Wechaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)
• PHP Wechaty - PHP Wechaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (PHP)

Badge

[![.NET Wechaty](https://img.shields.io/badge/Wechaty-.NET-blueviolet)](https://github.com/wechaty/dotnet-wechaty)

Contributors

1. @echofool - echofool

Creators

• @echofool - echofool
• @Jesn - Darren

Copyright & License

• Code & Docs © 2020 Wechaty Contributors https://github.com/wechaty
• Code released under the Apache-2.0 License
• Docs released under Creative Commons