Synapse Bot

Table of Content

• About
• Installation
  • Dependencies
  • Discord Bot
  • Twitch App
  • Initialization
• Usage
  • Twitch
  • Docker
• Licence

About

Note

A Twitch App & Discord Bot that links Twich Chat with a Discord Channel

Warning

This is the Rust version. If you want to see the JavaScript version, check the JS branch.

Installation

Dependencies

Important

Make sure to have Docker & Docker Compose installed.

Discord Bot

Important

Make a Discord Bot on the Discord Developper Portal.

Then, invite it to your Discord server.

Twitch App

Important

Make a Twitch App on the Twitch Console.

Then, make an oauth token in Twitch Token Generator (you must be connected with your App's account).

Initialization

Note

Clone the repo somewhere and make a .env file at the root of the repository that contains the followig variables.

Tip

Exemple of a .env file :

TWITCH_BOT_USERNAME="your-twitch-bot-username"
TWITCH_OAUTH_TOKEN="oauth:your-twitch-oauth-token"
TWITCH_CHANNEL="streamers-channel-name"
DISCORD_BOT_TOKEN="your-discord-bot-token"
DISCORD_CHANNEL_ID="your-discord-channel-id"

Usage

Twitch

Tip

Mod the app on your Twitch Chat to make Twitch API prioritize the App (optionnal).

/mod your-twitch-bot-username

Docker

Note

Run both the Twitch App & Discord Bot with Docker Compose.

docker-compose up

Licence

MIT