Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrmysterius/catchmelive

Minimal Space Usage Twitch Live Checker and Discord Notifier written in GO
https://github.com/mrmysterius/catchmelive

discord go golang live livestream notifications notify twitch webhook

Last synced: about 2 months ago
JSON representation

Minimal Space Usage Twitch Live Checker and Discord Notifier written in GO

Awesome Lists containing this project

README

        

# CatchMeLive
> Minimal Space Usage Live Checker and Discord Notifier for Twitch written in GO

Checks the live status of a Twitch Channel and if live sends a Discord Message through a Webhook which will get also get updated periodically.

My main goal for this was to make it very minimal so it has only what is necessary and I wanted to learn go a bit more.

Now the image Docker produces is about +-8mb which is pretty ~~average~~ small if have to say so myself

## Prerequisites

- Knowledge of Docker
- You will need a Confidential Application on Twitch https://dev.twitch.tv/console
- Discord Webhook

## Installation / Usage

- Clone this Repo `git clone https://github.com/MrMysterius/CatchMeLive.git`
- Edit the docker-compose.yml to include all the required environment variable values (TWITCH_CLIENT_ID, TWITCH_CLIENT_SECRET, TWITCH_CHANNEL_NAME, DISCORD_WEBHOOK_URL)
- Launch it `docker compose up -d`

## Live Message

The live message can include the following placeholders:

PLACEHOLDER | DESCRIPTION
--- | ---
{CHANNEL_NAME} | Replaces the text with the name of the channel
{GAME} | Replaces the text with the name of the game/category of the stream
{TITLE} | Replaces the text with the title of the stream