Stream Overlay

ToC

• Stream Overlay
  • ToC
  • TL;DR;
  • Getting started
  • Docker
  • Logging
  • FaQ
  • Commands
  • Workflows
    • Publish Docker Image
    • Deploy Image

TL;DR;

Tip

If the application is already online but the current access token has expired, you can follow these steps to issue a new token and restart the event listener.

1. Log in to the page https://overlay.tools.tklein.it/auth/login?password=<ENDPOINT_PASSWORD>.
2. Then visit this page https://overlay.tools.tklein.it/app/start?password=<ENDPOINT_PASSWORD>. You should be redirected and receive a message that the chatbot and event listener have been started.

Getting started

1. Clone the repository

   git clone git@github.com:PanthorDE/stream-overlay.git

2. Set all required environment-variables as defined in the .env.example

3. Install all required dependencies

   npm install

4. Start your application

   npm run start
   # or start the dev-build
   npm run dev

Docker

1. Pull the image

   docker pull ghcr.io/tklein1801/stream-overlay:latest

2. Start an container

   docker run -itd -v test-volume:/app/stream-overlay/data --env-file '.env' --restart on-failure:3 -p '8090:80' --name=stream-overlay docker pull ghcr.io/tklein1801/stream-overlay:latest

Logging

If the logs should not only be displayed in the console but also sent to an external tool, a simple Winston Transport can be set up for this purpose. By setting the environment variable BASELIME_API_KEY, the pre-configured transport to https://baselime.io can be used.

FaQ

See app status

You can check the status of each service using the following endpoints

• /app/bot/status
• /app/listener/status

Alternatively, you can also visit PanthorDE Status.

Starting services/application

Assuming that no one has logged in before or deposited an access token.

All endpoints that start or stop the application must be queried with the query parameter password, whose value is set in the environment variable ENDPOINT_PASSWORD.

1. Activate auto-start in src/app.config.ts
2. Log in with Twitch using the /auth/login endpoint.
3. Then start
   • the entire application by calling the endpoint /app/start
   • individual services by calling these endpoints
     • /app/bot/start
     • /app/listener/start

Stopping services

All endpoints that start or stop the application must be queried with the query parameter password, whose value is set in the environment variable ENDPOINT_PASSWORD.

Stop individual services by calling these endpoints

• /app/bot/start
• /app/listener/start

“Deposit” access token

You can manually deposit an access token by sending the following request

GET /auth/token HTTP/1.1
Content-Type: application/json

{
  "token": <ACCESS_TOKEN>
}

Overlay

You are able to customize the overlay by providing these query parameters

https://overlay.tklein.it/static/index.html?...

Param	Description	Example
name	Whats your name?	Bobby
rank	Position @ Panthor	Entwickler
img	Source URL of your avatar	https://...b23446f5f7639b1-128.jpg
stream	Current stream title	Bohrinsel für Bollmann

Commands

Prefix for commands is defined in the src/app.config.ts

Command	Syntax	Description
ping	ping	Will return pong
server	server	Will provide some basic information about Panthor
mitspielen	mitspielen	Will provide some basic information about Panthor
hint	hint <MESSAGE>	Show hint on your stream-overlay
topic	topic <TOPIC>	Change topic on your stream-overlay
time	time <MINUTER>	Set timer/countdown
scene	scene <SCENE>	Switch your current scene

Workflows

Make sure that the user which executes the workflow has permissions to manage docker volumes and docker containers

The provided Github Personal Access Token need to have permission to read and write to the Github Package Registry

Publish Docker Image

Secrets	Variables
GH_PAT	IMAGE_NAME
	DOCKER_USER

Deploy Image

Variables marked with ENV-PROD are defined in the enviroment production

Secrets	Variables
SSH_HOST (ENV-PROD)	IMAGE_NAME
SSH_USER (ENV-PROD)	DOCKER_USER
SSH_PASSWORD (ENV-PROD)	CONTAINER_NAME (ENV-PROD)
GH_PAT	SERVER_ENV_FILE_LOCATION(ENV-PROD)