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
2022-10-19 15:59:32 +01:00

33 lines
802 B
Markdown

# ScoreSaber Overlay with real-time data
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:
![Overlay](https://cdn.fascinated.cc/HCrnvhsHGG.png?raw=true)
![Builder Menu](https://cdn.fascinated.cc/QwGTQLhJsq.png?raw=true)
## 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 :)