This repository contains the source code for a custom widget designed for use with Open Broadcaster Software (OBS). The widget is built using HTML, CSS, and JavaScript, and is integrated with Webpack for efficient bundling. Tailwind CSS and PostCSS have been employed to enhance the styling capabilities. As this project is still in active development, some features may be in experimental stages.
- Describe the key features of your OBS widget.
- List any unique selling points or interesting functionalities.
To install the widget, follow these steps:
- Clone the Repository
git clone https://github.com/yourusername/custom-obs-widget.git
cd custom-obs-widget
- Install Dependencies
npm install
- Build the Project
npm run build
To use the widget in OBS:
- Build the project following the installation instructions.
- In OBS, add a new browser source and point it to the
index.htmlin thedistfolder.
This project is still under development. To contribute, you can:
- Fork the repository.
- Create a new branch for your feature (
git checkout -b feature/YourFeatureName). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin feature/YourFeatureName). - Open a new pull request.
Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Your Name - @your_twitter - email@example.com
Project Link: https://github.com/yourusername/custom-obs-widget
- OBS Studio
- Webpack
- Tailwind CSS
- PostCSS
- Any other acknowledgements