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.
756138f8a0
beatsaber-overlay/README.md
Liam bbff99aff0 Add todo and remove mockdata
2022-10-20 15:59:03 +01:00

1.1 KiB
Raw Blame History

BeatSaber Overlay with real-time data from HttpSiraStatus

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 it is fairly self explanatory on how it all works

Preview

Overlay Builder Menu

Todo

  • Move caches to Redis
  • Move media to my CDN server
  • Cache BeatSaver data
  • Add cache status in the response headers
  • Move configuration files to ENV files
  • Add toggle for showing pp
  • Cleanup the API (or just re-do it)
  • 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 :)