Skip to content

Commit b0bc3f5

Browse files
committed
Update README.md
1 parent 3155ec5 commit b0bc3f5

10 files changed

+23
-34
lines changed

Diff for: README.md

+23-34
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,32 @@
11
# BSDP-Overlay
2-
A BeatSaber overlay I have created for my [DataPuller](https://github.com/kOFReadie/DataPuller/releases) mod.
3-
This overlay is easy to use, just add the [Overlay](http://u-readie.global-gaming.co/bsdp-overlay/) to your recording/streaming software of choice as a browser source. (Make sure you have the [DataPuller](https://github.com/kOFReadie/DataPuller/releases) mod installed).
2+
**Please Note:** that this tool is still in early acces and it is highly likley that there are many bugs that exist, the tool is not complete yet and there should be much more to come in the future.
43

5-
## Preview:
6-
<img src="./previews/overlay.png" width="720">
4+
## What is this?
5+
BSDP Overlay is an overlay that can be used with the DataPuller mod for BeatSaber.
6+
It takes the data outputted by the game and displays it for you, the user to overlay on your recordings/streams.
77

8-
## Options:
9-
Here is an example of how to use these parameters in the URL: `.../bsdp-overlay/default/?debug&flipHori&hideModifiersHealth&overlayForeground=255,120,0&ip=192.168.1.197&scale=0.9`
10-
The first parameter must start with a queston mark `?` and every other parameter after that must start with an and symbol `&`. It dosen't matter which order you put them in.
8+
## Why is this special?
9+
There are other overlays out there, so what makes this one special?
10+
Well aside from the default overlay that has been out since May 25, 2020, this webapp allows you to create your own overlays without needing to know how to code!
1111

12-
### IP:
13-
- `ip=*`: Use this parameter if you have the mod setup to send the data over a different IP (Currently for LAN use only)
12+
## What's to come:
13+
This webapp is still very new and there should be a lot of changes to come in the future, some things inclue:
14+
- Block like scripting for events in the game
15+
- Custom CSS
16+
- New elements
17+
- And much more!
1418

15-
### UI Scale:
16-
- `scale=*`: Changes the scale of the UI, the site was designed for 1080p.
19+
## Here are some examples of the webapp in action:
20+
### Editor:
21+
<img src="./previews/Editor.gif" width="480">
1722

18-
### Colours:
19-
`overlayForeground=R,G,B`: Changes the colour of the foreground elements such as text.
20-
`overlayBackground=R,G,B`: Changes the colour of the background elements.
21-
`overlayAlt=R,G,B`: Changes the colour of the third colour used for the background of the health and disabled modifiers.
23+
### View:
24+
<img src="./previews/View.gif" width="480">
2225

23-
### Element Visibility:
24-
Changes the visibility of the three main elements on the overlay.
25-
- `hideStats`: Hides the map stats.
26-
<img src="./previews/stats.png" width="480">
27-
- `hideMapDetails`: Hides the map details.
28-
<img src="./previews/mapDetails.png" width="480">
29-
- `hideModifiersHealth`: Hides the modifiers and health.
30-
<img src="./previews/modifiersAndHealth.png" height="256">
26+
### Private/public visibility:
27+
<img src="./previews/PublicPrivate.gif" width="480">
3128

32-
### Element Position:
33-
- `flipHori`: Moves the song information to the right and the modifiers/health to the left.
34-
- `flipVerti`: Places the map information at the top.
29+
### Game preview:
30+
<img src="./previews/GamePreview.gif" width="480">
3531

36-
### Hide when inactive:
37-
- `hideInactive`: Hides the UI when BeatSaber is closed.
38-
39-
### An example of mixed URL parameters:
40-
<img src="./previews/scale=1.1&flipHori&FlipVert&hideModifiersHealth.png" width="512">
41-
42-
## Upcoming changes:
43-
I plan to create an overlay editor, similar to WIX where you can drag and drop elements onto the page, you will be able to customise the fonts and designs etc, at first it may be a little janky but I hope to work on it an improve it a lot over time.
32+
I'm always open to new ideas and sugguestions, so if you feel like something could be added or improved feel free to drop me a message on Github or Discord.

Diff for: previews/Editor.gif

5.89 MB
Loading

Diff for: previews/GamePreview.gif

14.3 MB
Loading

Diff for: previews/PublicPrivate.gif

4.06 MB
Loading

Diff for: previews/View.gif

1.7 MB
Loading

Diff for: previews/mapDetails.png

-432 KB
Binary file not shown.

Diff for: previews/modifiersAndHealth.png

-91.1 KB
Binary file not shown.

Diff for: previews/overlay.png

-893 KB
Binary file not shown.
-57 KB
Binary file not shown.

Diff for: previews/stats.png

-68.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)