- Streamroller (current dev. stage: Prototyping v -0.000000001)
- Security
- Installing
- Current Functionality
- Links
Contacts:(For questions, suggestions etc.)
StreamRoller is a tool designed to bring all the data needed for streaming into one system to make it easier to expand your streaming features. i.e. want to post your alerts to discord/twitter without having to code a discord and twitter bot? Just load the existing extensions for twitter and discord, then forward the alert message to them to do the work for you.
As the core extensions are expand you should be able to turn any idea you might want to do into reality with a minimum of effort by controlling what messages/data go from and to.
I found while streaming I would have so many programs open (discord, twitch, chatty, UpDeck (ipad style streamdeck),StreamLabsChatbot). Fitting them all on one screen and or switching between them became a pain.
I was also finding I wanted to do things that I can't easily do. ie posting donation alerts on twitter or discord. Giving chat some extra contorols (maybe some OBS scene items they can turn on or off etc).
Currently StreamRoller should be considered in prototyping stage (yup not even Alpha yet). There will probably be lots of big changes as the design ideas change.
The end goal will reamin the same, a simply and easy system to use to get your ideas working. Want to have donations written on a whiteboard behind you by a 3D printer style aparatus, a few lines of code will do it (assuming someone has written the extension for that devide already)
The main goals of StreamRoller are the following:
- Single full screen webapp with all live streaming controls on one page (OBS,chat,bots etc) for the streamer
- Easy to configure by anyone with a minimal of coding experience. (currently JS, in future plans other language API's to be added. ie python API)
- Distributed. Extensions run off sockets so they can be distributed if required.
- Extensions can be run on any PC as long as they have internet access to the backend. ie. A moderator app can run on the moderators PC, a weather app can run on a RaberryPI in the shed, a game data app run on the gamers PC (esports style) etc.
- If IRL streaming the live control web page could be on a phone while the rest runs at home allowing an noSignal scene to kick in when your phone connection goes down.
- If two PC's are available the StreamRoller system can run on a second PC with only a webbrowser needing to connect to it for cotrolling everything.
Note: Currently the system should be considered insecure.
Security will be added later.
At it's current stage the use case for this software to be run in a controlled environment (ie at home behind your routers firewall).
Login/users and SSL security will be added later
Note for streaming: Additional sofware needed. The free broadcasting software OBS Studio is required. Also an overlay for your stream is recommended to show alers etc. There is a small overlay demo version included to show how to trigger alerts using StreamRoller to provide the data.
Currently (as we are using StreamLabsAPI) you will receive alerts for both Twitch and Youtube (untested but you should also get provided with info for Mixer, facebook, Trovo and TikTok if from streamlabs)
Streamroller needs the node.js webserver installed to run. It is recommended to use VSCode to modify/change/add extra features. This VSCode editor provides a lot of nice features for development.
Grab a copy of this repo and unzip it somewhere (Streamroller Download)
cd into the StreamRoller directory and run the following commands
These install the required dependancies needed. This may take a few minutes the first time it is run.
npm install
Start the server with the following comand on windows (run in the root folder)
run.cmd
or for linux
node /backend/datacenter/server.js
At this point the node webserver will start up and load any extensions currently in the extension directory. point a webrowser at http://localhost:3000 to see it running.
Note: Credentials are set through the admin webpage http://localhost:3000/adminpage/
If connecting to twitch/discord/youtube etc you will need to configure your login credentials/tokens etc as required by the extensions
Most extensions require these keys/tokens to be set from the admin settings popup for each extension (note you may need to restart the StreamRoller service when changing them depending on the extension, most shouldn't need a restart though)
To add credentials enter them on the admin page by clicking on the extension you wish to authorize.
At the time of writing the system has twitchchat, discord, twitter, streamlabs (for alerts etc) and obs datahandling extensions, a chatbot and demo overlay (if you want to use the system for your overlay). These extensions sit behind an API so that controller extensions like the existing Adminpage web page/Live Portal web page/and demo obs overlay files can easily send and received whatever messages they wish.
A lot of funtionality at this point is either non existant or in progress. If you have a play with the system and produce something useful or expand an existing extension please let me know.
For development of existing functionality I'd expect people to focus on one extension rather than try and understand the whole system backend. i.e. a moderator extension that can be used by all chat extensions, such that if it needs to ban a user it will just send a message to the twitch/youtube API for that extension rather than connect to the IRC chat itself.
See the Extension List for the full list
Provides a webpage to configure the system
The live streaming portal is a webpage that you can use on your second monitor to show all the information/settings you need on one page.
- Join a twitch chat channel to send receive chat messages
- Post alerts to a named discord channel
- Receive messages from a given discord channel (currently used in live page as a Mod messages window)
- Povides alerts data from streamlabs for twitch alerts and streamlab donations
- Used in the discord chat extension to alerts them to discord
- Used in demo-overlay (I also run my overlay off StreamRoller so that uses these as well
- Post messages to twitter (need to add a reader output)
- Receive status upadates from obs (stream started, scene changed etc)
- Control obs (change scenes, mute scene)
These are extension that use the data provided by the above extensions to do something usefull
- Provides a chatbot using the openAI chatGPT system
- Monitors chat and occasionally pops in with messages based on the conversation
- Can be asked questions that are processed by the openAI system
- pretty much everything currently available
Lots :D
- Installation system to make it easier for people to install without having to do commandline stuff
- proper messaging API so that dev's have an easier time expanding/writing extensions
- more data extensions (ie youtube, specific games, home control etc)
The current focus in on twitch streaming (although the streamlabs api currently supports other platforms as is). Other platforms will be integrated in time (Youtube etc)
- Twitch pub/sub: to allow twitch control (setting title, category, bannign users etc)
- moderator chatbot: one bot that will work with all the chat extension to provide a single moderator bot for all chat channels (discord/twitch/youtube/facebook etc)
- NDI stream extension to allow easy integration of external video feeds
- chat auto language conversion.
- TextToSpeech for chat. So us streamers don't have to focus on chat all the time :P
- Chat audio feedback. This will play sounds based on chat. ie laugh track, applause based on the % of people posting emotes. note: suggestions welcome for this list
-
How to install/start/use the system
-
List of current extensions with links to additional documentation
These can be found by following the Extension list above and clicking the extension name you are interested in.
-
Getting started with developing extensions
-
A description of how to use the message system to send/receive data