Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 902 Bytes

README.md

File metadata and controls

27 lines (19 loc) · 902 Bytes
Raw

BeatSaber Overlay with real-time data from HttpSiraStatus

The project is on my Gitea now, but the repo will be kept in sync on GitHub.
The public url to view/use: https://bs-overlay.fascinated.cc
Need help? Feel free to message me on Discord: Fascinated#7668 or Matrix: @fascinated:matrix.fascinated.cc

Usage

Go to the Wiki

Preview

Overlay Builder Menu

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 :)