matrix-twitch-bridge

Matrix <--> Twitch Bridge

This is an Twitch bridge for Matrix using the Application Services (AS) API.

This bridge will pass all TwitchChannel messages through to Matrix, and all Matrix messages through to the Twitch Channel.

How to reach the owner

MATRIX ROOM: #twitch-puppet-bridge:matrix.ffslfl.net

Setup

1. Installation

To install all dependencies and add a binary matrix-twitch-bridge:

go get -u -v github.com/mattn/go-sqlite3  # Required for the Database
go get -u -v github.com/Nordgedanken/matrix-twitch-bridge

Requirements

• Golang
• A Matrix homeserver you control running Synapse v0.18.5-rc3 or above.
• A registered Twitch App

2. Configuration and Registration

The bridge must be configured before it can be run. This tells the bridge where to find the homeserver and how to bridge Twitch channels/users.

• Run matrix-twitch-bridge and follow the interactive Terminal Guide

3. Running

Finally, the bridge can be run using the following command:

matrix-twitch-bridge --client_id=<client_id from your Twitch App> --client_secret=<client_secret from your Twitch App> --public_adress=<ip with port used for the login callback> --bot_accessToken=<oauth token of a twitch user used to listen to chats> --bot_username=<matching username> --tls_cert=<path to .crt ssl file used for the login Server> --tls_key=<matching key file>

If you have changed the default config location add the --config (or -c) flag to the above command.

If you want to change the DB location add the --database (or -db) flag to the above command.

What does it do

On startup, it will listen for incoming Twitch messages and forward them through to Matrix rooms. Each real Matrix user is represented by an Twitch client, and each real Twitch client is represented by a Matrix user. Full Two-Way communication in channels and PMs are supported. The Matrix users require to login first on Twitch before wrinting in Portal Rooms

Usage

To join a channel on Twitch:

• Join a room with the alias #<alias_prefix><channel_name>:<homeserver_hosting_the_appservice> e.g. #twitch_hc_dizee:example.com. The template for this can be configured using the interactive config generator.

To send a Whisper to someone on Twitch:

• Start a conversation with a user ID @<user_prefix><channel_name>:<homeserver_hosting_the_appservice> e.g. @twitch_hc_dizee:example.com. The template for this can be configured using the interactive config generator.

Contributing

Please see the CONTRIBUTING file for information on contributing.

License