/beat-saber-overlay

Primary LanguageJavaScriptMIT LicenseMIT

(Unnamed) Beat Saber Overlay

A web-based overlay for Beat Saber

preview

Installation (OBS)

  1. Download and install the BeatSaberHTTPStatus plugin
  2. Create a Browser source

image

  1. Set the URL as https://japboy.github.io/beat-saber-overlay/ and the size equal to your canvas size (1280x720, etc.)

image

  1. (Optional) For 1080p canvases, add the scale modifier (ex. https://japboy.github.io/beat-saber-overlay/?modifiers=scale) to scale the overlay by 1.5x

Options

Options are added to the URL query as such:

https://japboy.github.io/beat-saber-overlay/?modifiers=top

ip and port

Listen to events from another IP and/or port.

modifiers

Multiple modifiers can be seperated with commas.

  • top
    • Moves the overlay to the top and reverses the layout vertically
  • rtl
    • Moves the overlay to the right and uses right-to-left text
  • scale
    • Scales the overlay by 1.5x, for use on 1080p canvases
  • scale4k
    • Scales the overlay by 3.0x, for use on 4K canvases
  • noperf
    • Hide the performance overlay
  • test
    • Makes the background black, for testing purposes