A browser source overlay for winter vibes for your Live Streams or Videos
1# Winter Vibes JS
2Simple, no build OBS winter overlay!
3
4## About
5
6This is a simple winter overlay you can use for your Twitch stream or for anything else! What does it do? It adds snow that you can adjust, and a small plow that will clear all the accumulated snow. The easiest way to use it for your stream is by adding it as a browser source in OBS, and boom, it's snowing!!
7
8You can find it at [https://wintervibes.treybastian.com](https://wintervibes.treybastian.com/index.html?v=1&cw=320&ch=180&smx=40&smnsz=1&smxsz=4&smxspd=0.07&snmnspd=0.04&plwspd=0.1&plwd=left&plws=1&gamax=4&gas=20")
9
10Once on the page, you can right-click, and a context menu will appear, from which you can navigate to settings.
11
12##### What all can you adjust:
13- Window size
14- Snow (max, size, speed)
15- Plow (speed, direction WIP, scale)
16- Ground (accumulator max, accumulator slices)
17
18
19You can run it locally if you want to change sprites or any other code. It has 0 dependencies; the only dependency in the `package.json` is Vite for HMR purposes while developing.
20
21To run it, use:
22```sh
23 pnpm run dev
24 ```
25or any other way you would like to render index.html
26
27Optionally, if you want to use dependencies:
28```sh
29 pnpm install
30 ```
31
32## WIP
33
34Keep in mind that this project is still a work in progress. Some features are not yet implemented.
35- [ ] Plow direction - Right
36- [ ] More customization
37- [ ] More weather types...
38
39
40## Contributing
41
42This project is open source, not just public source.
43
44To contribute email a git patch to patches@treybastian.com
45
46I do not accept pull requests on any of my projects.