comparing e6e204a8cd3b4a687b167b88e07fc030f177ac03 and main on treybastian.com/winterVibesJS

+39 -9

README.md

···

       1
       1
       -
       # winterVibesJS

     

       2
       2
       -
       No build JS twitch wintery overlay.

     

       1
       1
       +
       # Winter Vibes JS

     

       2
       2
       +
       Simple, no build OBS winter overlay!

     

       3
       3
        
       

     

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

     

       4
       4
       +
       ## About

     

       5
       5
        
       

     

       6
       6
       -
       ## 0 Dependencies required!

     

       7
       7
       -
       This project has no required dependencies.

     

       6
       6
       +
       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!!

     

       8
       7
        
       

     

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

     

       8
       8
       +
       You 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")

     

       10
       9
        
       

     

       11
       11
       -
       Everything uses JSDoc

     

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

     

       12
       11
        
       

     

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

     

       13
       13
       +
       - Window size

     

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

     

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

     

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

     

       13
       17
        
       

     

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

     

       15
       18
        
       

     

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

     

       19
       19
       +
       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.

     

       20
       20
       +
       

     

       21
       21
       +
       To run it, use:

     

       22
       22
       +
       ```sh

     

       23
       23
       +
          pnpm run dev

     

       24
       24
       +
          ```

     

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

     

       26
       26
       +
       

     

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

     

       28
       28
       +
       ```sh

     

       29
       29
       +
          pnpm install

     

       30
       30
       +
          ```

     

       31
       31
       +
       

     

       32
       32
       +
       ## WIP

     

       33
       33
       +
       

     

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

     

       35
       35
       +
       - [ ] Plow direction - Right

     

       36
       36
       +
       - [ ] More customization

     

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

     

       38
       38
       +
       

     

       39
       39
       +
       

     

       40
       40
       +
       ## Contributing

     

       41
       41
       +
       

     

       42
       42
       +
       This project is open source, not just public source.

     

       43
       43
       +
       

     

       44
       44
       +
       To contribute email a git patch to patches@treybastian.com

     

       45
       45
       +
       

     

       46
       46
       +
       I do not accept pull requests on any of my projects.

+1 -2

index.html

···

       12
       12
        
             <div id="contextMenu" class="context-menu" style="display:none">

     

       13
       13
        
               <ul>

     

       14
       14
        
                   <li><a href="./src/pages/config.html">Settings</a></li>

     

       15
       15
       -
                   <li><a href="https://github.com/TreyBastian/winterVibesJS/blob/main/README.md" target="_blank">Help</a></li>

     

       16
       16
       -
                   <li><a href="https://buymeacoffee.com/treysdevshed" target="_blank">Buy me a coffee</a></li>

     

       15
       15
       +
                   <li><a href="https://tangled.org/TreyBastian.com/winterVibesJS" target="_blank">Help</a></li>

     

       17
       16
        
               </ul>

     

       18
       17
        
             </div>

     

       19
       18

+70

···

       1
       1
       +
       [?1049h[?1h=[H[2J[?2004h[?u[c[?25h[?25l(B[m[H                                                                                

     

       2
       2
       +
                                                                                       

     

       3
       3
       +
                                                                                       

     

       4
       4
       +
                                                                                       

     

       5
       5
       +
                                                                                       

     

       6
       6
       +
                                                                                       

     

       7
       7
       +
                                                                                       

     

       8
       8
       +
                                                                                       

     

       9
       9
       +
                                                                                       

     

       10
       10
       +
                                                                                       

     

       11
       11
       +
                                                                                       

     

       12
       12
       +
                                                                                       

     

       13
       13
       +
                                                                                       

     

       14
       14
       +
                                                                                       

     

       15
       15
       +
                                                                                       

     

       16
       16
       +
                                                                                       

     

       17
       17
       +
                                                                                       

     

       18
       18
       +
                                                                                       

     

       19
       19
       +
                                                                                       

     

       20
       20
       +
                                                                                       

     

       21
       21
       +
                                                                                       

     

       22
       22
       +
                                                                                       

     

       23
       23
       +
                                                                                       

     

       24
       24
       +
                                                                                       [?1004h[?25h[?25l[H(B[m  1                                                                             

     

       25
       25
       +
       ~[K

     

       26
       26
       +
       ~[K

     

       27
       27
       +
       ~[K

     

       28
       28
       +
       ~[K

     

       29
       29
       +
       ~[K

     

       30
       30
       +
       ~[K

     

       31
       31
       +
       ~[K

     

       32
       32
       +
       ~[K

     

       33
       33
       +
       ~[K

     

       34
       34
       +
       ~[K

     

       35
       35
       +
       ~[K

     

       36
       36
       +
       ~[K

     

       37
       37
       +
       ~[K

     

       38
       38
       +
       ~[K

     

       39
       39
       +
       ~[K

     

       40
       40
       +
       ~[K

     

       41
       41
       +
       ~[K

     

       42
       42
       +
       ~[K

     

       43
       43
       +
       ~[K

     

       44
       44
       +
       ~[K

     

       45
       45
       +
       ~[K

     

       46
       46
       +
       (B[0;7mREADME                                                        0,0-1          All(B[m

     

       47
       47
       +
       [J[2 q[2 q[?1002h[?1006h[H  1   [K

     

       48
       48
       +
       ~[K

     

       49
       49
       +
       ~[K

     

       50
       50
       +
       ~[K

     

       51
       51
       +
       ~[K

     

       52
       52
       +
       ~[K

     

       53
       53
       +
       ~[K

     

       54
       54
       +
       ~[K

     

       55
       55
       +
       ~[K

     

       56
       56
       +
       ~[K

     

       57
       57
       +
       ~[K

     

       58
       58
       +
       ~[K

     

       59
       59
       +
       ~[K

     

       60
       60
       +
       ~[K

     

       61
       61
       +
       ~[K

     

       62
       62
       +
       ~[K

     

       63
       63
       +
       ~[K

     

       64
       64
       +
       ~[K

     

       65
       65
       +
       ~[K

     

       66
       66
       +
       ~[K

     

       67
       67
       +
       ~[K

     

       68
       68
       +
       ~[K

     

       69
       69
       +
       (B[0;7mREADME                                                        0,0-1          All(B[m

     

       70
       70
       +
       [J[1;7H[?25h[?25l[2 q[?1002l[?1006l(B[m[?25h[2 q[?1l>[>4;0m[?2004l[?1004l[c[?25h[?25l
[23B[?1049l[?25h

Compare changes