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.
308 Commits 3 Branches 0 Tags 3.4 MiB
JavaScript 66.5%
TypeScript 27.9%
CSS 4.2%
Dockerfile 1.4%
3e56a16b14
Go to file
Liam 3e56a16b14 Update readme
2022-10-28 11:47:58 +01:00
.github More fixes 2022-10-26 10:41:15 +01:00
public Maybe finally fix public env vars 2022-10-26 17:13:30 +01:00
src Fix my dumb brains spelling 2022-10-27 20:19:34 +01: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 Add .env to .gitignore 2022-10-26 17:16:41 +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 ples use cache thank 2022-10-26 22:03:03 +01: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 Fix song art not loading 2022-10-27 18:59:28 +01:00
package.json Merge pull request #24 from RealFascinated/dependabot/npm_and_yarn/types/react-18.0.24 2022-10-28 10:37:10 +01:00
README.md Update readme 2022-10-28 11:47:58 +01:00
tsconfig.json TypeScript woop 2022-10-22 12:28:24 +01:00
yarn.lock Merge pull request #24 from RealFascinated/dependabot/npm_and_yarn/types/react-18.0.24 2022-10-28 10:37:10 +01:00

README.md

BeatSaber Overlay with real-time data from HttpSiraStatus

Build Status

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

  • Make BeatLeader pp count check for modifiers
  • Add toggle for showing pp
  • Change the song time to a circular style in the song art

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