Skip to content

Latest commit

 

History

History
272 lines (200 loc) · 8.27 KB

Settings.md

File metadata and controls

272 lines (200 loc) · 8.27 KB

Kruiz Control Settings

The following details each of the settings files that need to be filled out for each handler. An example is provided for each file.

All settings files are found in the settings folder.

This script uses text files to improve the average user experience.

Table of Contents

Chat

channel.txt

Location: settings/chat/channel.txt

Specify the twitch channel to connect for chatting.

kruiser8

code.txt

Location: settings/chat/code.txt

NOTE: Leave this file blank if you want Kruiz Control to send messages as your main Twitch account. That is, only use this if you want to send messages as a separate bot account.

DO NOT COPY YOUR TWITCH CODE.TXT VALUE HERE

Follow the instructions in the Twitch Code section below. At step 5, login with the desired account. Copy the generated code into this file.

exampleoauth4kruizcontrol12345

Reminder:

  • channel.txt specifies the channel to connect to.
  • code.txt specifies the user to send messages as.

MQTT

websocket.txt

Location: settings/mqtt/websocket.txt

Specify the IP (or hostname) + port to use for the MQTT websocket.

ws://localhost:8883

username.txt

Location: settings/mqtt/username.txt

NOTE: Leave this file blank if your broker doesn't require authentication.

Specify the username required by your broker, if any.

kcmqttuser

password.txt

Location: settings/mqtt/password.txt

NOTE: Leave this file blank if your broker doesn't require authentication.

Specify the password required by your broker, if any

p@55w0rd

OBS

These settings can be found through Tools > WebSockets Server Settings.

address.txt

Location: settings/obs/address.txt

Specify the IP + port to use for the OBS websocket.

ws://127.0.0.1:4455

password.txt

Location: settings/obs/password.txt

Specify the password to use when connecting to the websocket.

my0b5p455w0rd

SLOBS

Follow the below steps to enable the SLOBS API for Kruiz Control.

  • Open SLOBS
  • Click the settings gear in the bottom left
  • Open the Remote Control tab
  • Click the QR Code so that it shows.
  • Click the Show details text/link that appears.
  • Copy the API Token value into the token.txt file (referenced below).
  • Close SLOBS.
  • Run SLOBS as administrator to enable the SLOBS Remote Control API.

token.txt

Location: settings/slobs/token.txt

eyJAFOI3qoi4ut6345ogno5iuyt890

StreamElements

To capture alerts through StreamElements, you'll need a JWT token. To get your JWT token,

  • Go to your account settings
  • Click the Show secrets toggle on the right
  • Copy the JWT Token value that appears

jwtToken.txt

Location: settings/streamelements/jwtToken.txt

eyJAFOI3qoi4ut6345ogno5iuyt89058gn589tyjh589h98h509ASUDF98Uuf98adshf9asfha89hga9hg9H8HA98HG98DAH98ADH8HG98ha989a9H9HG98DHh9DSHG89shg98h89DH98hh8H98gsdhg9D8SHD89GH9dshg89DSHG98HFSFNLJKFH98HNSDINVC98DSHGFw08hwewf

Streamlabs

To capture alerts through Streamlabs, you'll need your Socket API Token. To get your token,

socketAPIToken.txt

Location: settings/streamlabs/socketAPIToken.txt

eyJhaoiuh798a99h7HBN879DHF98A789aigfba8790gfh987Fb78987BgUYF4SD56gI9Uh98786rf7tVBg97Gf56dxCilbh8OYf6r5SDX6cuyoIB97768FD76d546SD6iGVBUIb9i980YH897676f8FiUB9OIu8g78D6d5BiIU

Twitch

To capture Twitch events, you'll need a Client Id and Client Secret and a generated auth token for your Twitch user.

Client ID and Secret

To capture Twitch events, you'll need a Client Id and Client Secret. To create your own,

  1. Go to https://dev.twitch.tv/login and login with your Twitch account.
  2. Navigate to https://dev.twitch.tv/console.
  3. Once logged in, on the left sidebar click Applications.
  4. Click the + Register Your Application button and enter the following details:
    • Name: YOUR_USERNAME Kruiz Control (Any name works, as long as it is unique)
    • OAuth Redirect URLs: http://localhost
    • Category: Chat Bot
  5. Click the Create button at the bottom.
  6. Click the Manage button on the right hand side for the application you created.
  7. Copy the Client ID value and put it in the settings/twitch/clientId.txt file.
  8. Click the New Secret button, confirm the prompt, and copy and paste the value into the settings/twitch/clientSecret.txt file.

Code

Some APIs and events require a user authenticated auth code. To generate one of these, first follow the Client ID and Secret instructions to update the settings/twitch/clientId.txt and settings/twitch/clientSecret.txt files. Then follow the below steps:

  1. Add the below to your Kruiz Control triggers.txt file to add an authentication link to your OBS or SLOBS log file. 
    ### Twitch Authenticate ###
OnInit
Twitch Authenticate
Error {auth_url}
  2. Reset Kruiz Control (refresh the browser source) to generate the link .
  3. Open your OBS or SLOBS log file to find the URL.
    • For OBS, go to Help > Log Files > View Current Log.
    • For SLOBS, open the settings cog (bottom left) and then go to Get Support and click the Show Cache Directory option under Cache Directory. Open the node-obs folder and then the logs folder. Open the most recently modified file.
  4. Copy the link at the bottom of the log file, and open it in a browser.
    • The link will start with https://id.twitch.tv/oauth2/authorize
  5. Login to your Twitch account. This provides the ability to control your stream via the created https://dev.twitch.tv application.
  6. After login, you'll be redirected to a link that looks like the below. 
    http://localhost/?code=YOUR_CODE_HERE&scope=bits%3Aread...
  7. Copy the YOUR_CODE_HERE value and put that into your settings/twitch/code.txt file.
  8. Once you have generated a code, you can remove the ### Twitch Authenticate ### event from your triggers.txt file.

clientId.txt

Location: settings/twitch/clientId.txt

Specify the Twitch Client ID to use when making API calls.

wasdfe23r9yujasbnvo9qhfiuqa328

clientSecret.txt

Location: settings/twitch/clientSecret.txt

Specify the Twitch Client Secret to use when making API calls.

h30984thfa9uegh90awiejhtgfqgq3

code.txt

Location: settings/twitch/code.txt

Specify the Twitch auth code generated after logging in to your Twitch account.

098wh4ijbngse7w9r87yqu3gbq398f

user.txt

Location: settings/twitch/user.txt

Specify the Twitch channel that Kruiz Control will react to and control through triggers and actions.

kruiser8

Variable

Use the below settings to toggle how Variables are configured in Kruiz Control.

autoload.txt

Location: settings/variable/autoload.txt

Format: <on/off>

Specify whether or not Kruiz Control should automatically load all variables (session and global) without having to use Variable Load or Variable Global Load.

(Default) If set to off, variables must be loaded before they can be used.

If set to on, all variables are usable as soon as they are set or Kruiz Control initializes.

off

Voicemod

To connect to Voicemod, you'll need an API Key. To get your API Key,

  • Fill out Voicemod's form to request a key.
  • After submitting the form, check your email inbox for an email from control.api.devs@voicemod.net with your clientKey.
  • Copy the clientKey value. It should look something like abc-defh12345.
  • Paste the clientKey into the settings/voicemod/apiKey.txt file.

address.txt

Location: settings/voicemod/address.txt

ws://localhost:59129/v1

apiKey.txt

Location: settings/voicemod/apiKey.txt

abc-defg12345