essential-actions

Merge pull request #37 from j4ckofalltrades/code-cleanup

Download Browse

Code cleanup

+68 −109

Author

Debayan Sutradhar (rnayabed) 2021-05-02 19:48

Committer

GitHub 2021-05-02 19:48

Hash 901f4a2a085ed85b85a8a5742f695d0ee74ad633

Parents

Reference git #essential-actions/901f4a2a085ed85b85a8a5742f695d0ee74ad633

Modified Files

List

Side by side diff

Inline diff

M DemoCustomToggleAction/src/main/java/com/stream_pi/democustomtoggleaction/DemoCustomToggleAction.java

+5 −11

package com.stream_pi.democustomtoggleaction;

import com.stream_pi.action_api.action.DisplayTextAlignment;

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

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

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

import com.stream_pi.action_api.externalplugin.ToggleAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.version.Version;

import javafx.concurrent.Task;

import java.util.ArrayList;

public class DemoCustomToggleAction extends ToggleAction

{

public DemoCustomToggleAction()

{

setName("Demo Toggle Action");

setAuthor("rnayabed");

setHelpLink("https://github.com/Stream-Pi/");

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

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

setCategory("Custom Actions");

}

@Override

public void onToggleOn() throws Exception

{

}

@Override

public void onActionCreate()

{

new StreamPiAlert("Toggle was turned on!").show();

}

@Override

public void onToggleOff()

{

new StreamPiAlert("Toggle was turned off!").show();

}

@Override

public void initProperties()

{

//Called First

}

@Override

public void initAction() {

public void initAction()

{

// This is called after initProperties()

}

@Override

public void onShutDown() throws Exception {

public void onShutDown() throws Exception

{

// TODO Auto-generated method stub

}

M Makefile

+15 −15

build-all:

./build.sh

build-hotkey-action:

hotkey:

./build.sh hotkey

build-media-key-action:

media-key:

./build.sh mediakey

./build.sh media_key

build-obs-suite-action:

obs-suite:

./build.sh obssuite

./build.sh obs_suite

build-play-audio-clip-action:

play-audio-clip:

./build.sh playaudioclip

./build.sh play_audio_clip

build-run-command-action:

run-command:

./build.sh runcommand

./build.sh run_command

build-text-block-action:

text-block:

./build.sh textblock

./build.sh text_block

build-twitch-chat-action:

twitch-chat:

./build.sh twitchchat

./build.sh twitch_chat

build-twitter-action:

twitter:

./build.sh twitter

build-website-action:

website:

./build.sh website

M README.md

+3 −4

# 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

- Media File

- Media Key

- OBS Actions

- Run Command

- Text Block

- Twitch Chat

- Twitter

- Website

## Actions Help Guide

- [Hotkey](hotkeyaction/README.md)

- [Run Command](runcommandaction/README.md)

- [Twitch Chat](twitch/README.md)

---

## 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 twitch-chat`, 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.

Plugins directory (`$HOME/Stream-Pi/Server/Plugins` by default), especially if you're writing your own custom action / integration.

M build.sh

+33 −38

#!/bin/bash

FOLD=PreBuiltPlugins

DEPS=Dependencies

hotkey() {

pushd . || exit

cd hotkeyaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

mediakey() {

media_key() {

pushd . || exit

cd mediakeyaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

obssuite() {

obs_suite() {

pushd . || exit

cd obssuite/mother && mvn clean install -Dmaven.test.skip package

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

cd ../setcurrentprofile && mvn clean -Dmaven.test.skip package

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

cd ../setcurrentscene && mvn clean -Dmaven.test.skip package

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

cd ../setcurrenttransition && mvn clean -Dmaven.test.skip package

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

cd ../setmute && mvn clean -Dmaven.test.skip package

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

cd ../setcurrentprofile && mvn clean -Dmaven.test.skip package

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

cd ../setpreviewscene && mvn clean -Dmaven.test.skip package

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

cd ../setrecording && mvn clean -Dmaven.test.skip package

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

cd ../setreplaybuffer && mvn clean -Dmaven.test.skip package

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

cd ../setstreaming && mvn clean -Dmaven.test.skip package

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

cd ../setstudiomode && mvn clean -Dmaven.test.skip package

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

cd ../setvolume && mvn clean -Dmaven.test.skip package

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

popd || exit

}

playaudioclip() {

play_audio_clip() {

pushd . || exit

cd playaudioclipaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

runcommand() {

run_command() {

pushd . || exit

cd runcommandaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

textblock() {

text_block() {

pushd . || exit

cd textblockaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

twitter() {

twitch_chat() {

pushd . || exit

cd twitteraction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

twitchchat() {

pushd . || exit

cd twitch/twitch-chat-connect && mvn clean install -Dmaven.test.skip package

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

cd ../send-channel-msg && mvn clean -Dmaven.test.skip package

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

cd ../clear-chat && mvn clean -Dmaven.test.skip package

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

cd ../set-color && mvn clean -Dmaven.test.skip package

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

cd ../whisper && mvn clean -Dmaven.test.skip package

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

cd ../unraid && mvn clean -Dmaven.test.skip package

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

cd ../unhost && mvn clean -Dmaven.test.skip package

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

cd ../add-stream-marker && mvn clean -Dmaven.test.skip package

mv target/twitch-add-stream-marker-*.jar ../../$FOLD/twitch-add-stream-marker.jar

cd ../host-channel && mvn clean -Dmaven.test.skip package

mv target/twitch-host-channel-*.jar ../../$FOLD/twitch-host-channel.jar

cd ../raid-channel && mvn clean -Dmaven.test.skip package

mv target/twitch-raid-channel-*.jar ../../$FOLD/twitch-raid-channel.jar

cd ../start-commercial && mvn clean -Dmaven.test.skip package

mv target/twitch-start-commercial-*.jar ../../$FOLD/twitch-start-commercial.jar

cd ../subs-only && mvn clean -Dmaven.test.skip package

mv target/twitch-subs-only-*.jar ../../$FOLD/twitch-subs-only.jar

cd ../slow-mode && mvn clean -Dmaven.test.skip package

mv target/twitch-slow-mode-*.jar ../../$FOLD/twitch-slow-mode.jar

popd || exit

}

twitter() {

pushd . || exit

cd twitteraction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

website() {

pushd . || exit

cd websiteaction && mvn clean -Dmaven.test.skip package

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

popd || exit

}

mkdir -p $FOLD

rm -rf "${FOLD:?}/"*

cp $DEPS/* $FOLD/

case "$1" in

hotkey)

hotkey

;;

mediakey)

media_key)

mediakey

media_key

;;

obs_suite)

obs_suite

;;

play_audio_clip)

play_audio_clip

;;

playaudioclip)

run_command)

playaudioclip

run_command

;;

runcommand)

text_block)

runcommand

text_block

;;

textblock)

twitch_chat)

textblock

twitch_chat

;;

twitter)

twitter

;;

website)

website

;;

obssuite)

obssuite

;;

twitchchat)

twitchchat

;;

# build all actions as default

hotkey

mediakey

media_key

obssuite

obs_suite

playaudioclip

play_audio_clip

runcommand

run_command

textblock

text_block

twitch_chat

twitter

twitchchat

website

;;

esac

M obssuite/mother/src/main/java/mother/Mother.java

+1 −5

package mother;

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

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.util.version.Version;

import com.stream_pi.util.exception.MinorException;

import mother.motherconnection.MotherConnection;

import javafx.scene.control.Button;

import mother.motherconnection.MotherConnection;

public class Mother extends NormalAction

{

public Mother()

{

setName("OBS Plugin");

setCategory("OBS");

setVisibilityInPluginsPane(false);

setAuthor("rnayabed");

setHelpLink("https://github.com/Stream-Pi/EssentialActions");

setVersion(MotherConnection.VERSION);

connectDisconnectButton = new Button("Connect");

setServerSettingsButtonBar(connectDisconnectButton);

}

@Override

public void onActionClicked()

{

}

private Button connectDisconnectButton;

@Override

public void initProperties() throws Exception

{

Property urlProperty = new Property("url", Type.STRING);

urlProperty.setDisplayName("URL");

urlProperty.setDefaultValueStr("ws://localhost:4444");

urlProperty.setCanBeBlank(false);

Property passwordProperty = new Property("pass", Type.STRING);

passwordProperty.setControlType(ControlType.TEXT_FIELD_MASKED);

passwordProperty.setDisplayName("Password");

Property connectOnStartupProperty = new Property("connect_on_startup", Type.BOOLEAN);

connectOnStartupProperty.setDisplayName("Connect On Startup");

connectOnStartupProperty.setDefaultValueBoolean(false);

addServerProperties(

urlProperty,

passwordProperty,

connectOnStartupProperty

);

}

@Override

public void initAction() throws Exception

{

MotherConnection.setPass(getPassword());

MotherConnection.setUrl(getURL());

MotherConnection.setConnectDisconnectButton(connectDisconnectButton);

connectDisconnectButton.setOnAction(action->{

try

{

if(MotherConnection.getRemoteController() == null)

{

connect(getURL(), getPassword());

}

else

{

MotherConnection.getRemoteController().disconnect();

}

catch (Exception e)

{

e.printStackTrace();

}

});

if(isConnectOnStartup() && firstRun)

{

connect(getURL(), getPassword());

}

firstRun = false;

}

private boolean firstRun = true;

private String getURL() throws MinorException

{

return getServerProperties().getSingleProperty("url").getStringValue();

}

private String getPassword() throws MinorException

{

return getServerProperties().getSingleProperty("pass").getStringValue();

}

private boolean isConnectOnStartup() throws MinorException

{

return getServerProperties().getSingleProperty("connect_on_startup").getBoolValue();

}

private void connect(String url, String pass)

{

MotherConnection.setPass(pass);

MotherConnection.setUrl(url);

new OBSActionConnectionTask(true, null, null, null);

}

@Override

public void onShutDown()

{

if(MotherConnection.getRemoteController() != null)

{

MotherConnection.getRemoteController().disconnect();

}

M obssuite/mother/src/main/java/mother/OBSActionConnectionTask.java

+3 −5

package mother;

import mother.motherconnection.MotherConnection;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import javafx.application.Platform;

import javafx.concurrent.Task;

import javafx.scene.control.Button;

import mother.motherconnection.MotherConnection;

import net.twasi.obsremotejava.OBSRemoteController;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

public class OBSActionConnectionTask extends Task<Void>

{

private Runnable onFailToConnectRunnable = null;

private Runnable onConnectRunnable = null;

private Runnable onDisconnectRunnable = null;

public OBSActionConnectionTask(boolean runAsync, Runnable onFailToConnectRunnable,

Runnable onConnectRunnable, Runnable onDisconnectRunnable)

{

this.onFailToConnectRunnable = onFailToConnectRunnable;

this.onConnectRunnable = onConnectRunnable;

this.onDisconnectRunnable = onDisconnectRunnable;

if(runAsync)

{

new Thread(this).start();

}

else

{

call();

}

@Override

protected Void call()

{

try

{

String url = MotherConnection.getUrl();

String pass = MotherConnection.getPass();

setConnectDisconnectButtonDisable(true);

if(!url.startsWith("ws://"))

{

new StreamPiAlert("Invalid URL","Please fix URL and try again", StreamPiAlertType.ERROR).show();

return null;

}

if(pass.isEmpty() || pass.isBlank())

pass = null;

OBSRemoteController obsRemoteController = new OBSRemoteController(url, false, pass);

if(obsRemoteController.isFailed())

{

new StreamPiAlert("Unable to Connect to OBS", "Is it even running? Make sure the websocket plugin is installed. Check Credentials too", StreamPiAlertType.ERROR).show();

}

obsRemoteController.registerConnectionFailedCallback(message->{

setConnectDisconnectButtonText("Connect");

new StreamPiAlert("Unable to Connect", "Unable to establish connection to WebSocket with provided crendentials\n\n"+

"Detailed Error : "+message, StreamPiAlertType.ERROR).show();

MotherConnection.setRemoteController(null);

if(onFailToConnectRunnable != null)

{

onFailToConnectRunnable.run();

onFailToConnectRunnable = null;

}

});

obsRemoteController.registerDisconnectCallback(()->{

setConnectDisconnectButtonText("Connect");

MotherConnection.setRemoteController(null);

if(onDisconnectRunnable != null)

{

onDisconnectRunnable.run();

onDisconnectRunnable = null;

}

});

obsRemoteController.registerConnectCallback(onConnect->{

setConnectDisconnectButtonText("Disconnect");

MotherConnection.setRemoteController(obsRemoteController);

if(onConnectRunnable != null)

{

onConnectRunnable.run();

onConnectRunnable = null;

}

});

}

catch (Exception e)

{

MotherConnection.showOBSNotRunningError();

MotherConnection.setRemoteController(null);

e.printStackTrace();

}

finally

{

setConnectDisconnectButtonDisable(false);

}

return null;

}

private void setConnectDisconnectButtonText(String text)

{

if(MotherConnection.getConnectDisconnectButton() == null)

return;

Platform.runLater(()-> MotherConnection.getConnectDisconnectButton().setText(text));

}

private void setConnectDisconnectButtonDisable(boolean disable)

{

if(MotherConnection.getConnectDisconnectButton() == null)

return;

Platform.runLater(()-> MotherConnection.getConnectDisconnectButton().setDisable(disable));

}

M obssuite/mother/src/main/java/mother/motherconnection/MotherConnection.java

+0 −2

package mother.motherconnection;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.version.Version;

import javafx.scene.control.Button;

import mother.OBSActionConnectionTask;

import net.twasi.obsremotejava.OBSRemoteController;

import net.twasi.obsremotejava.callbacks.Callback;

import net.twasi.obsremotejava.requests.ResponseBase;

public class MotherConnection

{

private static OBSRemoteController obsRemoteController = null;

public static final Version VERSION = new Version(2,0,0);

private static String url = null;

private static String pass = null;

private static Button connectDisconnectButton = null;

public static void setConnectDisconnectButton(Button connectDisconnectButton)

{

MotherConnection.connectDisconnectButton = connectDisconnectButton;

}

public static Button getConnectDisconnectButton()

{

return connectDisconnectButton;

}

public static void setUrl(String url) {

MotherConnection.url = url;

}

public static void setPass(String pass) {

MotherConnection.pass = pass;

}

public static String getUrl() {

return url;

}

public static String getPass() {

return pass;

}

public static void connect()

{

connect(true, null, null, null);

}

public static void connect(Runnable onConnectRunnable)

{

connect(true, null, onConnectRunnable, null);

}

public static void connect(boolean runAsync, Runnable onFailToConnectRunnable,

Runnable onConnectRunnable, Runnable onDisconnectRunnable)

{

new OBSActionConnectionTask(runAsync, onFailToConnectRunnable,

onConnectRunnable, onDisconnectRunnable);

}

public static OBSRemoteController getRemoteController()

{

return obsRemoteController;

}

public static void setRemoteController(OBSRemoteController obsRemoteController)

{

MotherConnection.obsRemoteController = obsRemoteController;

}

public static Callback getDefaultCallBack(String head, String content)

{

return response ->

{

if(response.getStatus().equals("error"))

{

new StreamPiAlert(head, content, StreamPiAlertType.ERROR).show();

}

};

}

public static void showOBSNotRunningError()

{

new StreamPiAlert("Is OBS Connected?",

"It seems there is no connection to OBS, please connect it in Settings", StreamPiAlertType.WARNING)

.show();

}

M obssuite/setcurrenttransition/src/main/java/setcurrenttransition/SetCurrentTransition.java

+0 −3

package setcurrenttransition;

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.exception.MinorException;

import com.stream_pi.util.version.Version;

import mother.motherconnection.MotherConnection;

import net.twasi.obsremotejava.OBSRemoteController;

public class SetCurrentTransition extends NormalAction {

public SetCurrentTransition()

{

setName("Set Current Transition");

setCategory("OBS");

setVisibilityInServerSettingsPane(false);

setAuthor("rnayabed");

setVersion(MotherConnection.VERSION);

}

@Override

public void initProperties() throws Exception

{

Property currentTransitionProperty = new Property("transition", Type.STRING);

currentTransitionProperty.setDisplayName("Transition Name");

Property autoConnectProperty = new Property("auto_connect", Type.BOOLEAN);

autoConnectProperty.setDefaultValueBoolean(true);

autoConnectProperty.setDisplayName("Auto Connect if not connected");

addClientProperties(currentTransitionProperty, autoConnectProperty);

}

@Override

public void onActionClicked() throws Exception

{

String transition = getClientProperties().getSingleProperty("transition").getStringValue();

if(transition.isBlank())

{

throw new MinorException("Blank Transition Name","No Transition Name specified");

}

if (MotherConnection.getRemoteController() == null)

{

boolean autoConnect = getClientProperties().getSingleProperty(

"auto_connect"

).getBoolValue();

if(autoConnect)

{

MotherConnection.connect(()->setTransition(transition));

}

else

{

MotherConnection.showOBSNotRunningError();

}

else

{

setTransition(transition);

}

public void setTransition(String transition)

{

MotherConnection.getRemoteController().setCurrentTransition(transition, setCurrentTransitionResponse -> {

String status = setCurrentTransitionResponse.getStatus();

String error = setCurrentTransitionResponse.getError();

if(status.equals("error"))

{

String content;

if(error.equals("transition does not exist"))

{

content = "Transition "+transition+" does not exist.";

}

else

{

content = error;

}

new StreamPiAlert("OBS",content, StreamPiAlertType.ERROR).show();

}

});

}

M obssuite/setmute/src/main/java/setmute/SetMute.java

+0 −4

package setmute;

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.action_api.externalplugin.ToggleAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.exception.MinorException;

import com.stream_pi.util.version.Version;

import mother.motherconnection.MotherConnection;

import net.twasi.obsremotejava.OBSRemoteController;

public class SetMute extends ToggleAction

{

public SetMute()

{

setName("Set Mute");

setCategory("OBS");

setVisibilityInServerSettingsPane(false);

setAuthor("rnayabed");

setVersion(MotherConnection.VERSION);

}

@Override

public void onToggleOn() throws Exception

{

onClicked(true);

}

@Override

public void onToggleOff() throws Exception

{

onClicked(false);

}

@Override

public void initProperties() throws Exception

{

Property sourceProperty = new Property("source", Type.STRING);

sourceProperty.setDisplayName("Source");

Property autoConnectProperty = new Property("auto_connect", Type.BOOLEAN);

autoConnectProperty.setDefaultValueBoolean(true);

autoConnectProperty.setDisplayName("Auto Connect if not connected");

addClientProperties(sourceProperty, autoConnectProperty);

}

public void onClicked(boolean mute) throws MinorException

{

String source = getClientProperties().getSingleProperty("source").getStringValue();

if(source.isBlank())

{

throw new MinorException("Blank Source Name","No Source specified");

}

if (MotherConnection.getRemoteController() == null)

{

boolean autoConnect = getClientProperties().getSingleProperty(

"auto_connect"

).getBoolValue();

if(autoConnect)

{

MotherConnection.connect(()->setMute(source, mute));

}

else

{

MotherConnection.showOBSNotRunningError();

}

else

{

setMute(source, mute);

}

public void setMute(String scene, boolean mute)

{

MotherConnection.getRemoteController().setMute(scene, mute, setMuteResponse -> {

String status = setMuteResponse.getStatus();

String error = setMuteResponse.getError();

if(status.equals("error"))

{

String content;

if(error.equals("source does not exist"))

{

content = "Source "+scene+" does not exist.";

}

else

{

content = error;

}

new StreamPiAlert("OBS",content, StreamPiAlertType.ERROR).show();

}

});

}

M obssuite/setpreviewscene/src/main/java/setpreviewscene/SetPreviewScene.java

+0 −3

package setpreviewscene;

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.exception.MinorException;

import com.stream_pi.util.version.Version;

import mother.motherconnection.MotherConnection;

import net.twasi.obsremotejava.OBSRemoteController;

public class SetPreviewScene extends NormalAction

{

public SetPreviewScene()

{

setName("Set Preview Scene");

setCategory("OBS");

setVisibilityInServerSettingsPane(false);

setAuthor("rnayabed");

setVersion(MotherConnection.VERSION);

}

@Override

public void initProperties() throws Exception {

Property previewSceneProperty = new Property("preview_scene", Type.STRING);

previewSceneProperty.setDisplayName("Preview Scene");

Property autoConnectProperty = new Property("auto_connect", Type.BOOLEAN);

autoConnectProperty.setDefaultValueBoolean(true);

autoConnectProperty.setDisplayName("Auto Connect if not connected");

addClientProperties(previewSceneProperty, autoConnectProperty);

}

@Override

public void onActionClicked() throws Exception

{

String previewScene = getClientProperties().getSingleProperty("preview_scene").getStringValue();

if(previewScene.isBlank())

{

throw new MinorException("Blank Preview Scene Name","No Preview Scene Name specified");

}

if (MotherConnection.getRemoteController() == null)

{

boolean autoConnect = getClientProperties().getSingleProperty(

"auto_connect"

).getBoolValue();

if(autoConnect)

{

MotherConnection.connect(()->setPreviewScene(previewScene));

}

else

{

MotherConnection.showOBSNotRunningError();

}

else

{

setPreviewScene(previewScene);

}

public void setPreviewScene(String previewScene)

{

MotherConnection.getRemoteController().setPreviewScene(previewScene, setPreviewSceneResponse -> {

String status = setPreviewSceneResponse.getStatus();

String error = setPreviewSceneResponse.getError();

if(status.equals("error"))

{

String content;

if(error.equals("scene does not exist"))

{

content = "Preview Scene "+previewScene+" does not exist.";

}

else

{

content = error;

}

new StreamPiAlert("OBS",content, StreamPiAlertType.ERROR).show();

}

});

}

M obssuite/setrecording/src/main/java/setrecording/SetRecording.java

+0 −6

package setrecording;

import java.util.ArrayList;

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.action_api.externalplugin.ToggleAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.exception.MinorException;

import com.stream_pi.util.version.Version;

import mother.motherconnection.MotherConnection;

import net.twasi.obsremotejava.OBSRemoteController;

public class SetRecording extends ToggleAction

{

public SetRecording() {

setName("Set Recording");

setCategory("OBS");

setVisibilityInServerSettingsPane(false);

setAuthor("rnayabed");

setVersion(MotherConnection.VERSION);

}

@Override

public void onToggleOn() throws Exception

{

onClicked(true);

}

@Override

public void onToggleOff() throws Exception

{

onClicked(false);

}

@Override

public void initProperties() throws Exception

{

Property autoConnectProperty = new Property("auto_connect", Type.BOOLEAN);

autoConnectProperty.setDefaultValueBoolean(true);

autoConnectProperty.setDisplayName("Auto Connect if not connected");

addClientProperties(autoConnectProperty);

}

public void onClicked(boolean record) throws MinorException

{

if (MotherConnection.getRemoteController() == null)

{

boolean autoConnect = getClientProperties().getSingleProperty(

"auto_connect"

).getBoolValue();

if(autoConnect)

{

MotherConnection.connect(()->setRecording(record));

}

else

{

MotherConnection.showOBSNotRunningError();

}

else

{

setRecording(record);

}

public void setRecording(boolean recording)

{

if(recording)

{

MotherConnection.getRemoteController().startRecording(setRecordingResponse -> {

String status = setRecordingResponse.getStatus();

String error = setRecordingResponse.getError();

errorHandler(status, error);

});

}

else

{

MotherConnection.getRemoteController().stopRecording(setRecordingResponse -> {

String status = setRecordingResponse.getStatus();

String error = setRecordingResponse.getError();

errorHandler(status, error);

});

}

private void errorHandler(String status, String error)

{

if(status.equals("error"))

{

new StreamPiAlert("OBS",error, StreamPiAlertType.ERROR).show();

}

M twitch/README.md

+4 −5

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

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.

## Supported actions (see [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

- 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

### Broadcaster and channel editors

- Run commercial

- Host

- Unhost

- Raid

- Unraid

- Add stream marker

- Toggle slow mode

- Toggle subs-only mode

### TODO

- Toggle slow mode

- Toggle followers-only mode

- Toggle subs-only mode

- Toggle emotes-only mode

## Running locally

Copy the `Java-Twirk` and the `twitch-xxx-action` jar files from the `PreBuiltPlugins` directory to your Stream-Pi server plugins' directory.

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.

M twitteraction/src/main/java/com/stream_pi/twitteraction/TwitterAction.java

+4 −8

package com.stream_pi.twitteraction;

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

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

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

import com.stream_pi.action_api.externalplugin.NormalAction;

import com.stream_pi.util.alert.StreamPiAlert;

import com.stream_pi.util.alert.StreamPiAlertListener;

import com.stream_pi.util.alert.StreamPiAlertType;

import com.stream_pi.util.uihelper.HBoxInputBox;

import com.stream_pi.util.version.Version;

import javafx.application.Platform;

import javafx.beans.value.ChangeListener;

import javafx.beans.value.ObservableValue;

import javafx.concurrent.Task;

import javafx.scene.control.*;

import javafx.scene.control.Button;

import javafx.scene.control.Label;

import javafx.scene.control.TextArea;

import javafx.scene.control.TextField;

import javafx.scene.layout.HBox;

import javafx.scene.layout.VBox;

import twitter4j.Status;

import twitter4j.Twitter;

import twitter4j.TwitterException;

import twitter4j.TwitterFactory;

import twitter4j.auth.AccessToken;

import twitter4j.auth.RequestToken;

import twitter4j.conf.ConfigurationBuilder;

import java.net.URI;

import java.util.Random;

public class TwitterAction extends NormalAction {

Button loginAsNewUserButton, logoutButton;

public TwitterAction()

{

setName("Tweet");

setCategory("Twitter");

setAuthor("rnayabed");

setServerButtonGraphic("fab-twitter");

setHelpLink("https://github.com/stream-pi/essentialactions");

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

loginAsNewUserButton = new Button("Login as new user");

loginAsNewUserButton.setOnAction(event-> new Thread(new Task<Void>() {

@Override

protected Void call()

{

try {

Platform.runLater(()->{

loginAsNewUserButton.setDisable(true);

logoutButton.setDisable(true);

});

loginAsNewUser();

} catch (Exception e) {

Platform.runLater(()-> {

Platform.runLater(()->{

loginAsNewUserButton.setDisable(false);

logoutButton.setDisable(false);

});

new StreamPiAlert(e.getMessage(), StreamPiAlertType.ERROR).show();

});

e.printStackTrace();

}

return null;

}

}).start());

logoutButton = new Button("Logout");

logoutButton.setOnAction(event-> new Thread(new Task<Void>() {

@Override

protected Void call()

{

try {

Platform.runLater(()->{

loginAsNewUserButton.setDisable(false);

logoutButton.setDisable(false);

});

logout();

} catch (Exception e) {

Platform.runLater(()-> {

Platform.runLater(()->{

loginAsNewUserButton.setDisable(false);

logoutButton.setDisable(false);

});

new StreamPiAlert(e.getMessage(), StreamPiAlertType.ERROR).show();

});

e.printStackTrace();

}

return null;

}

}).start());

setServerSettingsButtonBar(loginAsNewUserButton, logoutButton);

}

@Override

public void initProperties() throws Exception

{

Property oAuthConsumerKey = new Property("consumer_key", Type.STRING);

oAuthConsumerKey.setDisplayName("API Key");

Property oAuthConsumerKeySecret = new Property("consumer_key_secret", Type.STRING);

oAuthConsumerKeySecret.setControlType(ControlType.TEXT_FIELD_MASKED);

oAuthConsumerKeySecret.setDisplayName("API Key Secret");

Property oAuthAccessToken = new Property("access_token", Type.STRING);

oAuthAccessToken.setDisplayName("Access Token");

oAuthAccessToken.setVisible(false);

Property oAuthAccessTokenSecret = new Property("access_token_secret", Type.STRING);

oAuthAccessTokenSecret.setDisplayName("Access Token Secret");

oAuthAccessTokenSecret.setVisible(false);

addServerProperties(

oAuthConsumerKey,

oAuthConsumerKeySecret,

oAuthAccessToken,

oAuthAccessTokenSecret

);

Property toBeTweeted = new Property("tweet", Type.STRING);

toBeTweeted.setDisplayName("Tweet");

toBeTweeted.setDefaultValueStr("Hello From Stream-Pi!");

toBeTweeted.setCanBeBlank(false);

addClientProperties(

toBeTweeted

);

}

public void loginAsNewUser() throws Exception

{

logout();

getAuthToken();

}

public void logout() throws Exception

{

setNewTwitterConfig(

getServerProperties().getSingleProperty("consumer_key").getStringValue(),

getServerProperties().getSingleProperty("consumer_key_secret").getStringValue(),

null,null

);

}

public void getAuthToken() throws Exception {

RequestToken requestToken = tf.getInstance().getOAuthRequestToken();

String cancel = "Cancel";

String login = "Log In";

TextArea authURLTextArea = new TextArea(requestToken.getAuthorizationURL());

authURLTextArea.setEditable(false);

TextField pinTextField = new TextField();

HBox textBox = new HBoxInputBox("PIN", pinTextField);

Platform.runLater(()->{

try

{

StreamPiAlert alert = new StreamPiAlert("Authorise App", StreamPiAlertType.INFORMATION, cancel, login);

VBox vBox = new VBox(new Label("Go the following Link below, authorise app and then enter the PIN Below"), authURLTextArea, textBox);

vBox.setSpacing(5.0);

alert.setAlertContent(vBox);

alert.show();

alert.setOnClicked(new StreamPiAlertListener(){

@Override

public void onClick(String buttonClicked) {

// TODO Auto-generated method stub

try

{

if(buttonClicked.equals(login))

{

AccessToken accessToken = tf.getInstance().getOAuthAccessToken(requestToken, pinTextField.getText());

getServerProperties().getSingleProperty("access_token").setStringValue(accessToken.getToken());

getServerProperties().getSingleProperty("access_token_secret").setStringValue(accessToken.getTokenSecret());

saveServerProperties();

initAction();

new StreamPiAlert("Success", "Login Successful!", StreamPiAlertType.INFORMATION).show();

}

else

{

initAction();

}

catch (Exception e)

{

new StreamPiAlert(e.getMessage(), StreamPiAlertType.ERROR).show();

e.printStackTrace();

}

});

}

catch (Exception e)

{

new StreamPiAlert(e.getMessage(), StreamPiAlertType.ERROR).show();

e.printStackTrace();

}

finally

{

loginAsNewUserButton.setDisable(false);

}

});

}

TwitterFactory tf;

@Override

public void initAction() throws Exception {

//System.setProperty("twitter4j.http.useSSL", "true");

setNewTwitterConfig(

getServerProperties().getSingleProperty("consumer_key").getStringValue(),

getServerProperties().getSingleProperty("consumer_key_secret").getStringValue(),

getServerProperties().getSingleProperty("access_token").getStringValue(),

getServerProperties().getSingleProperty("access_token_secret").getStringValue()

);

}

public void setNewTwitterConfig(String consumerKey, String consumerKeySecret, String accessToken, String accessTokenSecret)

{

ConfigurationBuilder cb = new ConfigurationBuilder();

cb.setDebugEnabled(true)

.setOAuthConsumerKey(consumerKey)

.setOAuthConsumerSecret(consumerKeySecret)

.setOAuthAccessToken(accessToken)

.setOAuthAccessTokenSecret(accessTokenSecret);

tf = new TwitterFactory(cb.build());

}

@Override

public void onActionClicked() throws Exception {

Twitter twitter = tf.getInstance();

twitter.updateStatus(getClientProperties().getSingleProperty("tweet").getStringValue());

}

/*public String addRandomBlank(String value)

{

return value+("⠀".repeat(new Random().nextInt(100)));

}*/

@Override

public void onShutDown() throws Exception {

// TODO Auto-generated method stub

}

Public

essential-actions

Clone or download

Merge pull request #37 from j4ckofalltrades/code-cleanup

Modified Files