Fascinated/beatsaber-overlay
Fascinated/beatsaber-overlay
Archived
1
1
Fork 0
Code Issues 1 Pull Requests 2 Actions Packages Wiki Activity
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.
ea843e475c
beatsaber-overlay/README.md
Liam ea843e475c
All checks were successful
docker (ubuntu-latest, 2.38.4)
Details
Update 'README.md'
2023-03-28 04:02:31 +01:00

1.1 KiB
Raw Blame History

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

Todo

  • Add toggle for showing pp
  • Change the song time to a circular style in the song art
  • Add overall stream stats (avg acc, misses, highest combo)
  • Add option to scale the ui using css scale

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