# BeatSaber Overlay with real-time data from HttpSiraStatus

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

## Usage

You will need [HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus) if you wish to use the note cut and/or the song info</br>
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</br>
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](https://cdn.fascinated.cc/bAmrOfUvLv.png?raw=true)
![Builder Menu](https://cdn.fascinated.cc/QwGTQLhJsq.png?raw=true)

## Todo

- Cache BeatSaver data
- 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:

```bash
npm i
# or
yarn
```

Secondly, open the development server

```bash
npm run dev
# or
yarn dev
```

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