42 lines
982 B
Markdown
42 lines
982 B
Markdown
# BeatSaber Overlay with real-time data from HttpSiraStatus
|
|
|
|
The public url to view/use: <https://bs-overlay.fascinated.cc></br>
|
|
Need help? Feel free to message me at: Fascinated#4719
|
|
|
|
## Usage
|
|
|
|
You will need [HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus) if you wish to use the note cut and/or the song info</br>
|
|
To get started go to <https://bs-overlay.fascinated.cc> and it is fairly self explanatory on how it all works</br>
|
|
|
|
## Preview
|
|
|
|
|
|
|
|
|
|
## Todo
|
|
|
|
- Cache BeatSaver data
|
|
- Add toggle for showing pp
|
|
- Cleanup the API (or just re-do it)
|
|
- Change the song time to a circular style in the song art
|
|
|
|
## Getting Started with developent
|
|
|
|
First, install the node dependencies:
|
|
|
|
```bash
|
|
npm i
|
|
# or
|
|
yarn
|
|
```
|
|
|
|
Secondly, open the development server
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
yarn dev
|
|
```
|
|
|
|
Lastly, open the project with an IDE of your choice :)
|