2022-10-19 17:30:19 +00:00
|
|
|
# BeatSaber Overlay with real-time data from HttpSiraStatus
|
2022-10-28 10:39:31 +00:00
|
|
|
|
2023-01-13 18:01:19 +00:00
|
|
|
The public url to view/use: <https://bs-overlay.fascinated.cc><br />
|
2022-10-03 07:43:16 +00:00
|
|
|
Need help? Feel free to message me at: Fascinated#4719
|
2022-02-14 18:53:59 +00:00
|
|
|
|
2022-10-03 07:46:11 +00:00
|
|
|
## Usage
|
2022-10-20 14:59:03 +00:00
|
|
|
|
2022-10-28 10:47:58 +00:00
|
|
|
- Install [HttpSiraStatus](https://github.com/denpadokei/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
|
2022-10-20 14:59:03 +00:00
|
|
|
|
|
|
|
|
## Preview
|
2022-10-03 07:46:11 +00:00
|
|
|
|
2023-01-07 14:43:09 +00:00
|
|
|
|
|
|
|
|
|
2022-10-10 19:11:50 +00:00
|
|
|
|
2022-10-20 14:59:03 +00:00
|
|
|
## Todo
|
|
|
|
|
|
|
|
|
|
- Add toggle for showing pp
|
|
|
|
|
- Change the song time to a circular style in the song art
|
2023-01-06 22:26:46 +00:00
|
|
|
- Add overall stream stats (avg acc, misses, highest combo)
|
2023-01-08 13:46:54 +00:00
|
|
|
- Add option to scale the ui using css scale
|
2022-10-20 14:59:03 +00:00
|
|
|
|
2022-10-28 10:39:31 +00:00
|
|
|
## Getting started with developent
|
2022-02-14 17:43:52 +00:00
|
|
|
|
2022-10-28 10:47:58 +00:00
|
|
|
- Clone the repo
|
2022-10-28 10:39:31 +00:00
|
|
|
- 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>
|
2022-02-14 17:43:52 +00:00
|
|
|
|
2022-10-28 10:39:31 +00:00
|
|
|
If you want your changes to be in the main branch, feel free to open a pull request :)
|
