This repository has been archived on 2023-11-06. You can view files and clone it, but cannot push or open issues or pull requests.
beatsaber-overlay/README.md
2022-10-26 15:19:34 +01:00

1.3 KiB

BeatSaber Overlay with real-time data from HttpSiraStatus

Build Status

The public url to view/use: https://bs-overlay.fascinated.cc
Need help? Feel free to message me at: Fascinated#4719

Usage

You will need HttpSiraStatus if you wish to use the note cut and/or the song info
To get started go to https://bs-overlay.fascinated.cc and fill the forum in then go to OBS (or your streaming software) and click Open Overlay
Then create a browser window and set the height to 1920 and the width to 1080 then put the URL in the browser window and bam! it should all work

Preview

Overlay Builder Menu

Todo

  • Make BeatLeader pp count check for modifiers
  • Add toggle for showing pp
  • Change the song time to a circular style in the song art

Getting Started with developent

First, install the node dependencies:

npm i
# or
yarn

Secondly, open the development server

npm run dev
# or
yarn dev

Lastly, open the project with an IDE of your choice :)