About

- This is an early version with bare minimum UI in-game! 
- All config changes are done by manually editing config files
- If you are new to modding, consider using Camera2 mod instead

ReeCamera is a Beat Saber camera mod for video recording and streaming, featuring:

• Separate presets for Menu/Gameplay scenes in VR/FPFC
• Masks and true transparency for overlay cameras, such as Back/Side swing view cameras
• Support for Spout2 output with multiple sources (Plugin for OBS)
  • allows to completely bypass screen capture
  • allows to record 4k/8k (or any other resolution) videos without a 4k/8k display

Built-in presets

If you installed the mod properly, you can find these presets in the UserData/ReeCamera/Presets/

1. Nothing (0 Cameras).json - Disables all desktop rendering. Since you won't be able to navigate the menu, don't use this preset in FPFC. Use case - saving performance in solo VR sessions (no video recording/streaming)
2. Simple (1 Camera).json - Single smooth follow camera
3. Video (3 Cameras).json - Smooth follow camera + back and side orthographic "swing view" cameras
4. test.json - Test preset for development. Included as features demo (screenshot above)

How To Use

1. Download the latest mod .zip from the releases page
2. Extract the .zip into your game directory
3. To create main config file, launch and close the game at least once
4. Go to UserData folder and edit your config

Main Config File /UserData/ReeCamera.json

Change only when the game is closed, mod will override otherwise

{
  "MainMenuConfigVR": {
    "PresetId": "Simple (1 Camera).json" // Can be selected in-game
  },
  "GameplayConfigVR": {
    "PresetId": "Video (3 Cameras).json"
  },
  "MainMenuConfigFPFC": {
    "FramerateSettings": { // Framerate settings for navigating main menu in FPFC
      "VSync": true, // Forces the game to run at your display refresh rate
      "TargetFramerate": 0 // 0 = no fps cap. >0 = fps cap. Does nothing if VSync is on
    },
    "PresetId": ""
  },
  "GameplayConfigFPFC": {
    "FramerateSettings": { // Framerate settings for watching/recording replays in FPFC
      "VSync": false, // Don't use vsync for video recording, unless your native display refresh rate matches your video framerate
      "TargetFramerate": 60 // Should match your recording settings
    },
    "PresetId": "Video (3 Cameras).json"
  }
}

Scene preset UserData/ReeCamera/Presets/<filename>.json

• See built-in presets for more examples
• To refresh press Shift+Ctrl+F1 or click the Reload button

{
  "FormatVersion": 1,
  "ModVersion": "0.0.1",
  "Layouts": [ // List of layouts
    { /* Layout config 1 */ },
    { /* Layout config 2 */ },
    { /* ... */ }
  ] // Note: if you don't use any layouts (like 'Nothing' preset) screen buffer will stop updating and will become stuck at the last rendered frame in FPFC or will mirror HMD display in VR
}

Layout config:

{
  "IsVisible": true, // Only affects on-screen visibility, doesn't disable cameras and spout output.
  "ScreenRect": { // Position on the screen
    "x": 0.0,
    "y": 0.0,
    "width": 0.5,
    "height": 1.0
  },
  "MainCamera": {
    "SpoutSettings": { // Spout2 lib. Allows to render the game at any resolution directly to a supported app without screen capture. Plugin for OBS: github.com/Off-World-Live/obs-spout2-plugin
      "Enabled": false, // Usecase example: Recording 4k/8k videos without 4k/8k display. Note: screen overlays (like replay controls) are not captured with this method
      "Width": 7680,
      "Height": 4320,
      "ChannelName": "ReeCamera"
    },
    ... // Shared settings
  },
  "SecondaryCameras": [ // Up to 4 cams
    {
      "CompositionSettings": {
        "ScreenRect": { // Position relative to the main
          "x": -0.02,
          "y": -0.02,
          "width": 0.3,
          "height": 0.4
        },
        "MaskTextureId": "SmoothFadeMask.png", // Name of the mask texture file from /UserData/ReeCamera/CustomTextures/
        "Transparent": true, // Use 'true' to make camera background transparent. Make sure to exclude 'Skybox' layer (29) for such cameras 
        "BackgroundColor": {
          "r": 0.8,
          "g": 0.8,
          "b": 0.8,
          "a": 1.0
        },
        "BackgroundBlurLevel": 2, // Background blur amount. Only values from 0 to 5. Very GPU heavy (except 0 ofc)
        "BackgroundBlurScale": 2.0 // Blur radius multiplier
      },
      ... // Shared settings
    }
  ]
}

Shared camera settings

Used for both Main and Secondary cameras

{
  "Name": "Bottom Left Camera (Back ortho view)",
  "QualitySettings": {
    "AntiAliasing": 1,
    "RenderScale": 1.0
  },
  "CameraSettings": { // Should be self explanatory
    "IgnoreCameraUtils": false,
    "FieldOfView": 60.0,
    "NearClipPlane": 0.3,
    "FarClipPlane": 100.0,
    "Orthographic": true,
    "OrthographicSize": 1.6,
    "CenterOffset": { // View center offset, use values from -1 to 1
      "x": 0.0,
      "y": 0.0
    }
  },
  "MovementConfig": {
    "MovementType": 0, // 0 = static position, 1 = following player's head
    "OffsetType" : 0, // 0 = Global, 1 = Local
    "PositionOffset": {
      "x": 0.0,
      "y": 0.0,
      "z": 0.0 // Increase to move camera backwards
    },
    "RotationOffset": {
      "x": 0.0,
      "y": 0.0,
      "z": 0.0
    },
    "ForceUpright": false, // Remove head tilt
    "PositionalSmoothing": 0.0, // less = more smoothing. But 0 = no smoothing :D
    "RotationalSmoothing": 0.0,
    "PositionCompensation": false, // Dynamic position offset. Forces camera to move to a target position
    "PositionCompensationFrames": 60, // Sample size. Higher value == more freedom
    "PositionCompensationTarget": {  // Target position
      "x": 0.0,
      "y": 1.75,
      "z": 0.0
    },
    "RotationCompensation": false, // Dynamic rotation offset. Forces camera to look in a target direction
    "RotationCompensationFrames": 60, // Sample size. Higher value == more freedom
    "RotationCompensationTarget": { // Target rotation
      "x": 10.0,
      "y": 0.0,
      "z": 0.0
    }
  },
  "LayerFilter": { // Controls object layers visibility. Base game values are:
    "Layer0": true,    // Layer name: Default
    "Layer1": true,    // Layer name: TransparentFX
    "Layer2": true,    // Layer name: IgnoreRaycast
    "Layer3": false,   // Layer name: ThirdPerson
    "Layer4": true,    // Layer name: Water
    "Layer5": true,    // Layer name: UI
    "Layer6": false,   // Layer name: FirstPerson
    "Layer7": false,   // Layer name: HmdOnly (controlled by CameraUtils) <--- Since 1.42.0
    "Layer8": true,    // Layer name: Note
    "Layer9": true,    // Layer name: NoteDebris
    "Layer10": false,  // Layer name: Avatar
    "Layer11": true,   // Layer name: Obstacle
    "Layer12": true,   // Layer name: Saber
    "Layer13": true,   // Layer name: NeonLight
    "Layer14": true,   // Layer name: Environment
    "Layer15": true,   // Layer name: GrabPassTexture1
    "Layer16": true,   // Layer name: CutEffectParticles
    "Layer17": false,  // Layer name: ScreenDisplacement <--- Since 1.42.0
    "Layer18": false,  // Layer name: DesktopOnly (controlled by CameraUtils)
    "Layer19": true,   // Layer name: NonReflectedParticles
    "Layer20": true,   // Layer name: EnvironmentPhysics
    "Layer21": false,  // Layer name: AlwaysVisible (controlled by CameraUtils)
    "Layer22": false,  // Layer name: Event
    "Layer23": false,  // Layer name: DesktopOnlyAndReflected (controlled by CameraUtils)
    "Layer24": false,  // Layer name: HmdOnlyAndReflected (controlled by CameraUtils)
    "Layer25": false,  // Layer name: FixMRAlpha
    "Layer26": false,  // Layer name: AlwaysVisibleAndReflected (controlled by CameraUtils)
    "Layer27": true,   // Layer name: DontShowInExternalMRCamera
    "Layer28": true,   // Layer name: PlayersPlace
    "Layer29": true,   // Layer name: Skybox
    "Layer30": false,  // Layer name: MRForegroundClipPlane
    "Layer31": false   // Layer name: Reserved
  }
}