Fascinated/beatsaber-overlay
Fascinated/beatsaber-overlay
Archived
1
1
Fork 0
Code Issues 1 Pull Requests 2 Actions Packages Wiki Activity

Update readme

Browse Source
This commit is contained in:
Liam 2022-10-28 11:47:58 +01:00
parent fe45b3f0fe
commit 3e56a16b14
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,9 +7,13 @@ Need help? Feel free to message me at: Fascinated#4719
## Usage ## Usage
You will need [HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus) if you wish to use the note cut and/or the song info</br> - Install [HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus)
To get started go to <https://bs-overlay.fascinated.cc> and fill the forum in then go to OBS (or your streaming software) and click Open Overlay</br> - Go to <https://bs-overlay.fascinated.cc>
Then create a browser window and set the height to 1920 and the width to 1080 then put the URL in the browser window and bam! it should all work - Set the values in the configuratator
- Click on Open Overlay
- Create a browser window in your streaming software of choice
- Set the height to 1920 and width to 1080
- Set the URL to the newly opened window in your browser
## Preview ## Preview
@ -24,7 +28,7 @@ Then create a browser window and set the height to 1920 and the width to 1080 th
## Getting started with developent ## Getting started with developent
- Clone repo - Clone the repo
- Move into the cloned directory - Move into the cloned directory
- Run `npm install` - Run `npm install`
- Rename the `.env-example` to `.env` - Rename the `.env-example` to `.env`