Skip to content

nefarius/Nefarius.Utilities.HIDReportKit

Repository files navigation

Nefarius.Utilities.HIDReportKit

.NET Requirements Requirements Nuget Nuget

Managed types and utility classes for HID report parsing and transforming.

Work in progress, use with care 🔥

Motivation

How many utilities are floating out there either reading or transforming data from gaming input devices? HID Report reading/parsing is a common task for those and doing this by hand is tedious and prone to errors. Why not have a nice small class library you could consume and be done with it? Look no further, weary traveler, we've got you covered!

Goals

  • Compatibility
    Still on .NET Framework 4.8? No problem, we will not force you to upgrade for the core feature set, but you'll miss out on some awesome stuff .NET 6 and higher has to offer 😉
  • Performance
    We'll do our absolute best to avoid unnecessary copy actions or other expensive operations that could taint your report parsing experience 💪 Spans much?
  • Plausibility
    Juggling opaque byte arrays will sooner or later lead to errors, how about some validation helpers and plausibility checks before you send a report on its way? 👌
  • Abstraction
    You are not in the mood to figure out what each darn byte in the controller state means? Can't blame you, to some it might look as close to magic as it can get. Was this value big- or little-endian? Don't know, don't care. We provide high-level abstractions you can consume in two lines and be done with it, no in-depth knowledge about bit-shifting or nibbles required 🔥

Supported devices

  • Sony™ DualShock™ 4 (PS4 Controller)
  • Sony™ DualSense™ (PS5 Controller)
  • ...more to come as the library grows!

NuGet

Until the library has reached level of maturity it won't be published on nuget.org, you can find development builds on my private feed though 👌 Use at your own risk, no support provided whatsoever.

Sources & 3rd party credits

This application benefits from these awesome projects ❤ (appearance in no special order):

About

Managed types and utility classes for HID report parsing and transforming.

Resources

License

Stars

Watchers

Forks

Languages