2022-10-19 17:30:19 +00:00
|
|
|
# BeatSaber Overlay with real-time data from HttpSiraStatus
|
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 14:59:03 +00:00
|
|
|
To get started go to <https://bs-overlay.fascinated.cc> and it is fairly self explanatory on how it all works</br>
|
|
|
|
|
|
|
|
|
|
## Preview
|
2022-10-03 07:46:11 +00:00
|
|
|
|
2022-10-17 14:15:16 +00:00
|
|
|
|
2022-10-19 14:59:32 +00:00
|
|
|
|
2022-10-10 19:11:50 +00:00
|
|
|
|
2022-10-20 14:59:03 +00:00
|
|
|
## Todo
|
|
|
|
|
|
|
|
|
|
- Move caches to Redis
|
|
|
|
|
- Move media to my CDN server
|
|
|
|
|
- Cache BeatSaver data
|
|
|
|
|
- Add cache status in the response headers
|
|
|
|
|
- Move configuration files to ENV files
|
|
|
|
|
- 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
|
|
|
|
|
|
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 :)
|
