This is a basic app for generating a local web page with cycling text, pulled from different text file sources, to be used as a browser source in streaming applications such as OBS. Currently, this is intended to be used alongside applications that will generate text files with data from Twitch (eg, StreamLabels by StreamLabs and Muxy Ticker by Muxy).
This is currently a basic prototype but should (hopefully) be fairly simple to setup and to customise. Please follow these steps to try the app out and feel free to send feedback.
- NodeJS
- Stream Labels or similar to generate text files
- (optional) A decent text editor such as Notepad++ or Atom
Download the above zip file and extract.
All customisation can be made in the file config.json.
PLEASE NOTE Windows users will need to change all backslashes (\) to forward slash (/) for the file paths.
- Right click the
config.jsonfile and click edit, or open it your favourite text editor - In the list under "files", replace this list with the full file path for each text file you want included (making sure to replace backslash with forward slash). Each line after the first filepath needs to start with a comma (,) and all will need to be contained in quotation marks. You can have as many or as little as you want
- If you would like to set some defined text before the information from the text files listed above, go to "prefix" set enable to "yes".
- You will need the same amount of items under list as there is for files. If you don't want a prefix for all files, you can leave them blank with "".
- Set your preferred options for text options (see Configuration section for current options)
- Save and close the file
- Double click the included
install.bat
- Open command prompt or terminal
- Change directory to the folder you extracted the zip file to
- Run the following command to install all dependencies
npm install
- Double click the included
start.batfile (or create a shortcut to it elsewhere)
- Change directory to the folder you extracted the zip file to
- Run the following command to start the app
node app.js - This should display the URL to use for testing and adding to OBS / Xsplit
- Font - A good starting list can be found here
- Size - Set in pixels
- Bold - Yes or No
- Italic - Yes or No
- Colour - This can be a hex value (eg, "#000000"), or a named colour (eg, "green")
- Type - Either "glow" or "outline"
- Size - This will set the size of the glow or outline
- Colour - This can be a hex value (eg, "#000000"), or a named colour (eg, "green")
- Type - This can be either "swipeUp" or "swipeDown". This is still in progress. Up is centred text and down is left aligned text
- Time - This is the amount of time in seconds that each text file is displayed for
- Implement config file for all user defined variables
- Simplify the method of setting files to read
- Implement predefined text styling to be used through config file options
- Improve predefined text styling options
- Implement optional label prefixes and suffixes
- Create a configuration interface
- Use Twitch API to obtain information rather than relying on 3rd party application for text files
- Think of the next things to do