https://github.com/nafeu/livestream-assets
Generate web-based UI components for livestreaming with OBS
https://github.com/nafeu/livestream-assets
Last synced: about 1 month ago
JSON representation
Generate web-based UI components for livestreaming with OBS
- Host: GitHub
- URL: https://github.com/nafeu/livestream-assets
- Owner: nafeu
- License: mit
- Created: 2023-01-18T22:35:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-20T05:42:37.000Z (over 2 years ago)
- Last Synced: 2025-04-09T22:57:38.743Z (about 1 month ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Livestream Assets
Generate web-based UI components for livestreaming (works with OBS).
> Available Assets
| Asset Type | Options | Preview |
|-----------------|--------------|--------------|
| Rotating Badges | TODO: Update | TODO: Update |
## Installation
```
git clone https://github.com/nafeu/livestream-assets.git
cd livestream-assets
npm install
```
## Usage
Create a config file:
```
cp sample-config.json config.json
```
Update all of the info inside `config.json` and then run the build command to generate all of your assets:
```
npm run build
```
Open the `exports` folder and examine all of your exported assets.
### Using with OBS
All assets are exported as individual `.html` files which are compatible with OBS's *Browser Source* option. Just use the `Local file` option when creating a browser source and select an exported asset. Read [here](https://obsproject.com/kb/browser-source#:~:text=Browser%20source%20is%20one%20of,video%2C%20and%20even%20audio%20tasks.) for more info on the *browser-source* option.
## Development
Recommend using [nodemon](https://nodemon.io/) to keep the build script running and re-running on file-change.
```
nodemon index.js
```
Modify the templates and generators located in the `js` files in `generators/`.
## License
[MIT](https://choosealicense.com/licenses/mit/)