Skip to content

Latest commit

 

History

History
50 lines (49 loc) · 3.41 KB

CONFIG.md

File metadata and controls

50 lines (49 loc) · 3.41 KB

BeatRecorder Config Documentation

  • ConsoleLogLevel - This will determines what log level is displayed inside the console.
  • Mod - Controls what mod you want to use to connect to Beat Saber.
    • Valid options are: http-status, datapuller, beatsaberplus
  • DisplayUI - Whether to display the Graphical User Interface. Windows only.
  • DisplayUITopmost - Whether to display the Graphical User Interface always on top. Windows only.
  • HideConsole - Whether to hide the console entirely upon launching the GUI.
  • AutomaticRecording - Whether to atuomatically record.
  • DisplaySteamNotifications - Whether to show Steam Notifications through OpenVR. Windows only.
  • BeatSaberUrl - The ip address of the host that runs Beat Saber.
  • BeatSaberPort - The port of the host that runs Beat Saber.
    • http-status: 6557
    • datapuller: 2946
    • beatsaberplus: 2947
  • BeatSaberUseLegacyIfAvailable - Whether to use a legacy handler of the selected mod, if supported.
    • Currently supports: datapuller.
  • OBSUrl - The ip adress of the host that runs OBS.
    • Note: If OBS runs on a different device, renaming or deleting files will fail.
  • OBSPort - The port of the host that runs OBS.
  • OBSPassword - The password of the OBS websocket.
  • MininumWaitUntilRecordingCanStart - How long BeatRecorder should wait to start another recording.
  • AskToSaveOBSPassword - Whether to ask if you want to save your password, if filled in interactively via the console.
  • PauseRecordingOnIngamePause - Whether to pause the recording when the current song has been paused.
  • FileFormat - What recorded files should be named.
    • <difficulty> - The difficulty.
    • <short-difficulty> - The short version of the difficulty.
    • <song-name> - The song name.
    • <song-sub-name> - The song sub name.
    • <song-name-with-sub> - Automatically combines the song name and sub name with a space.
    • <song-author> - The song author.
    • <mapper> - The mapper.
    • <levelid> - The level id or hash, depending on the mod used.
    • <bpm> - The beats per minute of the song.
    • <rank> - The rank you achieved.
    • <accuracy> - The accuracy you achieved.
    • <misses> - How often you missed.
    • <max-combo> - The largest combo you had.
    • <score> - The score you achieved.
    • <raw-score> - The score you achieved, without applying modifiers.
  • StopRecordingDelay - How long, in seconds, to wait before ending the recording.
  • DeleteIfShorterThan - How long, in seconds, a recording has to be so BeatRecorder will not delete it.
  • DeleteQuit - Whether to delete songs that have not been finished.
  • DeleteIfQuitAfterSoftFailed - Whether to delete songs that have not been finished after failing with No-Fail on.
  • DeleteFailed - Whether to delete songs that have been failed.
  • DeleteSoftFailed - Whether to delete songs that have been completed but failed with No-Fail on.
  • OBSMenuScene - The obs scene to automatically switch to upon entering the main menu.
  • OBSIngameScene - The obs scene to automatically switch to upon entering a song.
  • OBSPauseScene - The obs scene to automatically switch to upon pausing a song.
    • If you use OBSPauseScene, i recommend specifying OBSIngameScene. Otherwise, BeatRecorder will not switch back to the previous scene.