beatsaber-overlay/README.md

# BeatSaber Overlay with real-time data from HttpSiraStatus

The project is on my [Gitea](https://git.fascinated.cc/Fascinated/beatsaber-overlay) now, but the repo will be kept in sync on GitHub. <br />
The public url to view/use: <https://bs-overlay.fascinated.cc> <br />
Need help? Feel free to message me on Discord: Fascinated#7668 or Matrix: @fascinated:matrix.fascinated.cc

## Usage

Go to the [Wiki](https://git.fascinated.cc/Fascinated/beatsaber-overlay/wiki/Usage)

## Preview

![Overlay](./assets/overlay.png)
![Builder Menu](./assets/builder.png)

## Getting started with developent

- Clone the repo
- Move into the cloned directory
- Run `npm install`
- Rename the `.env-example` to `.env`
- Create a redis server with a password
- Setup the `.env`
- Run `npm run dev`
- Open <http://localhost:3000>

If you want your changes to be in the main branch, feel free to open a pull request :)
Update README.md 2022-10-19 17:30:19 +00:00			`# BeatSaber Overlay with real-time data from HttpSiraStatus`
Update readme 2022-10-28 10:39:31 +00:00
Update 'README.md' 2023-03-27 15:13:42 +00:00			`The project is on my [Gitea](https://git.fascinated.cc/Fascinated/beatsaber-overlay) now, but the repo will be kept in sync on GitHub. <br />`
i can merge, totally 2023-01-13 18:13:43 +00:00			`The public url to view/use: <https://bs-overlay.fascinated.cc> <br />`
Update 'README.md' 2023-03-27 16:58:55 +00:00			`Need help? Feel free to message me on Discord: Fascinated#7668 or Matrix: @fascinated:matrix.fascinated.cc`
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
readme 2023-03-26 02:44:17 +00:00			`Go to the [Wiki](https://git.fascinated.cc/Fascinated/beatsaber-overlay/wiki/Usage)`
Add todo and remove mockdata 2022-10-20 14:59:03 +00:00
			`## Preview`
Update README.md 2022-10-03 07:46:11 +00:00
stop next from complaining 2023-01-14 14:23:28 +00:00			`![Overlay](./assets/overlay.png)`
			`![Builder Menu](./assets/builder.png)`
Update README.md 2022-10-10 19:11:50 +00:00
Update readme 2022-10-28 10:39:31 +00:00			`## Getting started with developent`
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
Update readme 2022-10-28 10:47:58 +00:00			`- Clone the repo`
Update readme 2022-10-28 10:39:31 +00:00			`- Move into the cloned directory`
			- Run `npm install`
			- Rename the `.env-example` to `.env`
			`- Create a redis server with a password`
			- Setup the `.env`
			- Run `npm run dev`
			`- Open <http://localhost:3000>`
Initial commit from Create Next App 2022-02-14 17:43:52 +00:00
update readme 2023-03-26 16:52:47 +00:00			`If you want your changes to be in the main branch, feel free to open a pull request :)`