Matrix-appservice-wechaty NPM

MATRIX-APPSERVICE-WECHATY

Matrix + Wechaty

Photo credit: Matrix Club

Matrix Application Services Wechaty Bridge for Wechat Individual Accounts

UNDER CONSTRUCTING

INTRO

Integrate Wechat with Matrix with the power of Wechaty #1737

Matrix is like Pidgin on your Phone.
Pidgin try to IM all your friends in one place in Linux, and with Matrix you can have your Phone clinet with your private server which is highly customized. Matrix did not use XMPP protocol, it's server uses REST so that it could be more easy to extend.
This week I had a great talk with YC partner Eric @ericmigi, who is a serial entrepreneur and also a geek with technology. He uses Matrix a lot and almost integrated all the instance messanger to his Matrix.
But, the matrix does not support Wechat yet. So we'd like to introduce a matrix-wechat bridge to implement the Wechat protocol, and fill the gap between Matrix and Wechat.
@ericmigi provide some links that will help us to kick off a starter, hope we could make a workable POC soon, and any contribution will be welcome.
homeserver install in 1 hr
examples of puppet bridges
-- Apr 2019

@tulir has very rich experiences with building the matrix bridges such as:
A Matrix-Telegram hybrid puppeting/relaybot bridge
A Matrix-WhatsApp puppeting bridge
-- May 2019

HOW TO USE MATRIX

I'd like to recommend using Riot for using Matrix. Riot is a universal secure chat app entirely under your control. It supports all types of the platforms, including Web/Browser, Android, and iPhone.

USAGE

Authentication

This part is "steal" from https://github.com/tulir/mautrix-whatsapp/wiki/Authentication

Logging in

Start a chat with the bridge bot. The bot should say "This room has been registered as your bridge management/status room." if you started the chat correctly.
Run login
Log in by scanning the QR code. If the code expires before you scan it, the bridge will send an error to notify you.
1. Open Wechat on your phone.
2. Tap Menu or Settings and select Scan.
3. Point your phone at the image sent by the bot to capture the code.
Finally, the bot should inform you of a successful login and the bridge should start creating portal rooms for all your Wechat groups and private chats.

Logging out

Simply run the logout management command.

HISTORY

master

v0.2 July 2019

Enable your matrix account to start using matrix-appservice-wechaty by talk to the bot @wechaty:your.domain
After you talk to @wechaty, it will send you Wechat Login QR Code. Scan it to login Wechat
All Wechat messages will be bridged to the Matrix system, in the room that you talk to the bot at the very first time.

v0.0.1 May 2019

Auto response the message in a Matrix Room.

DISCLAIMER

Copied from disclaimer part from matrix-appservice-discord:

I accept no responsibility if Tencent ban your IP, Account or even your details on their system. They have never given official support on custom clients.