essential-actions
Clone or download
Modified Files
# Stream-Pi Essential Actions
# Stream-Pi Essential Actions
Set of trusted, pre-bundled actions and integrations for Stream-Pi using the [Stream-Pi Action API](https://github.com/stream-pi/actionapi).
Set of trusted, pre-bundled actions and integrations for Stream-Pi using the [Stream-Pi Action API](https://github.com/stream-pi/actionapi).
## Prerequisites
## Prerequisites
- Java >= 11
- Java >= 11
- Maven >= 3.6.3
- Maven >= 3.6.3
## List of Actions
## List of Actions
- Hotkey
- Hotkey
- Website
- Website
- Twitter
- Twitter
- OBS Actions
- OBS Actions
- Run Command
- Run Command
- Text Block
- Text Block
- Media File
- Media File
- Media Key
- Media Key
- Twitch
- Twitch
## Actions Help Guide
## Actions Help Guide
### Twitch Chat Integration
### 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`.
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.
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](https://help.twitch.tv/s/article/chat-commands?language=en_US) for full documentation)
### Supported actions (see [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
- Toggle slow mode (TBA - pending toggle-button functionality)
- Toggle slow mode (TBA - pending toggle-button functionality)
- Toggle followers-only 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 subs-only mode (TBA - pending toggle-button functionality)
- Toggle emotes-only mode (TBA - pending toggle-button functionality)
- Toggle emotes-only mode (TBA - pending toggle-button functionality)
#### Broadcaster and channel editors
#### Broadcaster and channel editors
- Run commercial (TBA)
- Run commercial
- Host (TBA)
- Host
- Unhost
- Unhost
- Raid (TBA)
- Raid
- Unraid
- Unraid
- Add stream marker
- Add stream marker
### Running locally
### 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.
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
## 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](Makefile) for complete list.
Build all actions by executing `make build-all` from the command line or specific actions i.e. `make build-twitch-chat-action`, see [Makefile](Makefile) for complete list.
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 `PreBuiltPlugins/` 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 `PreBuiltPlugins/` to the server's
Plugins directory (`data/Plugins` by default), especially if you're writing your own custom action / integration.
Plugins directory (`data/Plugins` by default), especially if you're writing your own custom action / integration.