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.
beatsaber-overlay/README.md

43 lines
1.3 KiB
Markdown
Raw Normal View History

2022-10-19 17:30:19 +00:00
# BeatSaber Overlay with real-time data from HttpSiraStatus
2022-10-26 14:19:34 +00:00
[![Build Status](https://drone.fascinated.cc/api/badges/RealFascinated/beatsaber-overlay/status.svg)](https://drone.fascinated.cc/RealFascinated/beatsaber-overlay)
2022-02-14 17:43:52 +00:00
2022-10-20 14:59:03 +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-03 07:46:11 +00:00
You will need [HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus) if you wish to use the note cut and/or the song info</br>
2022-10-20 17:56:03 +00:00
To get started go to <https://bs-overlay.fascinated.cc> and fill the forum in then go to OBS (or your streaming software) and click Open Overlay</br>
Then create a browser window and set the height to 1920 and the width to 1080 then put the URL in the browser window and bam! it should all work
2022-10-20 14:59:03 +00:00
## Preview
2022-10-03 07:46:11 +00:00
2022-10-20 17:50:26 +00:00
![Overlay](https://cdn.fascinated.cc/bAmrOfUvLv.png?raw=true)
2022-10-19 14:59:32 +00:00
![Builder Menu](https://cdn.fascinated.cc/QwGTQLhJsq.png?raw=true)
2022-10-10 19:11:50 +00:00
2022-10-20 14:59:03 +00:00
## Todo
2022-10-21 15:49:43 +00:00
- Make BeatLeader pp count check for modifiers
2022-10-20 14:59:03 +00:00
- Add toggle for showing pp
- Change the song time to a circular style in the song art
2022-02-14 18:52:28 +00:00
## Getting Started with developent
2022-02-14 17:43:52 +00:00
2022-02-14 18:55:05 +00:00
First, install the node dependencies:
```bash
npm i
# or
yarn
```
Secondly, open the development server
2022-02-14 17:43:52 +00:00
```bash
npm run dev
# or
yarn dev
2022-10-20 14:59:03 +00:00
```
2022-02-14 17:43:52 +00:00
2022-04-02 05:39:34 +00:00
Lastly, open the project with an IDE of your choice :)