/Kruiz-Control

Kruiz Control enables a pseudo code approach to manage and automatically handle Twitch Channel Points, Twitch Chat, OBS or SLOBS, and StreamElements or Streamlabs alerts.

Primary LanguageJavaScriptMIT LicenseMIT

Kruiz Control /w sound pack

This is a clone from Kruizer 8 including the configuration and sounds for 200 onomatopoeia.
Sounds are from: https://freesound.org
-joggerjoel

Kruiz Control enables a pseudo code approach to manage and automatically handle Twitch Channel Points, Twitch Chat, OBS or SLOBS, and StreamElements or Streamlabs alerts.

Tutorial | Download | Documentation | Settings

@Kruiser8 | Trello (Roadmap) | Support Discord

Table of Contents

Setup Guide

  • (If using OBS) Install the OBS Websocket Plugin.
  • Fill out the settings files in the settings folder.
  • Add the index.html to OBS/SLOBS as a browser source.
  • Type !example in your twitch chat. If your user responds with Success! It worked!, you're good to go!
  • Customize the triggers.txt with your own triggers from the the documentation.

Compatibility

Kruiz Control supports

  • Twitch Channel Points
  • Twitch Chat
  • Streamlabs Alerts
  • StreamElements Alerts
  • OBS scene, source, and filter changes
  • SLOBS scene and source changes
  • Playing music (mp3, wav, ogg)
  • Timers (triggering on an interval)
  • Sending API calls

and more in the documentation!

The script should run on any broadcast software that supports browser sources, however only OBS and SLOBS support changing scenes and sources.

OBS.Live should also be supported but is untested.

Installation

OBS Websocket (if using OBS)

To use this script with OBS, install the obs-websocket plugin.

In OBS, click Tools > WebSockets Server Settings and enable the websocket server.

It is highly recommended to use a password!

Settings

Before the script will work, you'll need to fill out all of the settings files. Please see the settings description for more information.

Add as Browser Source

Add the index.html file as a browser source within your broadcast software. It is recommended to add this source to one scene that is included in all other scenes (like your alert scene) rather than recreate this source in every scene.

Steps for adding to OBS/SLOBS

  • In OBS, under Sources click the + icon to add a new Browser source.
  • Name it and select OK.
  • Check the Local file checkbox.
  • Click Browse and open the index.html file within the Kruiz Control script directory.
  • Recommended to set the width/height to 100 or less to reduce the size of the source.

Usage

Pseudo Code Format

For information on the pseudo code format, please see the documentation.

triggers.txt

Setup your triggers inside of this file if you do not need actions to be run one after another.

As an example, if the below is in the triggers.txt file, then both sounds can be played at the same time.

triggers.txt

OnChannelPoint SHIKAKA
Play 30 wait Shikaka.mp3

OnCommand sbvm 0 !intervention
Play 45 nowait MashiahMusic__Kygo-Style-Melody.wav

fileTriggers.txt and the triggers folder

When you need actions to be run one-after-another, create a file in the triggers folder and add the name of the folder to fileTriggers.txt.

As an example, here's a setup to make sure multiple scene changes don't happen simultaneously.

fileTriggers.txt

obs.txt

triggers/obs.txt

OnSLDonation
OBS Scene DonationCelebration
Delay 4

OnCommand m !brb
OBS Scene BRB
Delay 5

sounds folder

In order to use a sound with Play, add the sound file to the sounds folder. The supported audio formats are mp3, wav, and ogg.

FAQ

XSplit Support

The script should work with XSplit BUT the OBS-like functionality will not work. XSplit does not provide a direct websocket interface to do such actions. It may be possible to implement a plugin that provides a websocket interface to connect with xsplit. If you know a way to achieve this, please reach out.

Support for Mixer and Youtube Alerts

I can definitely add support for Mixer and Youtube alerts from Streamlabs. I just haven't had the time to implement it yet.

More investigation time is needed to implement Youtube and Mixer StreamElements.

Support for Mixer and Youtube Chat

Potentially if I can find the libraries to implement it. Again, if you know a way to achieve this, please reach out via twitter or discord.

Will you support X

Please reach out if you have any ideas or other questions that were not covered in the documentation.

Discord: Kruiser Scripts Discord

Twitter: @Kruiser8

Support the Project

There are a number of ways to support this project.

I do take commissions to implement custom functionality when necessary. Please reach out if you have a specific request.

Credits