Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nefarius/Nefarius.Utilities.HIDReportKit
Managed types and utility classes for HID report parsing and transforming.
https://github.com/nefarius/Nefarius.Utilities.HIDReportKit
Last synced: about 2 months ago
JSON representation
Managed types and utility classes for HID report parsing and transforming.
- Host: GitHub
- URL: https://github.com/nefarius/Nefarius.Utilities.HIDReportKit
- Owner: nefarius
- License: mit
- Created: 2023-08-30T18:37:59.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-12T12:07:27.000Z (3 months ago)
- Last Synced: 2024-06-12T16:24:05.899Z (3 months ago)
- Language: C#
- Homepage: https://discord.nefarius.at
- Size: 2.69 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Nefarius.Utilities.HIDReportKit
[](https://github.com/nefarius/Nefarius.Utilities.HIDReportKit/actions/workflows/build.yml)  
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](https://baget.nefarius.at/packages/nefarius.utilities.hidreportkit/) 👌 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):
- [DS4Windows/Vapour Input](https://github.com/CircumSpector/DS4Windows)
- [Game Controller Collective Wiki - Sony DualSense](https://controllers.fandom.com/wiki/Sony_DualSense)
- [Game Controller Collective Wiki - Sony DualShock 4](https://controllers.fandom.com/wiki/Sony_DualShock_4)
- [Ryochan7/DS4Windows](https://github.com/Ryochan7/DS4Windows)
- [CRC32 algorithm implementation by Yuri Babich, Stephan Brumme & Bulat Ziganshin](https://github.com/yubabich/FastCRC)
- [JoyShockLibrary](https://github.com/JibbSmart/JoyShockLibrary)
- [Generator.Equals](https://github.com/diegofrata/Generator.Equals)