essential-actions
Clone or download
Modified Files
# Stream-Pi Essential Actions
# Stream-Pi Essential Actions
Set of trusted, essential actions and integrations for Stream-Pi using the [Stream-Pi Action API](https://github.com/stream-pi/action-api). These actions are prebundled with public Stream-Pi releases.
Set of trusted, essential actions and integrations for Stream-Pi using the [Stream-Pi Action API](https://github.com/stream-pi/action-api). These actions are prebundled with public Stream-Pi releases.
## Prerequisites
## Prerequisites
- Java >= 11
- Java >= 11
- Maven >= 3.6.3
- Maven >= 3.6.3
## Actions Help Guide
## Actions Help Guide
- [Hotkey](hotkeyaction/README.md)
- [Hotkey](hotkeyaction/README.md)
- [Media Keys](mediakeyaction/README.md)
- [OBS](obssuite/README.md)
- [Run Command](runcommandaction/README.md)
- [Run Command](runcommandaction/README.md)
- [Twitch Chat](twitch/README.md)
- [Twitch Chat](twitch/README.md)
## Quick Start
## Quick Start
To test these actions out in your local environment you'll need to run the [Stream-Pi Server](https://github.com/stream-pi/server) and copy the contents of `BuiltPlugins` to the server's
To test these actions out in your local environment you'll need to run the [Stream-Pi Server](https://github.com/stream-pi/server) and copy the contents of `BuiltPlugins` to the server's
Plugins directory (`$HOME/Stream-Pi/Server/Plugins` by default), especially if you're writing your own custom action / integration.
Plugins directory (`$HOME/Stream-Pi/Server/Plugins` by default), especially if you're writing your own custom action / integration.
### Linux/Mac
### Linux/Mac
Build all actions by executing `make build-all` from the command line or specific actions i.e. `make twitch`.
Build all actions by executing `make build-all` from the command line or specific actions i.e. `make twitch-talk`.
### Windows
### Windows
Build all actions by executing `build.bat` from the command line or specific actions i.e. `build.bat twitch`.
Build all actions by executing `build.bat` from the command line or specific actions i.e. `build.bat twitch`.
## List of Actions
## List of Actions
Action Name | Build Script Argument |
Action Name | Build Script Argument |
--------------------- | ----------------------- |
--------------------- | ----------------------- |
Hotkey | `hotkey` |
Hotkey | `hotkey` |
Play Audio Clip | `playaudioclip` |
Play Audio Clip | `playaudioclip` |
Media Key | `mediakey` |
Media Key | `mediakey` |
OBS Suite | `obs-suite` |
OBS Suite | `obs-suite` |
Run Command | `runcommand` |
Run Command | `runcommand` |
Text Block | `textblock` |
Text Block | `textblock` |
Twitch | `twitch-talk` |
Twitch | `twitch-talk` |
Open File | `openfile` |
Open File | `openfile` |
Twitter | `twitter` |
Twitter | `twitter` |
Website | `hotkey` |
Website | `hotkey` |
Run Executable | `runexecutable` |
Run Executable | `runexecutable` |
# Twitch Chat Integration
# Twitch Chat Integration
The first step is to acquire an [OAuth token](https://twitchapps.com/tmi/), the generated OAuth token should look something like `oauth:xxxxx`.
The first step is to acquire an [OAuth token](https://twitchapps.com/tmi/), the generated OAuth token should look something like `oauth:xxxxx`.
Then in the Stream-Pi Server's Plugin page you will need to enter your Twitch username with the generated OAuth token then click on `Save Twitch Chat credentials` button.
Then in the Stream-Pi Server's Plugin page you will need to enter your Twitch username with the generated OAuth token then click on `Save Twitch Chat credentials` button.
You should then be able to use the pre-bundled Twitch chat actions.
You should then be able to use the pre-bundled Twitch chat actions.
## Supported actions (see [Twitch Chat Commands](https://help.twitch.tv/s/article/chat-commands?language=en_US) for full documentation)
## Supported actions (see [Twitch Chat Commands](https://help.twitch.tv/s/article/chat-commands?language=en_US) for full documentation)
### All Users
### All Users
- Set username color
- 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).
- 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
- Send channel message
- Whisper (send user message)
- Whisper (send user message)
### Broadcaster and Mods
### Broadcaster and Mods
- Clear chat
- Clear chat
### Broadcaster and channel editors
### Broadcaster and channel editors
- Run commercial
- Run commercial
- Host
- Host
- Unhost
- Unhost
- Raid
- Raid
- Unraid
- Unraid
- Add stream marker
- Add stream marker
- Toggle slow mode
- Toggle slow mode
- Toggle subs-only mode
- Toggle subs-only mode
### TODO
### TODO
- Toggle followers-only mode
- Toggle followers-only mode
## Running locally
## Running locally
Copy the `Java-Twirk` from the `Dependencies` directory and the `twitch-xxx-action` jar files from the `PreBuiltPlugins` directory to your Stream-Pi server plugins' directory.
Copy the `twitch-api-java` from the `Dependencies` directory and the `twitch-xxx-action` jar files from the `PreBuiltPlugins` directory to your Stream-Pi server plugins' directory.