TheGoatChick

Camera control for https://www.twitch.tv/thegoatchick

Originally based off twitch-goat-cams developed by Farmer Spencer

Installation

Install from Docker

Install Docker

1. Install docker
2. Get the container from DockerHub:

docker pull brainswax/thegoatchick:2.1.1

Configuration

If this is a new installation:

1. Create a folder on your local machine where you want to store the config files
2. Create (or copy) the following files into the config folder:

• .env
• goats.json
• ptz.json

Example .env:

SLACK_HOOK=<token obtained from slack>
SLACK_LOG=true
GO_LIVE=true

OBS_ADDRESS=<IP address of the OBS machine>:4455
OBS_PASSWORD=<password from OBS>

PTZ_CONFIG=/appdata/ptz.json
APP_CONFIG=/appdata/goats.json

TWITCH_USER=<your twitch username>
TWITCH_CHANNEL=<typically the same as your username>
TWITCH_TOKEN=oath:<your twitch token>

Example goats.json:

{
  "ignore": ["StreamElements"]
}

Example ptz.json with 2 cameras:

{
  "cams": {
    "yard": {
      "hostname": "<IP address of the yard camera",
      "username": "<user configured in the yard camera config>"
      "password": "<users password>"
    },
    "parlor": {
      "hostname": "<IP address of the parlor camera",
      "username": "<user configured in the parlor camera config>"
      "password": "<users password>"
    }
  }
}

Run the Container

From Docker Desktop:

1. Go to Images and select to Run the container
2. Expand "Optional settings" in the popup
3. Under Volumes, add:

• Host path: select the configuration folder from above
• Container path: /appdata

Click Run!

Configuration

The configuration consists of environment variables and configuration files located in the conf/ directory

Environment Variables

The environment variables are stored in .env files. The NODE_ENV environment variable (development, test, production) decides which .env to use. When in production, it uses the .env.production file.

To change the environment, modify the start script in package.json, to something like:

cross-env NODE_ENV=development node -r esm --experimental-vm-modules src/goats.js

This will inherit the environment variables defined in .env.development

SLACK_HOOK

SLACK_HOOK=https://hooks.slack.com/services/XXXXX

This is the Slack Webhook that is used to log messages to a slack channel if the SLACK_LOG environment variable is set to 'true'. Otherwise, it will just log to the console.

SLACK_LOG

To enable logging to the slack channel, defined by the SLACK_HOOK, set to 'true'.

SLACK_LOG=true

To disable slack logging, set this to empty or anything other than 'true' and restart the application.

SLACK_LINKS_HOOK

SLACK_LINKS_HOOK=https://hooks.slack.com/services/XXXXX

This is a Slack Webhook that is used to repost links sent from twitch messages to a slack channel if the SLACK_LINKS environment variable is not 'false'.

SLACK_LINKS

To enable links to be reposted to slack, defined by the SLACK_LINKS_HOOK, set to 'true'.

SLACK_LINKS=true

To disable reposting links to slack, set this to 'false' or remove SLACK_LINKS_HOOK and restart the application.

OBS_ADDRESS

The host and port to connect to the local OBS service.

OBS_ADDRESS=localhost:4444

OBS_PASSWORD

The password associated with the OBS service defined by OBS_ADDRESS

OBS_PASSWORD=obspassword

PTZ_CONFIG

The location of the PTZ camera config file.

PTZ_CONFIG=../conf/ptz.json

TWITCH_USER

The twitch user that the bot will login as

TWITCH_USER=botusername

TWITCH_CHANNEL

The twitch channel that the bot will join

TWITCH_CHANNEL=twitchstream

TWITCH_TOKEN

This is an oauth token provided by twitch for the bot to authenticate. Go to Twitch Apps get a new token for the Twitch Messaging Interface (tmi).

TWITCH_CHANNEL=twitchstream

To verify your token, you can run something like:

curl -H "Authorization: OAuth <insert oauth token>" https://id.twitch.tv/oauth2/validate

Which will return information about your token:

{
  "client_id": "xxxxxxxx",
  "login": "brainswax",
  "scopes": ["channel:moderate","channel_editor","chat:edit","chat:read","whispers: edit","whispers:read"],
  "user_id": "0000000",
  "expires_in": 0
}

TWITCH_RECONNECT

Twitch reconnects are enabled by default unless this is explicitly set to false

TWITCH_RECONNECT=false

TWITCH_RECONNECT_TRIES

The number of reconnect attempts to twitch before giving up. By default, it will start after 1 second, then degrade till it attempts every 30 seconds. 2880 attempts is roughly 24 hours.

TWITCH_RECONNECT_TRIES=2880

LOG_LEVEL_CONSOLE

Sets the level of logs sent to the console. The logger will only log at the specified level or higher severity.

From highest to lowest severity: EMERGENCY, ALERT, CRITICAL, ERROR, WARN, NOTICE, INFO, DEBUG

LOG_LEVEL_CONSOLE=DEBUG

LOG_LEVEL_SLACK

Sets the level of logs sent to Slack (assuming SLACK_LOG=true). The logger will only log at the specified level or higher severity.

From highest to lowest severity: EMERGENCY, ALERT, CRITICAL, ERROR, WARN, NOTICE, INFO, DEBUG

LOG_LEVEL_SLACK=ERROR

PTZ Config

The PTZ_CONFIG environment variable is used to specify the location of the PTZ cameras config file.

The file is expected to be JSON with the following example format:

{
  "cams": {
     "Yard": {
       "hostname": "192.168.0.1",
       "username": "yarduser",
       "password": "yardpassword",
       "version": 2
     },
     "Does": {
       "hostname": "192.168.0.2",
       "username": "doesusername",
       "password": "doespassword",
       "version": 2
     }
  }
}

Cams

The location of camera views (cam(0), cam1, ..., camN) are automatic, scaled to be square, and with the following sort logic:

1. If CAM_FUDGE (or 80% by default) of the area of one cam is larger than the other, it's considered a lower numbered cam
2. If the distance from the origin to the top left of the camera source is shorter (scaled to be a square), it's considered a lower numbered cam
3. If the cam is closer to the left, it's considered a lower numbered cam
4. If the cam is closer to the top, it's considered a lower numbered cam
5. Otherwise, considered equal (and they're overlapping)

CAM_FUDGE

Sets the fudge factor for sorting a camera view by area. This allows two closely sized sources to be considered equal (usually because a human resized it manually in OBS) and to sort based on distance from the origin and (x, y) coordinates. The default is 80%.

CAM_FUDGE=0.8