Just a lil' pal popping up on your stream.
When added as a browser source to your streaming software of choice (e.g. OBS), a lil' pal will appear after a random amount of time on a corner of your screen. Why? Because it's fun!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Before you begin, ensure you have met the following requirements:
- Download and install Node.js matching for your operating system.
- The LTS (Long-term Support) version is recommended for most users.
- Download the code and go to the Streampals folder.
- Build the project by running:
npm install - Run the project:
node index.js
All the files you need to host Streampals are within the dist folder.
Steps:
- Download the files, and place the files from the dist folder wherever you want to keep them.
- In your server hosting, point the desired path to the streampals.html file from
the
distfolder. - That should be all!
Streampals is also available as a Docker image on Docker Hub.
To use, run the following command and replace [PORT] with the port you want the application to run on:
docker run -it -d -p [PORT]:3000 zephsinx/streampals:latestFor example, the following will make the application run on port 3123.
docker run -it -d -p 3123:3000 zephsinx/streampals:latest- Add a new Browser Source to your broadcasting software (e.g. OBS).
- In the URL field, enter
https://streampals.zephsinx.com.- If running locally, use
http://localhost:3000
- If running locally, use
- Enjoy!
The default behavior of Streampals can be modified by adding query parameters to the Streampals URL. Hosted URL coming soon.
Example:
https://streampals.zephsinx.com?skipDelay=true&maxWidth=30&maxHeight=45
The displayed media can be overriden using the mediaUrl parameter. Keep in mind, while Streampals attempts to
calculate the media duration, you may need to manually specify the display time (in seconds) via the mediaDuration
parameter.
For example:
https://streampals.zephsinx.com?mediaUrl=https://upload.wikimedia.org/wikipedia/commons/2/2c/Rotating_earth_%28large%29.gif&mediaDuration=2.75
| Parameter | Type | Default | Description |
|---|---|---|---|
skipDelay |
bool |
false |
Whether to skip the delay between media plays |
min |
float |
30 |
The minimum amount time to wait between media plays in minutes |
max |
float |
90 |
The maximum amount of time to wait between media plays in minutes |
maxHeight |
float |
25 |
The maximum height of the media being displayed on screen. Value is a percentage of the total screen size |
maxWidth |
float |
25 |
The minimum height of the media being displayed on screen. Value is a percentage of the total screen size |
mediaUrl |
float |
default-media.gif |
Override URL of media to display. Used to provide a custom image or video to play |
mediaDuration |
float |
None (calculated) | Duration of media in seconds (decimals are accepted). Streampals attempts to calculate the media duration, but in the case the calculation fails it should be provided here |
Streampals uses SemVer for versioning. For the versions available, see the tags on this repository.
Please note that any release prior to 1.0.0 should be expected to contain breaking changes.
- zephsinx - Development - zephsinx
- Dudlik - Main idea & design consultation - ttv/Dudlik, Dudlik
See also the list of contributors who participated in this project.
This project is licensed under the ISC License - see the LICENSE file for details
- Credit for the idea for Streampals goes to Mark Dudlik. Find his work at dudlik.co, or
streaming on Twitch
at twitch.tv/dudlik
- Credit to the temporary worm GIF being used goes to Michelle Porucznik. See more of their work at https://porucz.com/
