search

HyldraZolxy / BeatSaber-Overlay

Beat Saber overlay for BSPlus, HTTPStatus, HTTPSiraStatus and DataPuller
https://overlay.hyldrazolxy.fr
31 stars 4 forks source link
beatsaber obs obs-studio overlay twitch

readme

BeatSaber-Overlay

liveDemo

Report Bug - Request Feature - Support me on Ko-fi! <3

Table of Contents
  1. What is this?
  2. Getting Started
  3. Options
  4. Contact
  5. Credit


Work with: - **[BeatSaberPlus](https://github.com/hardcpp/BeatSaberPlus)**: BS ver (1.21.0 & 1.22.0 & 1.22.1 & 1.23.0 & 1.24.0) - **[HTTPStatus](https://github.com/opl-/beatsaber-http-status/)**: BS ver (1.17.0 & 1.18.0 & 1.19.0 & 1.20.0) - **[HTTPSiraStatus](https://github.com/opl-/beatsaber-http-status/)**: BS ver (1.21.0 & 1.22.0 & 1.22.1 & 1.23.0 & 1.24.0) - **[DataPuller](https://github.com/opl-/beatsaber-http-status/)**: BS ver (1.20.0 & more ?)
3 skins: - **Default**: Default style - **Freemium**: Premium design - **Reselim**: Reselim skin

What is this?

This is an overlay that can be used with a plugin (mod) for BeatSaber.
It takes the data produced by the plugin(s) in order to display them, so you can display them on a record or a stream

Getting Started

To use the Overlay, it is necessary to follow the instructions below to ensure that it will work properly

Prerequisites

  1. You will need to download one of the four plugins that will be used to connect the overlay to your game

Don't forget to install the dependencies of the plugin !

  1. You will need a Stream software

Installation

  1. Install your stream software, I'm not going to show you how, you're a big boy ;3

  2. Put the previously downloaded plugin in your Beat Saber folder Beat Saber\Plugins\

    Beat Saber\Plugins\BeatSaberPlus.dll
Or
Beat Saber\Plugins\BeatSaberHTTPStatus.dll
Or
Saber\Plugins\HttpSiraStatus.dll
Or
Beat Saber\Plugins\DataPuller.dll

  3. Open your web browser and write

    https://overlay.hyldrazolxy.fr/

  4. Click on settings icon to display the setup panel

  5. After setting up your overlay, copy the URL with a click on the link button

Setting button Link button

(back to top)

Options

General Settings

IP
If you want to use a second pc to stream, you can write it's ip address to make the overlay connect to your game. If not, leave it blank

Player Card Settings

(Obviously, if you don't add the Score Saber link in, it won't work)

ScoreSaber link
If you want to use the player card, you have to give your ScoreSaber ID or the link of your ScoreSaber profile

Position
This is to change the position of the player card

Scale
This is to change the scale of the player card

Song Card Settings

Skin
This is to change the skin of the song card

Position
This is to change the position of the song card

Scale
This is to change the scale of the song card

(back to top)

Contact

You can contact me on Discord Hyldra Zolxy#1910 to ask for various changes, improvements or even special requests! I'm always open to new ideas and suggestions ;)

Credit

Thanks to:

Thanks all and cya <3

If you like the overlay, you can support me on Ko-fi! I really appreciate it :3

(back to top)