https://github.com/opl-/beatsaber-http-status

Live game status over web sockets.
https://github.com/opl-/beatsaber-http-status

hacktoberfest

Last synced: about 2 months ago
JSON representation

Live game status over web sockets.

• Host: GitHub
• URL: https://github.com/opl-/beatsaber-http-status
• Owner: opl-
• License: mit
• Created: 2018-08-16T16:35:26.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-17T21:57:45.000Z (almost 3 years ago)
• Last Synced: 2023-11-07T17:00:46.494Z (about 1 year ago)
• Topics: hacktoberfest
• Language: C#
• Homepage:
• Size: 326 KB
• Stars: 106
• Watchers: 12
• Forks: 35
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Beat Saber HTTP Status

This plugin exposes information about the current game status, live over a WebSocket and over HTTP. It can be used to build [custom stream overlays](https://github.com/opl-/beatsaber-http-status/wiki/Software-using-this-plugin#overlays) or track player performance by third party programs.

## Installation

### Recommended (using a mod manager)

You can install Beat Saber HTTP Status by using [one of the mod installers listed here](https://bsmg.wiki/pc-modding.html). Follow the steps required to run the program of your choice, then in the mods section find "HTTP Status" and install it. This will automatically install and keep everything you need up to date.

Next you will need to [get additional software](https://github.com/opl-/beatsaber-http-status/wiki/Software-using-this-plugin) that uses this plugin. **This plugin does nothing useful on its own; it simply exposes information for other programs to use.**

### Manual

1. Install [BSIPA](https://bsmg.github.io/BeatSaber-IPA-Reloaded/) [(BSMG guide)](https://bsmg.wiki/pc-modding.html#manual-installation).

2. Download the latest release from the [releases page](https://github.com/opl-/beatsaber-http-status/releases).

3. Extract the zip into your Beat Saber directory.

4. Download and extract the following plugins and their dependencies:

	- BS Utils from [BeatMods](https://beatmods.com/#/mods)

	- websocket-sharp from [BeatMods](https://beatmods.com/#/mods)

5. [Get additional software](https://github.com/opl-/beatsaber-http-status/wiki/Software-using-this-plugin) that makes use of this plugin. This mod does nothing on its own; it simply exposes information for other programs to use.

## Developers

### Using HTTP Status

Protocol documentation can be found in [protocol.md](protocol.md).

### Contributing to HTTP Status

Before opening a pull request, please read the [contributing guide](CONTRIBUTING.md).

To build this project you will need to create a `BeatSaberHTTPStatus/BeatSaberHTTPStatusPlugin.csproj.user` file specifying where the game is located on your disk:

```xml

  

    

    C:\Program Files\Steam\steamapps\common\Beat Saber\

  

```

Alternatively you can provide the game DLLs in the `libs/beatsaber` directory using the standard Beat Saber directory structure. For a full list see the [project file](BeatSaberHTTPStatus/BeatSaberHTTPStatusPlugin.csproj).

The following properties can be specified either in the `.csproj.user` file or through the command line (`/p:=`):

- `GameDirPath`: Path ending with a backslash pointing to the Beat Saber directory. Used to locate required game DLLs.

- `OutputZip` = `true`/`false`: Enable/disable generating the .zip file. Can be used to get a zip for the `Debug` configuration.

- `CopyToPlugins` = `true`/`false`: Enable/disable copying of HTTP Status DLLs to the Beat Saber installation. Depends on `GameDirPath`.

## Credits

**xyonico** for the [Beat Saber Discord Presence](https://github.com/xyonico/BeatSaberDiscordPresence) plugin, on which this plugin was initially based.

**sta** for the [websocket-sharp](https://github.com/sta/websocket-sharp) library.

**Maxaxik** for testing and helping with research.