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.
494 Commits 3 Branches 0 Tags 3.4 MiB
JavaScript 66.5%
TypeScript 27.9%
CSS 4.2%
Dockerfile 1.4%
1c10ea1fdc
Go to file
dependabot[bot] 1c10ea1fdc
Bump zustand from 4.2.0 to 4.3.1 
Bumps [zustand](https://github.com/pmndrs/zustand) from 4.2.0 to 4.3.1.
- [Release notes](https://github.com/pmndrs/zustand/releases)
- [Commits](https://github.com/pmndrs/zustand/compare/v4.2.0...v4.3.1)

---
updated-dependencies:
- dependency-name: zustand
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-10 18:55:41 +00:00
.github Create codeql.yml 2023-01-08 15:49:07 +00:00
public Remove __ENV.js 2022-10-29 13:29:59 +01:00
src Add transition to greyscale song art on pause 2023-01-08 14:56:01 +00:00
.drone.yml Remove useless expose port 2022-10-26 22:08:00 +01:00
.env.example Updated example .env 2022-10-26 17:17:17 +01:00
.eslintrc.json Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
.gitignore Remove __ENV.js 2022-10-29 13:29:59 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-10-19 18:32:50 +01:00
docker-compose.yml Add volume mount for Redis 2022-10-27 21:14:35 +01:00
Dockerfile Maybe make docker image smaller? 2023-01-08 13:42:26 +00:00
LICENSE Create LICENSE 2022-10-19 18:31:44 +01:00
next-env.d.ts TypeScript woop 2022-10-22 12:28:24 +01:00
next.config.js Add BeatLeader score modifier support 2022-12-11 09:42:24 +00:00
package-lock.json Bump zustand from 4.2.0 to 4.3.1 2023-01-10 18:55:41 +00:00
package.json Bump zustand from 4.2.0 to 4.3.1 2023-01-10 18:55:41 +00:00
README.md Update README.md 2023-01-08 13:46:54 +00:00
tsconfig.json maybe fix 2022-10-29 14:46:17 +01:00
yarn.lock Bump zustand from 4.2.0 to 4.3.1 2023-01-10 18:55:41 +00: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

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