Fascinated/beatsaber-overlay
Fascinated/beatsaber-overlay
Archived
1
1
Fork 0
Code Issues 1 Pull Requests 2 Actions Packages Wiki Activity
BeatSaber Overlay with real-time data from HttpSiraStatus. Can also show stats from ScoreSaber and BeatLeader! https://bs-overlay.fascinated.cc/
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.
158 Commits 3 Branches 0 Tags 3.4 MiB
JavaScript 66.5%
TypeScript 27.9%
CSS 4.2%
Dockerfile 1.4%
756138f8a0
Go to file
Liam 756138f8a0 Moved caches to redis
2022-10-20 18:00:27 +01:00
.github Create dependabot.yml 2022-10-19 18:34:44 +01:00
pages Moved caches to redis 2022-10-20 18:00:27 +01:00
public Added favicion and moved meta tags to _document 2022-10-19 19:49:15 +01:00
src Moved caches to redis 2022-10-20 18:00:27 +01:00
styles Added support for loading during song 2022-10-20 12:40:21 +01:00
utils Switch to enviroment variables 2022-10-20 16:13:45 +01:00
.env.local-example Moved caches to redis 2022-10-20 18:00:27 +01:00
.eslintrc.json Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
.gitignore Update .gitignore 2022-10-19 18:39:17 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-10-19 18:32:50 +01:00
LICENSE Create LICENSE 2022-10-19 18:31:44 +01:00
next.config.js Updated 2022-04-02 07:01:58 +01:00
package-lock.json Bump eslint-config-next from 12.0.10 to 12.3.1 2022-10-19 17:57:30 +00:00
package.json Moved caches to redis 2022-10-20 18:00:27 +01:00
README.md Add todo and remove mockdata 2022-10-20 15:59:03 +01:00
yarn.lock Moved caches to redis 2022-10-20 18:00:27 +01:00

README.md

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