beatsaber-overlay/README.md

# 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

![Overlay](https://cdn.fascinated.cc/HCrnvhsHGG.png?raw=true)
![Builder Menu](https://cdn.fascinated.cc/QwGTQLhJsq.png?raw=true)

## 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 :)
Update README.md 2022-10-19 17:30:19 +00:00			`# BeatSaber Overlay with real-time data from HttpSiraStatus`
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
Add todo and remove mockdata 2022-10-20 14:59:03 +00:00			`The public url to view/use: <https://bs-overlay.fascinated.cc></br>`
Update README.md 2022-10-03 07:43:16 +00:00			`Need help? Feel free to message me at: Fascinated#4719`
Update README.md 2022-02-14 18:53:59 +00:00
Update README.md 2022-10-03 07:46:11 +00:00			`## Usage`
Add todo and remove mockdata 2022-10-20 14:59:03 +00:00
Update README.md 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>`
Add todo and remove mockdata 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`
Update README.md 2022-10-03 07:46:11 +00:00
Update README.md 2022-10-17 14:15:16 +00:00			`![Overlay](https://cdn.fascinated.cc/HCrnvhsHGG.png?raw=true)`
Update README.md 2022-10-19 14:59:32 +00:00			`![Builder Menu](https://cdn.fascinated.cc/QwGTQLhJsq.png?raw=true)`
Update README.md 2022-10-10 19:11:50 +00:00
Add todo and remove mockdata 2022-10-20 14:59:03 +00:00			`## 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`

Update README.md 2022-02-14 18:52:28 +00:00			`## Getting Started with developent`
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
Update README.md 2022-02-14 18:55:05 +00:00			`First, install the node dependencies:`

			```bash
			`npm i`
			`# or`
			`yarn`
			```

			`Secondly, open the development server`
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
			```bash
			`npm run dev`
			`# or`
			`yarn dev`
Add todo and remove mockdata 2022-10-20 14:59:03 +00:00			```
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
Update README.md 2022-04-02 05:39:34 +00:00			`Lastly, open the project with an IDE of your choice :)`