Ocrx.Sdk.Overlay 2.7.0

dotnet add package Ocrx.Sdk.Overlay --version 2.7.0
                    
NuGet\Install-Package Ocrx.Sdk.Overlay -Version 2.7.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Ocrx.Sdk.Overlay" Version="2.7.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ocrx.Sdk.Overlay" Version="2.7.0" />
                    
Directory.Packages.props
<PackageReference Include="Ocrx.Sdk.Overlay" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ocrx.Sdk.Overlay --version 2.7.0
                    
#r "nuget: Ocrx.Sdk.Overlay, 2.7.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Ocrx.Sdk.Overlay@2.7.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Ocrx.Sdk.Overlay&version=2.7.0
                    
Install as a Cake Addin
#tool nuget:?package=Ocrx.Sdk.Overlay&version=2.7.0
                    
Install as a Cake Tool

Ocrx.Sdk.Overlay

Opt-in IRecordSink implementation that paints the latest observation in a topmost, click-through Windows overlay. Register new OverlaySinkFactory() through PluginHostOptions.OverlayFactory; on non-Windows systems the factory returns a no-op sink.

The overlay uses physical pixels and requests per-monitor-v2 DPI awareness when the package loads. The plugin executable should also declare the setting in its app.manifest, because a manifest is applied before any process window can be created:

<?xml version="1.0" encoding="utf-8"?>
<assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
  <application xmlns="urn:schemas-microsoft-com:asm.v3">
    <windowsSettings>
      <dpiAwareness xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">
        PerMonitorV2
      </dpiAwareness>
    </windowsSettings>
  </application>
</assembly>

Reference that manifest from the plugin project:

<PropertyGroup>
  <ApplicationManifest>app.manifest</ApplicationManifest>
</PropertyGroup>

The window never reads or modifies the game process, never requests elevation, and uses WS_EX_TRANSPARENT plus WS_EX_NOACTIVATE so mouse and keyboard focus stay with the game.

Styling

OverlaySpec supports installed fonts through fontFamily, or a plugin-packaged TrueType/OpenType font through fontFile. A font file is loaded privately by the overlay process, so it does not need to be installed on the player's system. usePixelText selects one-bit pixel rendering for bitmap-style fonts. borderColor, borderWidth, and cornerAccentLength add an optional outline with diagonal corner accents; leaving them unset preserves the original filled-pill appearance.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.7.0 100 9/29/2026
2.6.0 87 9/28/2026
2.5.0 107 9/18/2026
2.4.1 130 9/16/2026
2.4.0 94 9/15/2026
2.3.0 94 9/14/2026
2.2.0 98 9/14/2026
2.1.1 97 9/14/2026
2.1.0 98 9/11/2026
2.0.0 124 9/7/2026