essential-actions

Implement Twitch chat unhost action

Download Browse

+175 −3

Author

Jordan Duabe 2021-03-13 13:20

Committer

Jordan Duabe 2021-03-13 14:26

Hash 8f327abfd15b3956bd7a9edf8fb83c411d068f7a

Parent ca0bb8f74fe39c5ddecc61f49b5f698d54f1787a

Reference git #essential-actions/8f327abfd15b3956bd7a9edf8fb83c411d068f7a

Modified Files

List

Side by side diff

Inline diff

M README.md

+3 −3

# 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).

## 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.

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)

#### 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 (TBA)

- Host (TBA)

- Unhost (TBA)

- Unhost

- Raid (TBA)

- Unraid (TBA)

- Unraid

- Add stream marker (TBA)

### 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](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

Plugins directory (`data/Plugins` by default), especially if you're writing your own custom action / integration.

M build.sh

+3 −0

#!/bin/bash

FOLD=../PreBuiltPlugins

hotkey() {

pushd . || exit

cd hotkeyaction && mvn clean package

mv target/hotkeyaction-1.0.0.jar $FOLD/hotkeyaction.jar

popd || exit

}

mediakey() {

pushd . || exit

cd mediakeyaction && mvn clean package

mv target/mediakeyaction-1.0.0.jar $FOLD/mediakeyaction.jar

popd || exit

}

obssuite() {

pushd . || exit

cd obssuite/mother && mvn clean install package

mv target/obssuite_motheraction-1.0.0.jar ../$FOLD/obssuite_motheraction.jar

cd ../setcurrentprofile && mvn clean package

mv target/obssuite_setcurrentprofileaction-1.0.0.jar ../$FOLD/obssuite_setcurrentprofileaction.jar

cd ../setcurrentscene && mvn clean package

mv target/obssuite_setcurrentsceneaction-1.0.0.jar ../$FOLD/obssuite_setcurrentsceneaction.jar

cd ../setcurrenttransition && mvn clean package

mv target/obssuite_setcurrenttransitionaction-1.0.0.jar ../$FOLD/obssuite_setcurrenttransitionaction.jar

cd ../setmute && mvn clean package

mv target/obssuite_setmuteaction-1.0.0.jar ../$FOLD/obssuite_setmuteaction.jar

cd ../setcurrentprofile && mvn clean package

mv target/obssuite_setcurrentprofileaction-1.0.0.jar ../$FOLD/obssuite_setcurrentprofileaction.jar

cd ../setpreviewscene && mvn clean package

mv target/obssuite_setpreviewsceneaction-1.0.0.jar ../$FOLD/obssuite_setpreviewsceneaction.jar

cd ../setrecording && mvn clean package

mv target/obssuite_setrecordingaction-1.0.0.jar ../$FOLD/obssuite_setrecordingaction.jar

cd ../setreplaybuffer && mvn clean package

mv target/obssuite_setreplaybufferaction-1.0.0.jar ../$FOLD/obssuite_setreplaybufferaction.jar

cd ../setstreaming && mvn clean package

mv target/obssuite_setstreamingaction-1.0.0.jar ../$FOLD/obssuite_setstreamingaction.jar

cd ../setstudiomode && mvn clean package

mv target/obssuite_setstudiomodeaction-1.0.0.jar ../$FOLD/obssuite_setstudiomodeaction.jar

cd ../setvolume && mvn clean package

mv target/obssuite_setvolumeaction-1.0.0.jar ../$FOLD/obssuite_setvolumeaction.jar

popd || exit

}

playaudioclip() {

pushd . || exit

cd playaudioclipaction && mvn clean package

mv target/playaudioclipaction-1.0.0.jar $FOLD/playaudioclipaction.jar

popd || exit

}

runcommand() {

pushd . || exit

cd runcommandaction && mvn clean package

mv target/runcommandaction-1.0.0.jar $FOLD/runcommandaction.jar

popd || exit

}

textblock() {

pushd . || exit

cd textblockaction && mvn clean package

mv target/textblockaction-1.0.0.jar $FOLD/textblockaction.jar

popd || exit

}

twitter() {

pushd . || exit

cd twitteraction && mvn clean package

mv target/twitteraction-1.0.0.jar $FOLD/twitteraction.jar

popd || exit

}

twitchchat() {

pushd . || exit

cd twitch/twitch-chat-connect && mvn clean install package

mv target/twitch-chat-connect-1.0.0.jar ../$FOLD/twitch-chat-connect.jar

cd ../send-channel-msg && mvn clean install package

mv target/twitch-send-channel-msg-1.0.0.jar ../$FOLD/twitch-send-channel-msg.jar

cd ../clear-chat && mvn clean install package

mv target/twitch-clear-chat-1.0.0.jar ../$FOLD/twitch-clear-chat.jar

cd ../set-color && mvn clean install package

mv target/twitch-set-color-1.0.0.jar ../$FOLD/twitch-set-color.jar

cd ../whisper && mvn clean install package

mv target/twitch-whisper-1.0.0.jar ../$FOLD/twitch-whisper.jar

cd ../unraid && mvn clean install package

mv target/twitch-unraid-1.0.0.jar ../$FOLD/twitch-unraid.jar

cd ../unhost && mvn clean install package

mv target/twitch-unhost-1.0.0.jar ../$FOLD/twitch-unhost.jar

popd || exit

}

websiteaction() {

pushd . || exit

cd websiteaction && mvn clean package

mv target/websiteaction-1.0.0.jar $FOLD/websiteaction.jar

popd || exit

}

case "$1" in

hotkey)

hotkey

;;

mediakey)

mediakey

;;

playaudioclip)

playaudioclip

;;

runcommand)

runcommand

;;

textblock)

textblock

;;

twitter)

twitter

;;

website)

website

;;

obssuite)

obssuite

;;

twitchchat)

twitchchat

;;

# build all actions as default

hotkey

mediakey

obssuite

playaudioclip

runcommand

textblock

twitter

twitchchat

website

;;

esac

A twitch/unhost/pom.xml

+81 −0

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<groupId>com.stream-pi</groupId>

<artifactId>twitch-unhost</artifactId>

<maven.compiler.source>11</maven.compiler.source>

<maven.compiler.target>11</maven.compiler.target>

</properties>

<id>jitpack.io</id>

<url>https://jitpack.io</url>

</repository>

</repositories>

<build>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-jar-plugin</artifactId>

<phase>package</phase>

<goals>

</goals>

</execution>

</executions>

</plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-compiler-plugin</artifactId>

</configuration>

</plugin>

</plugins>

</build>

<groupId>com.stream-pi</groupId>

<version>${streamPiUtilVersion}</version>

</dependency>

<groupId>com.stream-pi</groupId>

<artifactId>action-api</artifactId>

<version>${streamPiActionApiVersion}</version>

</dependency>

<groupId>com.github.gikkman</groupId>

<artifactId>Java-Twirk</artifactId>

<version>${javaTwirkVersion}</version>

</dependency>

<groupId>com.stream-pi</groupId>

<artifactId>twitch-chat-connect</artifactId>

<version>${streamPiTwitchChatConnectVersion}</version>

</dependency>

</dependencies>

</project>

A twitch/unhost/src/main/java/module-info.java

+9 −0

module com.stream_pi.twitch.unhostaction {

requires com.stream_pi.util;

requires com.stream_pi.action_api;

requires com.stream_pi.twitchchatconnectaction;

requires Java.Twirk;

provides com.stream_pi.action_api.normalaction.NormalAction with unhost.UnhostAction;

}

A twitch/unhost/src/main/java/unhost/UnhostAction.java

+79 −0

package unhost;

import com.gikk.twirk.Twirk;

import com.gikk.twirk.TwirkBuilder;

import com.stream_pi.action_api.actionproperty.property.Property;

import com.stream_pi.action_api.actionproperty.property.Type;

import com.stream_pi.action_api.normalaction.NormalAction;

import com.stream_pi.util.exception.StreamPiException;

import com.stream_pi.util.version.Version;

import connect.chat.TwitchChatCredentials;

public class UnhostAction extends NormalAction

{

private final String channelNameKey = "channel_name_ua";

private Twirk twirk;

public UnhostAction()

{

setName("Unhost");

setCategory("Twitch Chat");

setVisibilityInServerSettingsPane(false);

setAuthor("j4ckofalltrades");

setVersion(new Version(1, 0, 0));

setHelpLink("https://github.com/stream-pi/essentialactions#twitch-chat-integration");

}

@Override

public void initProperties() throws Exception

{

Property channel = new Property(channelNameKey, Type.STRING);

channel.setDisplayName("Channel");

channel.setDefaultValueStr("channel_name");

channel.setCanBeBlank(false);

addClientProperties(channel);

}

@Override

public void initAction() throws Exception

{

}

@Override

public void onActionClicked() throws Exception

{

final TwitchChatCredentials.ChatCredentials credentials = TwitchChatCredentials.getCredentials();

credentials.ensureCredentialsInitialized();

final String channel = getClientProperties().getSingleProperty(channelNameKey).getStringValue();

try

{

twirk = new TwirkBuilder(channel, credentials.getNickname(), credentials.getOauthToken()).build();

twirk.connect();

twirk.channelMessage("/unhost");

} catch (Exception ex)

{

throw new StreamPiException(

"Failed to cancel channel raid",

"Could not send cancel channel raid, please try again.");

}

@Override

public void onShutDown() throws Exception

{

if (twirk != null) {

try

{

twirk.disconnect();

} catch (Exception ex) {

throw new StreamPiException("Twitch connection error", "Please try again.");

}

Public

essential-actions

Clone or download

Implement Twitch chat unhost action

Modified Files