Git Product home page Git Product logo

beatsaber-counter-widget's Introduction

Security notes

DON'T replace files in the bundle with files created by somebody else (especially if you don't trust sender OR you don't know the origin of those files)

Setup

  1. Prerequisites
  1. Download release from releases page (https://github.com/Duelsik/beatsaber-counter-widget/releases/)
  2. Unzip to empty (separate) folder
  3. Add (drag&drop works) index.html from unpacked folder to obs scene.

(I am thinking about adding support for datapuller)

Config

No configuration required, but you might want to change styles.css and/or config.js.

  • Configuration basics (you can open css and js files in notepad or pretty much any text editor):
    • To change colors/appearance use styles.css
    • To change the text displayed in widget:
      • Go to config.js
      • Locate line with return `Bloqs booped ${notesCut}`;
      • Replace content between backticks (`) and use ${notesCut} as a place where number will be displayed.
        • For example:
          • If you want to display "Box destroyed: 12312 (and counting)"
          • Then this line should be return `Box destroyed: ${notesCut} (and counting)`;
    • To change colors/appearance of "perfect cuts" use stylesPerfectCuts.css
    • To change bahavior of "perfect cuts" use configPerfectCuts.js (note it doesn't fully work, I need to add more params to perfect cuts to make it fully customisable, but I am starting stream in 5 minutes so I wanted to just push out 0.0.2, sorry <3)

Testing

If you add "?dev" at the end of address - widget will automagically generate events.

Building

  • Have node@16 installed, or use nvm and run nvm use in project root dir
  • Install packages using yarn
  • Build project via yarn build or start dev server via yarn start

Help with customization and features

Feel free to write to me if you want to request some feature or you have problems with config.

Contact

Discord server: https://discord.gg/vKAsUUs discord channel: #overlay-widget-bloq-counter

beatsaber-counter-widget's People

Contributors

danielduel avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.