commit ad0bdd177ce540c1894a5a40046d059197e56c43 · treybastian.com/winterVibesJS

+48 -9
README.md
···

       1
       1
       -
       # winterVibesJS

     

       2
       2
       -
       No build JS twitch wintery overlay.

     

       1
       1
       +
       <br />

     

       2
       2
       +
       <div align="center">

     

       3
       3
       +
       

     

       4
       4
       +
         <h3 align="center">Winter Vibes JS</h3>

     

       5
       5
       +
       

     

       6
       6
       +
         <p align="center">

     

       7
       7
       +
           Simple, no build OBS winter overlay!

     

       8
       8
       +
           <br />

     

       9
       9
       +
           <a href="https://treybastian.github.io/winterVibesJS/?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">Github Pages</a>

     

       10
       10
       +
           ·

     

       11
       11
       +
           <a href="https://github.com/TreyBastian/winterVibesJS/blob/main/README.md">Docs</a>

     

       12
       12
       +
           ·

     

       13
       13
       +
           <a href="https://github.com/TreyBastian/winterVibesJS/issues/new">Report Bug</a>

     

       14
       14
       +
         </p>

     

       15
       15
       +
       </div>

     

       16
       16
       +
       

     

       17
       17
       +
       ## About

     

       18
       18
       +
       

     

       19
       19
       +
       This 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!!

     

       20
       20
       +
       

     

       21
       21
       +
       You can find it at <a href="https://treybastian.github.io/winterVibesJS/?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">GitHub pages</a>.

     

       22
       22
       +
       

     

       23
       23
       +
       Once on the page, you can right-click, and a context menu will appear, from which you can navigate to settings.

     

       24
       24
       +
       

     

       25
       25
       +
       ##### What all can you adjust:

     

       26
       26
       +
       - Window size

     

       27
       27
       +
       - Snow (max, size, speed)

     

       28
       28
       +
       - Plow (speed, direction WIP, scale)

     

       29
       29
       +
       - Ground (accumulator max, accumulator slices)

     

       3
       30
        
       

     

       4
       4
       -
       Run locally and tweak or add the Github page https://treybastian.github.io/winterVibesJS as a browser source.

     

       5
       31
        
       

     

       6
       6
       -
       ## 0 Dependencies required!

     

       7
       7
       -
       This project has no required dependencies.

     

       32
       32
       +
       You 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.

     

       8
       33
        
       

     

       9
       9
       -
       The only dependency in package.json is vite for HMR purposes while developing.

     

       34
       34
       +
       To run it, use:

     

       35
       35
       +
       ```sh

     

       36
       36
       +
          pnpm run dev

     

       37
       37
       +
          ```

     

       38
       38
       +
       or any other way you would like to render index.html

     

       10
       39
        
       

     

       11
       11
       -
       Everything uses JSDoc

     

       40
       40
       +
       Optionally, if you want to use dependencies:

     

       41
       41
       +
       ```sh

     

       42
       42
       +
          pnpm install

     

       43
       43
       +
          ```

     

       12
       44
        
       

     

       45
       45
       +
       ## WIP

     

       13
       46
        
       

     

       14
       14
       -
       # THIS IS NOT DONE YET AND IS A WIP

     

       47
       47
       +
       Keep in mind that this project is still a work in progress. Some features are not yet implemented.

     

       48
       48
       +
       - [ ] Plow direction - Right

     

       49
       49
       +
       - [ ] More customization

     

       50
       50
       +
       - [ ] More weather types... 

     

       15
       51
        
       

     

       16
       16
       -
       # WARNING The query parameters are versioned, but the version isn't enforced yet bookmarks may be unstable

     

       52
       52
       +
       

     

       53
       53
       +
       ## Contributing

     

       54
       54
       +
       

     

       55
       55
       +
       If you would like to contribute to the project, please fork the repo and create a pull request. All suggestions are appreciated! For any bugs, you can open an issue and provide more information about the bug, so we can fix it as quickly as possible!