essential-actions

Clone or download

README.md

Stream-Pi Essential Actions

Set of trusted, pre-bundled actions and integrations for Stream-Pi using the Stream-Pi Action API.

Prerequisites

  • Java >= 11
  • Maven >= 3.6.3

List of Actions

  • Hotkey
  • Website
  • Twitter
  • OBS Actions
  • Run Command
  • Text Block
  • Media File
  • Media Key
  • Twitch

Actions Help Guide

Twitch Chat Integration

The first step is to acquire an OAuth token from https://twitchapps.com/tmi/, the generated OAuth token should look something like oauth:xxxxx.

In the Stream-Pi Server's Plugin page enter your Twitch username, and the generated token then click on Save Twitch Chat credentials button. You should then be able to use the pre-bundled Twitch chat actions.

Supported actions (see Chat Commands for full documentation)

All Users

  • Set username color
    • Normal users can choose between Blue, Coral, DodgerBlue, SpringGreen, YellowGreen, Green, OrangeRed, Red, GoldenRod, HotPink, CadetBlue, SeaGreen, Chocolate, BlueViolet, and Firebrick. Twitch Turbo users can use any Hex value (i.e: #000000).
  • Send channel message
  • Whisper (send user message)

Broadcaster and Mods

  • Clear chat
  • Toggle slow mode (TBA - pending toggle-button functionality)
  • Toggle followers-only mode (TBA - pending toggle-button functionality)
  • Toggle subs-only mode (TBA - pending toggle-button functionality)
  • Toggle emotes-only mode (TBA - pending toggle-button functionality)

Broadcaster and channel editors

  • Run commercial
  • Host
  • Unhost
  • Raid
  • Unraid
  • Add stream marker

Running locally

Copy the twitch-chat-connect, twitch-send-channel-msg, and Java-Twirk jar files from the PreBuiltPlugins directory to your Stream-Pi server plugins' directory.


Quick Start

Build all actions by executing make build-all from the command line or specific actions i.e. make build-twitch-chat-action, see Makefile for complete list.

To test these actions out in your local environment you'll need to run the Stream-Pi Server and copy the contents of PreBuiltPlugins/ to the server's Plugins directory (data/Plugins by default), especially if you're writing your own custom action / integration.