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

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

  • Install HttpSiraStatus
  • Go to https://bs-overlay.fascinated.cc
  • Set the values in the configuratator
  • Click on Open Overlay
  • Create a browser window in your streaming software of choice
  • Set the height to 1920 and width to 1080
  • Set the URL to the newly opened window in your browser

Preview

Overlay Builder Menu

Todo

  • Add toggle for showing pp
  • Change the song time to a circular style in the song art

Getting started with developent

  • Clone the repo
  • Move into the cloned directory
  • Run npm install
  • Rename the .env-example to .env
  • Create a redis server with a password
  • Setup the .env
  • Run npm run dev
  • Open http://localhost:3000

If you want your changes to be in the main branch, feel free to open a pull request :)