https://github.com/realfascinated/beatsaber-overlay

BeatSaber Overlay with real-time data from HttpSiraStatus. Can also show stats from ScoreSaber and BeatLeader!
https://github.com/realfascinated/beatsaber-overlay

beatleader beatsaber beatsaber-overlay httpsirastatus overlay scoresaber

Last synced: about 2 months ago
JSON representation

BeatSaber Overlay with real-time data from HttpSiraStatus. Can also show stats from ScoreSaber and BeatLeader!

• Host: GitHub
• URL: https://github.com/realfascinated/beatsaber-overlay
• Owner: RealFascinated
• License: mit
• Created: 2022-02-14T18:50:46.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-06T12:02:03.000Z (about 1 year ago)
• Last Synced: 2023-11-06T17:25:59.213Z (about 1 year ago)
• Topics: beatleader, beatsaber, beatsaber-overlay, httpsirastatus, overlay, scoresaber
• Language: JavaScript
• Homepage:
• Size: 3.33 MB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# BeatSaber Overlay with real-time data from HttpSiraStatus

The project is on my [Gitea](https://git.fascinated.cc/Fascinated/beatsaber-overlay) now, but the repo will be kept in sync on GitHub. 


The public url to view/use:  


Need help? Feel free to message me on Discord: Fascinated#7668 or Matrix: @fascinated:matrix.fascinated.cc

## Usage

Go to the [Wiki](https://git.fascinated.cc/Fascinated/beatsaber-overlay/wiki/Usage)

## Preview

![Overlay](./assets/overlay.png)

![Builder Menu](./assets/builder.png)

## 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 

If you want your changes to be in the main branch, feel free to open a pull request :)