1. XSOverlay
  2. News

XSOverlay News

Beta 545 Changelog | Release Candidate

[h3]This is a release candidate build, and is likely to go to the live branch.[/h3]

[hr][/hr]

[h3]NEW FEATURES[/h3]
  • Added: There is now a "Low Battery Notification Sound" toggle in the "General" tab of the settings panel. This will allow you to disable the sound for low battery notifications.

  • Added: You can now adjust the percentage at which a low battery notification will be displayed for a device. This defaults to 15%, as that is when SteamVR starts flashing controllers LEDs, and can be adjusted from 5% to 20%.


[h3]CHANGES TO EXISTING FEATURES[/h3]
  • Changed: Keyboard Layout Json can now have a "keycodes" array object, which will allow macro keys to be added to the keyboard. More info can be found on the Keyboard documentation page.

  • Changed: While using the "Aim Movement" option, Overlays that are brought close to the hand will now instead respect controller orientation entirely. This should result in more flexible and better handling of up close Overlays.


[h3]BUG FIXES[/h3]
  • Fixed: Day of week abbreviation has been added back to the Wrist Overlay.

Build 541 Changelog

Build 541 is a rather large build, as you may be able to tell from the changelog. We believe this build to be mostly stable, but as it changes and touches a lot of very large amounts of the code base (we completely overhauled quite a few systems) we're making the explicit decision to temporarily keep a branch of build 502 (The previous stable branch build) available.

If you have issues with 541 crashing on your system, please let us know, and provide us the appropriate log files. If the issue persists, you may opt to swap back to the old branch. Keep in mind, though, that this old branch will not be updated, and is only there as a temporary solution in the case that we are wrong about the stability of 541.

This branch can be accessed by right clicking XSOverlay in your Steam Library, click Properties, click Betas, and then clicking the "Build 502 Fallback" branch. We will be working hard to address any large issues that may crop up as a result of this update. Please do not use the fallback branch unless you absolutely need to!

Logs can be found at the following locations
Capture API Log: Right Click XSO in Steam Library -> Local Files -> Browse -> uWindowCapture.log

XSOverlay Logs: %AppData%/LocalLow/Xiexe/XSOverlay/output_logs/output_log_[DATE]_[TIME].txt

You can send these directly to me on Discord or in the beta-crash-logs channel on our Discord server

Now that that's out of the way, lets get into the fun part, changes!



[h3]OVERHAULS[/h3]
  • Overhaul: Capture API backend has been entirely replaced. We are now using Windows Graphics Capture for all capture types.

  • Overhaul: Keyboard 2.0 here! This completely overhauls the keyboard experience. Some new features of Keyboard 2.0 include the following:

    -- Virtual Keyboard will now automatically change key visuals and layout to attempt to match the currently selected keyboard in Windows. This means that the Layout Editor is a thing of the past, and is no longer a launch option.

    -- Virtual Keyboard will now react to presses on the physical keyboard.

    -- Virtual Keyboard will now save its opacity between restarts

    -- Virtual Keyboard now has an option to change the format (40%, 60%, 100%) / (Minimal, Compact, Full)





[h3]NEW FEATURES[/h3]
  • New Feature: Night Light. You can now go to the XSOverlay Settings panel and navigate to the Night Light tab to turn on a Night Light filter for Overlays. This will tint the screens a nice warm color, and has options for scheduling as well as the intensity of the red shift that it applies.

  • New Feature: Wrist Overlay skinning support. You can check the Documentation here for how to build themes for your wrist using our SDK.

  • New Feature: Default Window Maximum FPS setting

  • New Feature: Default Window Minimum FPS setting

  • New Feature: Default Window Scale setting

  • New Feature: Low Battery warnings for tracked devices. You will see an XSONotification telling you which device is low, as well as hear a sound. You can change this sound by navigating to [XSOInstallDirectory]/XSOverlay_Data/StreamingAssets/Etc/Audio/ and replacing lowBattery.ogg

  • New Feature: "Grid View"; This allows you to view and sort overlays with Windows Alt + Tab like functionality.

  • New Feature: "Grid View" button to Global Toolbar.

  • Added: Documentation now has Keyboard Layout documentation, and can be found here.





[h3]CHANGES TO EXISTING FEATURES[/h3]
  • Changed: XSOverlay should now auto-launch SteamVR if it is not already open.

  • Changed: Overhauled Wrist UI; Buttons have been moved to a side bar, and space has been moved to keep all important information always visible.

  • Changed: Media player will attempt to find a media process once on startup, if it fails, it will revert to needing an input to search again.

  • Changed: Support buttons will now show a notification telling the user to check their web browser once pressed.

  • Changed: Cursor now changes to a new sprite when grabbing a window.

  • Changed: Desktop Cursor position is now only set at the framerate that an overlay is updating it's texture at. This should make the cursor movement feel a bit smoother, and less jittery.

  • Changed: Aggressively remove textures from memory for window captures that are no longer in use. Swapping windows, deleting windows, etc, should now free the memory for the associated texture instantly if no other overlay shares the same texture. This should reduce memory usage by a bit for extended sessions where swapping or deleting windows was common the course of the session.

  • Changed: You can no longer grab an overlay by first grabbing the air and then swiping over an overlay.

  • Removed: "Unpin All" button has been removed.





[h3]BUG FIXES[/h3]
  • Fixed: The Wrist Overlay should no longer detach from the hand and appear at world origin at startup.

  • Fixed: The Wrist Overlay should no be upside down on the right hand when you have "Left Hand Dominant" selected in the settings.

  • Fixed: You should now be able to complete the tutorial fully and properly without resetting it.

  • Fixed: System Monitor now more correctly displays both CPU and GPU frame times.

  • Fixed: Frame time bar on performance monitor will now show the maximum frametime between CPU / GPU (whichever is currently highest), instead of showing the total of both.

  • Fixed: Changing to a window capture should now properly pull the window to the front of the desktop in all cases. (No more clicking on windows behind the capture.)

  • Fixed: Liv Trackers should no longer take a slot up on the battery information panel.

  • Fixed: Pinned overlays that are loaded from layouts with custom opacity should now load correctly.

  • Fixed: Pinned overlays that are loaded from layouts with custom scales should now load correctly.

  • Fixed: Overlays with "Auto-Hide" turned on should no longer 'randomly' change opacity. This was an issue with an interaction between the layout mode toggle fade out and "Auto Hide".

Beta 541 Changelog [RELEASE CANDIDATE]

[h3]This is a release candidate build, and is likely to go to the live branch.[/h3]

[h2]CHANGES FROM LAST BETA[/h2]
[h3]CHANGES[/h3]
  • Added: Force JIS Layout Toggle to keyboard settings. This will add two extra keys required for JIS, and add ひりがな(hirigana) to each key, as a physical JIS keyboard would have.

  • Added: Keyboard Key Group padding can now be overridden in the Keyboard Layout Json file as "keyGroupsPadding". This will change the spacing (in pixels) between each group of keys.


[h3]BUG FIXES[/h3]
  • Fixed: Pinned overlays that are loaded from layouts with custom opacity should now load correctly.

  • Fixed: Pinned overlays that are loaded from layouts with custom scales should now load correctly.

  • Fixed: Overlays with "Auto-Hide" turned on should no longer 'randomly' change opacity. This was an issue with an interaction between the layout mode toggle fade out and "Auto Hide".


[h3]KNOWN ISSUES[/h3]
  • Capture API may still crash. Please send us the logs BEFORE restarting the overlay!
Capture API logs can be found here:
[XSOInstallDirectory]/uWindowCapture.log

XSOverlay Logs can be found here: %AppData%/LocalLow/Xiexe/XSOverlay/output_logs/output_log_[DATE]_[TIME].txt

You can send these directly to me on Discord or in the beta-crash-logs channel on our Discord server


[h2]CHANGES FROM LIVE[/h2]
[h3]CHANGES[/h3]
  • Overhaul: Capture API backend has been entirely replaced. We are now using Windows Graphics Capture for all capture types.

  • New Feature: Night Light. You can now go to the XSOverlay Settings panel and navigate to the Night Light tab to turn on a Night Light filter for Overlays. This will tint the screens a nice warm color, and has options for scheduling as well as the intensity of the red shift that it applies.

  • New Feature: Keyboard 2.0 Beta is here! This completely overhauls the keyboard experience. Some new features of Keyboard 2.0 include the following:

    -- Keyboard will now automatically change key visuals and layout to attempt to match the currently selected keyboard in Windows. This means that the Layout Editor is a thing of the past (and will be removed as a launch option when this goes to live.)

    -- Keyboard will now mirror typing on the actual keyboard

    -- Keyboard will now save its opacity between restarts

    -- Keyboard now has an option to change the format (40%, 60%, 100%) / (Minimal, Compact, Full)

  • Changed: XSOverlay should now auto-launch SteamVR if it is not already open.

  • Changed: Overhauled Wrist UI; Buttons have been moved to a side bar, and space has been moved to keep all important information always visible. (This is a WIP and more changes will likely be made before going to live.)

  • Changed: Media player will attempt to find a media process once on startup, if it fails, it will revert to needing an input to search again.

  • Changed: Support buttons will now show a notification telling the user to check their web browser once pressed

  • Changed: Cursor now changes to a new sprite when grabbing a window.

  • Changed: Desktop Cursor position is now only set at the framerate that an overlay is updating it's texture at. This should make the cursor movement feel a bit smoother, and less jittery.

  • Changed: Aggressively remove textures from memory for window captures that are no longer in use. Swapping windows, deleting windows, etc, should now free the memory for the associated texture instantly if no other overlay shares the same texture. This should reduce memory usage by a bit for extended sessions where swapping or deleting windows was common the course of the session.

  • Changed: You can no longer grab an overlay by first grabbing the air and then swiping over an overlay.

  • Added: Wrist Overlay skinning support.

  • Added: Default Window Maximum FPS setting

  • Added: Default Window Minimum FPS setting

  • Added: Default Window Scale setting

  • Added: Wrist themeing can now access built in shader variables for various useful information. This will be expanded soon. You can check the Documentation here for how to build themes for your wrist using our SDK.

  • Added: Low Battery warnings for tracked devices. You will see an XSONotification telling you which device is low, as well as hear a sound. You can change this sound by navigating to [XSOInstallDirectory]/XSOverlay_Data/StreamingAssets/Etc/Audio/ and replacing lowBattery.ogg

  • Added: "Grid View"; This allows you to view and sort overlays with Windows Alt + Tab like functionality.

  • Added: "Grid View" button to Global Toolbar.

  • Added: Documentation now has Keyboard Layout documentation, and can be found here.

  • Removed: "Unpin All" button from Global Toolbar.


[h3]BUG FIXES[/h3]
  • Fixed: The Wrist Overlay should no longer detach from the hand and appear at world origin at startup.

  • Fixed: The Wrist Overlay should no be upside down on the right hand when you have "Left Hand Dominant" selected in the settings.

  • Fixed: You should now be able to complete the tutorial fully and properly without resetting it.

  • Fixed: Frame time bar on perf. monitor will now show the maximum frametime between CPU / GPU, instead of showing both of them added up.

  • Fixed: Initializing trackers should no longer trigger low batter notifications.

  • Fixed: Changing to a window capture should now properly pull the window to the front of the desktop in all cases.

  • Fixed: System Monitor now more correctly displays both CPU and GPU frame times.

  • Fixed: Liv Trackers should no longer take a slot up on the battery information panel.

  • Fixed: Pinned overlays that are loaded from layouts with custom opacity should now load correctly.

  • Fixed: Pinned overlays that are loaded from layouts with custom scales should now load correctly.

  • Fixed: Overlays with "Auto-Hide" turned on should no longer 'randomly' change opacity. This was an issue with an interaction between the layout mode toggle fade out and "Auto Hide".

Beta 540 Changelog [RELEASE CANDIDATE]

[h3]This is a release candidate build, and is likely to go to the live branch.[/h3]

[h2]CHANGES FROM LAST BETA[/h2]
[h3]CHANGES[/h3]
  • Added: Some keyboard keys can now be double-tapped to lock them down, as per Keyboard 1.0 behavior. (Left Shift, Right Shift, Alt, AltGR)

  • Changed: Keyboard should now reload layout on enable, this is a band-aid for a rare one-off bug that prevents the keyboard from loading sometimes.


[h3]BUG FIXES[/h3]
  • What's a bug? This build is perfect, right? I've never published a bug in my life. If you're reading this, feel free to make fun of me.


[h3]KNOWN ISSUES[/h3]
  • Capture API may still crash. Please send us the logs BEFORE restarting the overlay!
Capture API logs can be found here:
[XSOInstallDirectory]/uWindowCapture.log

XSOverlay Logs can be found here: %AppData%/LocalLow/Xiexe/XSOverlay/output_logs/output_log_[DATE]_[TIME].txt

You can send these directly to me on Discord or in the beta-crash-logs channel on our Discord server


[h2]CHANGES FROM LIVE[/h2]
[h3]CHANGES[/h3]
  • Overhaul: Capture API backend has been entirely replaced. We are now using Windows Graphics Capture for all capture types.

  • New Feature: Night Light. You can now go to the XSOverlay Settings panel and navigate to the Night Light tab to turn on a Night Light filter for Overlays. This will tint the screens a nice warm color, and has options for scheduling as well as the intensity of the red shift that it applies.

  • New Feature: Keyboard 2.0 Beta is here! This completely overhauls the keyboard experience. Some new features of Keyboard 2.0 include the following:

    -- Keyboard will now automatically change key visuals and layout to attempt to match the currently selected keyboard in Windows. This means that the Layout Editor is a thing of the past (and will be removed as a launch option when this goes to live.)

    -- Keyboard will now mirror typing on the actual keyboard

    -- Keyboard will now save its opacity between restarts

    -- Keyboard now has an option to change the format (40%, 60%, 100%) / (Minimal, Compact, Full)

  • Changed: XSOverlay should now auto-launch SteamVR if it is not already open.

  • Changed: Overhauled Wrist UI; Buttons have been moved to a side bar, and space has been moved to keep all important information always visible. (This is a WIP and more changes will likely be made before going to live.)

  • Changed: Media player will attempt to find a media process once on startup, if it fails, it will revert to needing an input to search again.

  • Changed: Support buttons will now show a notification telling the user to check their web browser once pressed

  • Changed: Cursor now changes to a new sprite when grabbing a window.

  • Changed: Desktop Cursor position is now only set at the framerate that an overlay is updating it's texture at. This should make the cursor movement feel a bit smoother, and less jittery.

  • Changed: Aggressively remove textures from memory for window captures that are no longer in use. Swapping windows, deleting windows, etc, should now free the memory for the associated texture instantly if no other overlay shares the same texture. This should reduce memory usage by a bit for extended sessions where swapping or deleting windows was common the course of the session.

  • Changed: You can no longer grab an overlay by first grabbing the air and then swiping over an overlay.

  • Added: Wrist Overlay skinning support.

  • Added: Default Window Maximum FPS setting

  • Added: Default Window Minimum FPS setting

  • Added: Default Window Scale setting

  • Added: Wrist themeing can now access built in shader variables for various useful information. This will be expanded soon. You can check the Documentation here for how to build themes for your wrist using our SDK.

  • Added: Low Battery warnings for tracked devices. You will see an XSONotification telling you which device is low, as well as hear a sound. You can change this sound by navigating to [XSOInstallDirectory]/XSOverlay_Data/StreamingAssets/Etc/Audio/ and replacing lowBattery.ogg

  • Added: "Grid View"; This allows you to view and sort overlays with Windows Alt + Tab like functionality.

  • Added: "Grid View" button to Global Toolbar.

  • Added: Documentation now has Keyboard Layout documentation, and can be found here.

  • Removed: "Unpin All" button from Global Toolbar.


[h3]BUG FIXES[/h3]
  • Fixed: The Wrist Overlay should no longer detach from the hand and appear at world origin at startup.

  • Fixed: The Wrist Overlay should no be upside down on the right hand when you have "Left Hand Dominant" selected in the settings.

  • Fixed: You should now be able to complete the tutorial fully and properly without resetting it.

  • Fixed: Frame time bar on perf. monitor will now show the maximum frametime between CPU / GPU, instead of showing both of them added up.

  • Fixed: Initializing trackers should no longer trigger low batter notifications.

  • Fixed: Changing to a window capture should now properly pull the window to the front of the desktop in all cases.

  • Fixed: System Monitor now more correctly displays both CPU and GPU frame times.

  • Fixed: Liv Trackers should no longer take a slot up on the battery information panel.

Beta 538 Changelog

[h2]CHANGES FROM LAST BETA[/h2]
[h3]CHANGES[/h3]
  • Added: Documentation now has Keyboard Layout documentation, and can be found here.

  • Changed: Added the ability to add secondaryText flag to Keyboard Json, allowing for things like having Kana and Romanji on the keyboard.


[h3]BUG FIXES[/h3]
  • Fixed: Keyboard Numberpad should now function again.

  • Fixed: Liv Trackers should no longer take a slot up on the battery information panel.


[h3]KNOWN ISSUES[/h3]
  • Capture API may still crash. Please send us the logs BEFORE restarting the overlay!
Capture API logs can be found here:
[XSOInstallDirectory]/uWindowCapture.log

XSOverlay Logs can be found here: %AppData%/LocalLow/Xiexe/XSOverlay/output_logs/output_log_[DATE]_[TIME].txt

You can send these directly to me on Discord or in the beta-crash-logs channel on our Discord server


[h2]CHANGES FROM LIVE[/h2]
[h3]CHANGES[/h3]
  • Changed: Overhauled Capture API back-end.

  • New Feature: Keyboard 2.0 Beta is here! This completely overhauls the keyboard experience. Some new features of Keyboard 2.0 include the following:

    -- Keyboard will now automatically change key visuals and layout to attempt to match the currently selected keyboard in Windows. This means that the Layout Editor is a thing of the past (and will be removed as a launch option when this goes to live.)

    -- Keyboard will now mirror typing on the actual keyboard

    -- Keyboard will now save its opacity between restarts

    -- Keyboard now has an option to change the format (40%, 60%, 100%) / (Minimal, Compact, Full)

  • Changed: XSOverlay should now auto-launch SteamVR if it is not already open.

  • Changed: Overhauled Wrist UI; Buttons have been moved to a side bar, and space has been moved to keep all important information always visible. (This is a WIP and more changes will likely be made before going to live.)

  • Changed: Media player will attempt to find a media process once on startup, if it fails, it will revert to needing an input to search again.

  • Changed: Support buttons will now show a notification telling the user to check their web browser once pressed

  • Changed: Cursor now changes to a new sprite when grabbing a window.

  • Changed: Desktop Cursor position is now only set at the framerate that an overlay is updating it's texture at. This should make the cursor movement feel a bit smoother, and less jittery.

  • Changed: Aggressively remove textures from memory for window captures that are no longer in use. Swapping windows, deleting windows, etc, should now free the memory for the associated texture instantly if no other overlay shares the same texture. This should reduce memory usage by a bit for extended sessions where swapping or deleting windows was common the course of the session.

  • Changed: You can no longer grab an overlay by first grabbing the air and then swiping over an overlay.

  • New Feature: Night Light. You can now go to the XSOverlay Settings panel and navigate to the Night Light tab to turn on a Night Light filter for Overlays. This will tint the screens a nice warm color, and has options for scheduling as well as the intensity of the red shift that it applies.

  • Added: Wrist Overlay skinning support.

  • Added: Default Window Maximum FPS setting

  • Added: Default Window Minimum FPS setting

  • Added: Default Window Scale setting

  • Added: Wrist themeing can now access built in shader variables for various useful information. This will be expanded soon. You can check the Documentation here for how to build themes for your wrist using our SDK.

  • Added: Low Battery warnings for tracked devices. You will see an XSONotification telling you which device is low, as well as hear a sound. You can change this sound by navigating to [XSOInstallDirectory]/XSOverlay_Data/StreamingAssets/Etc/Audio/ and replacing lowBattery.ogg

  • Added: "Grid View"; This allows you to view and sort overlays with Windows Alt + Tab like functionality.

  • Added: "Grid View" button to Global Toolbar.

  • Added: Documentation now has Keyboard Layout documentation, and can be found here.

  • Removed: "Unpin All" button from Global Toolbar.


[h3]BUG FIXES[/h3]
  • Potential Fix: The Wrist Overlay should no longer detach from the hand and appear at world origin at startup.

  • Fixed: You should now be able to complete the tutorial fully and properly without resetting it.

  • Fixed: Frame time bar on perf. monitor will now show the maximum frametime between CPU / GPU, instead of showing both of them added up.

  • Fixed: Initializing trackers should no longer trigger low batter notifications.

  • Fixed: Changing to a window capture should now properly pull the window to the front of the desktop in all cases.

  • Fixed: System Monitor now more correctly displays both CPU and GPU frame times.

  • Fixed: Liv Trackers should no longer take a slot up on the battery information panel.