Skip to content

Instructions

Jump to bottom
Nicholas Ewalt edited this page Jan 15, 2018 · 22 revisions

Quick Start

  • Select an Application in the Top Left, as well as control the cropping and width/height of the Target Application.
  • Control the Overlay's position and rotation in the Bottom Left.
  • Control the Overlay's transparency, scale, and animation in the Bottom Right.
  • Save and Load profiles in the Top Right.
  • Advanced settings under "Additional Settings" button in the Top Left. Click again to close.

====

Table of Contents

====

Desktop Controls Key

example

Almost all elements will give you relevant hints if you hold your cursor over them.

All of the Input Fields can be adjusted by holding your cursor over them and using the Scroll Wheel.

The Sliders can also be adjusted using the Scroll Wheel.

  1. This doesn't do anything as of v1.0.6, but in future versions you will be able to select different "modes".
  2. This Dropdown allows you to select the Target Application that will be mirrored into an Overlay in VR.
  3. This Dropdown controls the Capture FPS. 24FPS should be sufficient for any video.
  4. This Dropdown controls the Capture Mode. Currently only GDI Direct and GDI Indirect are enabled. Some applications can only be captured in GDI Indirect, but GDI Direct is recommended because it is faster.
  5. This Button opens the Additional Settings panels. See Below for more information on Additional Settings.
  6. This Panel controls the Position of the Overlay. The Input Fields are linked to the Sliders. Changing the value in the Input Field will recenter the Slider so that it ranges -2/+2 from the Input Field. From top to Bottom these are X, Y, and Z. Relative to facing forward in your play area, X is Left and Right, Y is Up and Down, and Z is Forwards and Backwards. The Buttons on either side adjust the Slider by 0.1. These Buttons have hotkeys.
  7. This Panel controls the Rotation of the Overlay. Like the Position panel, the Input Fields and Sliders are linked, however the Sliders range from -360 to +360, and they are not recentered when you use the Input Fields. From top to bottom these are Pitch, Yaw, and Roll. The Buttons on either side adjust the Slider by 1. These Buttons have hotkeys.
  8. This Dropdown controls the "Anchor Device". This allows you to switch the Overlay from being World Attached, Screen Attached, or Attached to one of the controllers.
  9. This Dropdown controls the "Base Position" for Controller Overlays. This should make it easier to put Controller Overlays right where you want them.
  10. This Button swaps the "Left" controller for the "Right" one when using a Controller Overlay. This is used if OVRDDP identifies the controllers incorrectly. This has no effect except in OVRDDP; it does not swap the devices in SteamVR or any other game.
  11. This Panel controls Saving and Loading Profiles. To save a new profile. select "New.." from the Dropdown and press Save. This will enable the lower controls which allow you to name the new profile and finalize saving. To Delete a profile, select it and press the Delete button Twice. Once to initiate the deletion process and again to Confirm.
  12. This section controls the Appearance of the Overlay. See down below for more information.
  13. These Input Fields control the Crop settings for the Capture Region. Changing these values allows you to customize the capture region so you aren't forced to capture the entire window; you can choose to capture just a region of a window. This is useful for example for cutting off the Controls on a Video Player, when you just want to capture the video.
  14. These Input Fields control the width and height of the Target Application. This can be locked with #16 so the window will automatically be resized to the desired width/height in the event it is resized. This is extremely useful for programs like VLC which change their resolution to match the video being played. Some Applications have a minimum/maximum size or will refuse being resized, but most applications can be resized this way, even if they don't normally allow being resized. A Flash Video for example running in "Full Screen" can be resized, even though you normally wouldn't be allowed to resize it.
  15. This Button controls whether or not the size of the Target Application's window is locked. You can configure the size using the Input Fields marked as #21. Turning this on will tell OVRDDP to resize the Target Application's window when it has been resized externally.
  16. This Button controls whether or not the aspect ratio of the Target Application's window is locked when resizing it using #14. This can be extremely useful when capturing a video that you want to be smaller, but at the same aspect. Tip for Flash Player and other players: Full screen your video, target it, lock the aspect, then resize the height. This will let you resize say a 1080p video to 360p while maintaining the same aspect. This works great for sites like YouTube, Hulu, or Netflix, as well as players like VLC.

====

Appearance Settings

The Appearance of the Overlay (Animation, Scale, Transparency) can be changed using Desktop Control Key #12.

The Available Animations are: None, Alpha, Scale, AlphaAndScale, and DodgeGaze.

  • None does nothing, but you can still configure the Alpha (Transparency) and Scale.
  • Alpha/Scale/AlphaAndScale allows you to set the default Transparency (aka Alpha), and Scale, as well as the Transparency and Scale when you are looking directly at the Overlay.
  • DodgeGaze allows you to set the Transparency and Scale, as well as causing the Overlay to slide out of the way when you look at it.

Transparency ranges from 0 to 1, where 1 is fully visible and 0 is invisible.

Scale controls the Width and the Height is calculated automatically based on the aspect of the Target Application's Window. This number is in meters in VR space.

Detailed Explanation:

None

None

  1. This Input Field controls the Transparency of the Overlay.
  2. This Input Field controls the Scale of the Overlay.

Alpha/Scale/AlphaAndScale

Alpha

  • In Alpha mode, the Transparency will change when you look at the Overlay.
  • In Scale mode, the Size will change when you look at the Overlay.
  • In AlphaAndScale mode, both the Transparency and the Size will change when you look at the Overlay.
  1. This Input Field controls the Transparency when you are not looking at the Overlay.
  2. This Input Field controls the Transparency when you are looking at the Overlay.
  3. This Input Field controls the transition speed from #1 to #2.
  4. This Input Field controls the Scale when you are not looking at the Overlay.
  5. This Input Field controls the Scale when you are looking at the Overlay.
  6. This Input Field controls the transition speed from #4 to #5.

DodgeGaze

Dodge

  • In DodgeGaze mode, the Overlay will slide out of the way when you look at it.
  1. This Input Field controls the Transparency of the Overlay.
  2. This Input Field controls the Scale of the Overlay.
  3. This Input Field controls the X offset when you look at the Overlay. This number is in "widths", where 1 will cause the Overlay to move by it's full width to the right, 2 will cause the Overlay to move two full widths to the right, etc. Negative numbers will cause the Overlay to dodge to the left. This is so that regardless of the current scale it will still dodge by the same amount. The Scroll Wheel works but is limited from -5 to 5 on this Input Field. You can enter larger numbers manually if desired.
  4. This Input Field controls the Y offset when you look at the Overlay. This number is in "heights", where 1 will cause the Overlay to move by it's full height upwards, 2 will cause the Overlay to move two full heights upwards, etc. Negative numbers will cause the Overlay to dodge downwards. This is so that regardless of the current scale it will still dodge by the same amount. The Scroll Wheel works but is limited from -5 to 5 on this Input Field. You can enter larger numbers manually if desired.
  5. This Input Field controls the transition speed from the Overlay's rest position to the Offset position and back again. The Scroll Wheel works but is limited from 0.05 to 1 on this Input Field. You can enter smaller or larger numbers manually if desired.

====

VR Specific Controls

  • If a Click API is enabled (see Additional Settings #1), you can aim at the Overlay and pull the trigger to send a Left Click, click the Touchpad to send a Right Click, or click the Grips to send a Middle Click to the Target Application.
  • If Scroll Wheel is Enabled (see Additional Settings #4) you can send Horizontal and Vertical Scroll Wheel commands to the Target Application by aiming at the Overlay and touching the Touchpad in a sliding motion, from the top to the bottom or from the bottom to the top for Vertical scrolling, and from left to right or right to left for Horizontal scrolling.
    • This works best with SendInput. SendMessage and SendNotifyMessage require "Force Window On Top" and "Move Desktop Cursor" to send Scroll Wheel input correctly (see Additional Settings #2 and #3).
    • If "Require Grips" is enabled (see Additional Settings #5) you must hold down the grips while using the Touchpad in order to send Scroll Wheel input.
  • If Grab is enabled (see Additional Settings #11) you can Grab the Overlay by touching it with your controller and pressing and holding the trigger on that controller. While Grabbing you can move/rotate the Overlay as well as start a Scale action.
  • If Scale is enabled(see Additional Settings #12) you can Scale the Overlay by first Grabbing it as mentioned in the last step, then holding the trigger on your other controller and moving the controllers further apart or closer together.

Important Notes

  • Only World and Controller Overlays currently support Aim/Click.
  • Only World Overlays currently support Grab and/or Scale.

====

Hotkeys

Hotkeys only work while the application has focus.

  • Position:
    • X-/X+ = Q/W
    • Y-/Y+ = A/S
    • Z-/Z+ = Z/X
  • Rotation:
    • X-/X+ (Pitch) = E/R
    • Y-/Y+ (Yaw) = D/F
    • Z-/Z+ (Roll) = C/V
  • Other:
    • Toggle Overlay On/Off = Spacebar

====

Selecting an Application

You can Select an Application using Desktop Control Key #2. You can Refresh the list of Applications by opening and closing the Dropdown, pressing the refresh button just to the right, or it will refresh automatically every few seconds. All you have to do is click the Dropdown then click the desired application. If you don't see the application you are looking for, try closing and reopening the Dropdown and it should pop up.

====

Putting the Overlay where you want it

You can Move the Overlay using Desktop Control Key #5, or by "Grabbing" the Overlay and moving it as desired (see VR Specific Controls). The Overlay can be attached to the World, the Screen, or to one of the Controllers. Check out some of the Default Profiles in the top right for examples (see Saving/Loading 'Profiles').

Important Notes

  • Only World Overlays currently support being Grabbed.

====

Adjusting the Overlay's Size and Transparency

You can Resize the Overlay and adjust it's Transparency using the Appearance Settings. You can also Resize the Overlay using the Grab and Scale action if they are enabled (see Additional Settings #9 and #10 and VR Specific Controls).

You can also set the Overlay to change size/transparency when you are looking at it using the Appearance Settings.

Important Notes

  • Only World Overlays currently support being Grabbed and/or Scaled from VR.

====

Saving/Loading 'Profiles'

You can Save and Load Overlay settings using Desktop Control Key #10.

To load a profile:

  • Select it using the Profile Dropdown.
  • Press Load.

To save a profile:

  • Make sure you have the correct Profile selected in the Dropdown as it will be overwritten.
  • Press Save.

To save a new profile:

  • Select "New.." in the Profile Dropdown.
  • Press Save.
  • The lower controls will activate,
  • Type the profile name into the Input Field
  • Press the new Save button.

To delete a profile:

  • Select the desired Profile in the Dropdown.
  • Press the Delete button once to initiate the deletion.
  • Press the Delete button a second time to confirm deletion.

====

Additional Settings

example2

  1. This Dropdown controls the Click API used when you aim at the Overlay in VR and pull the trigger. SendInput is the most reliable, and works on every application that has been tested, though OVRDDP must be launched as Admin to simulate clicks to some applications.
  2. This Toggle controls whether or not the Target Application will be brought to the front when you aim at the Overlay in VR. This can be useful primarily in combination with #3. This setting might be locked depending on the Click API set using #1.
  3. This Toggle controls whether or not the Desktop Cursor is moved to match your aim in VR. In combination with #2, this allows for the Target Application to respond to your aim, such as highlighting buttons when you aim at them. This setting might be locked depending on the Click API set using #1.
  4. This Toggle controls whether or not the "Scroll Wheel" action is enabled in VR. See VR Specific Controls.
  5. This Toggle controls whether or not the Grips are required to be held down during the "Scroll Wheel" action in VR. See VR Specific Controls. This setting is disabled unless #4 is enabled.
  6. This Toggle controls whether or not the Desktop Cursor will be visible from VR. When this is Enabled, you can move your actual cursor over the Target Application and the cursor in VR will move to match it, as long as you are not currently aiming at the Overlay.
  7. This Toggle controls whether or not the Target Application will be brought to the front when your actual cursor moves over it. This can help a lot with interacting with the window without removing the HMD, as it will always move to the top so you can click on it, instead of fumbling around with Alt+Tab until it is on top. This setting is disabled unless #6 is enabled.
  8. This Toggle controls whether or not the cursor will auto-hide when you stop moving the actual cursor for a few seconds, but it is still hovering over the Target Application. This setting is disabled unless #6 is enabled.
  9. This Toggle controls the Filter Mode used on the captured image. This can make the picture a lot smoother, and can make the Overlay look a lot nicer. 'Point' Filtering is the same as No Filtering.
  10. This Dropdown controls the image used on the Backside of the Overlay. This can make the Overlay feel a bit more 'physical' as it has a front and backside. You may want to select "None" if your goal is to attach the Overlay to the backside of one of your controllers, that way when you turn it away from you it becomes completely invisible.
  11. This Toggle controls whether or not the "Grab" action is enabled in VR. See VR Specific Controls.
  12. This Toggle controls whether or not the "Scale" action is enabled in VR. See VR Specific Controls.
  13. This Button controls the Color of the Outline of the Overlay when no other color is being used. You can use this to add an Outline to the Overlay so that it is a bit more visible. Click the Button to open the Color Picker. See Color Picker.
  14. This Button controls the Color of the Outline of the Overlay when you are aiming at it, or when your actual cursor moves over the Target Application if #6 is enabled. See Color Picker.
  15. This Button controls the Color of the Outline of the Overlay when one of your controllers is touching it, or when you are performing a "grab" action. See Color Picker.
  16. This Button controls the Color of the Outline of the Overlay when you are performing a "scale" action. See Color Picker.
  17. This Toggle controls whether or not Haptic Feedback will be used. If Enabled, the controller will rumble a bit when you aim at the Overlay, when you touch it, and while you are scaling it.

====

Color Picker

cp

The Color Picker allows you to select from any color, using whatever method you prefer. You can select the color using the hue slider and color picker box, or you can select it using the Red/Green/Blue sliders, or using the Hue/Saturation/Value sliders. You can even use a color in HEX format by pasting the applicable string into the Input Field at the top right of the Color Picker and pressing Enter.

You can control the Transparency as well, using the bottom slider marked "A".

When you are finished, click Accept if you are happy with your changes, or Cancel to close the Color Picker without saving.

Clone this wiki locally