https://github.com/thexorog/beatrecorder

Easily record your BeatSaber gameplay!
https://github.com/thexorog/beatrecorder

beatsaber obs obs-studio

Last synced: 5 months ago
JSON representation

Easily record your BeatSaber gameplay!

• Host: GitHub
• URL: https://github.com/thexorog/beatrecorder
• Owner: TheXorog
• License: gpl-3.0
• Created: 2021-06-30T20:39:20.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-07T14:32:52.000Z (about 1 year ago)
• Last Synced: 2024-03-08T15:04:17.974Z (about 1 year ago)
• Topics: beatsaber, obs, obs-studio
• Language: C#
• Homepage:
• Size: 993 KB
• Stars: 23
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
BeatRecorder




Easily record your BeatSaber gameplay!



## What is BeatRecorder?

This application is for people who record their BeatSaber gameplay using OBS. It connects to **[HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus)** (**[beatsaber-http-status](https://github.com/opl-/beatsaber-http-status/)** for older Beat Saber versions), **[BSDataPuller](https://github.com/kOFReadie/BSDataPuller)** or **[BeatSaberPlus](https://github.com/hardcpp/BeatSaberPlus)** to detect the current game-state and **[obs-websocket](https://github.com/obsproject/obs-websocket/releases/)** to automatically start and stop the recording.

Files are saved where-ever you set your output folder to in OBS.

**If you have encountered any bugs or issues with this application, feel free to create an issue with your problem.**

**If you want to get it fixed faster or it's something urgent, you can join [my Discord](https://discord.gg/xaq23p7Jzf) and hit me (`Mira#2000`) with a ping.**

## Requirements

* **[HttpSiraStatus](https://github.com/denpadokei/HttpSiraStatus)** (**[HttpStatus](https://github.com/opl-/beatsaber-http-status/)** for older BS versions), **[BSDataPuller](https://github.com/kOFReadie/BSDataPuller)** or **[BeatSaberPlus (experimental)](https://github.com/hardcpp/BeatSaberPlus)**

    - **BeatSaberPlus support is incomplete as it does not provide a way of knowing if a song was failed or finished.**




* **[obs-websocket v5.0+ or v4.9.1](https://github.com/obsproject/obs-websocket/releases/)**

## How to set up

1. Install all the previously mentioned dependencies.

2. Download and unzip this application.

3. Run it once, it'll ask you to input your settings. Do so.

    - If running on linux, you do not have access to the GUI.

    - You can find documentation on the config file here: [BeatRecorder Config Documentation](./CONFIG.md)

4. Profit

## BeatRecorder not connecting?

**AVG Antivirus is known to cause all kinds of issues** with connection-related things. (Credit to `Arro#6969`. They discoverd and reported this issue.)

If you have AVG Antivirus installed, please uninstall it and find a better antivirus solution.

If you ruled out your antivirus (through uninstalling it or deactivating it's protection), just create an issue or join my Discord like mentioned before.

## Contributing or forking

Before building, you'll need [Xorog.Logger](https://github.com/Fortunevale/Xorog.Logger) and [Xorog.UniversalExtensions](https://github.com/Fortunevale/Xorog.UniversalExtensions).

From there on, it should be as easy as cloning the repository and running `dotnet restore`.