Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ summary and does not replace the complete license texts.
sources, and generated Windows driver package artifacts are licensed under
the [LizardByte Source-Available License 1.0](LICENSES/LicenseRef-LizardByte-SAL-1.0.md).

See the [license map](LICENSES/README.md) for the authoritative repository path
See the [license map](LICENSES/license-map.md) for the authoritative repository path
and artifact assignments.
8 changes: 8 additions & 0 deletions LICENSES/README.md → LICENSES/license-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@ Every installed library distribution includes the MIT notice under
`share/licenses/libvirtualhid`. The Windows driver MSI may include MIT-licensed
helper components from this repository; packaged installs include both license
texts for that reason.

<div class="section_buttons">

| Previous | Next |
|:--------------------------------------|-------------------------------------------------------------:|
| [Development](../docs/development.md) | [Source Code](../third-party/doxyconfig/docs/source_code.md) |

</div>
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,5 +189,13 @@ licensed under the
(LB-SAL 1.0). The root
[license notice](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSE.md)
points to both complete license texts; see the
[license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/README.md)
[license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/license-map.md)
for the authoritative repository path and artifact assignments.

<div class="section_buttons">

| Previous | Next |
|:---------|---------------------------------------------------------:|
| | [End-User Gamepad Guide](docs/end-user-gamepad-guide.md) |

</div>
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ INPUT = ../README.md \
todo.md \
streaming-host-integration.md \
development.md \
../LICENSES/README.md \
../LICENSES/license-map.md \
../examples \
../third-party/doxyconfig/docs/source_code.md \
../src/include
8 changes: 8 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,11 @@ code and tests provide a better source of truth.
- Evaluate an optional FreeBSD CUSE-backed `uhid(4)`-compatible device for
direct HID consumers. This would supplement uinput; it is not equivalent to
registering a virtual device with FreeBSD's kernel HID bus.

<div class="section_buttons">

| Previous | Next |
|:------------------------------------------------------------|------------------------------------------:|
| [Streaming-Host Integration](streaming-host-integration.md) | [License Map](../LICENSES/license-map.md) |

</div>
8 changes: 8 additions & 0 deletions docs/end-user-gamepad-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,11 @@ reaching the library but the virtual device reports it incorrectly.

The [Moonlight setup guide](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide)
links the official clients and their support resources.

<div class="section_buttons">

| Previous | Next |
|:-------------------------|--------------------------:|
| [Overview](../README.md) | [Usage and API](usage.md) |

</div>
8 changes: 8 additions & 0 deletions docs/platform-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,3 +437,11 @@ Native macOS virtual-HID gamepad support is planned. A future backend may use
`IOHIDUserDevice`, DriverKit/HIDDriverKit, or a combination that preserves the
same public API while documenting any signing, entitlement, and installer
requirements.

<div class="section_buttons">

| Previous | Next |
|:--------------------------|--------------------------------------------:|
| [Usage and API](usage.md) | [Windows Driver Package](windows-driver.md) |

</div>
8 changes: 8 additions & 0 deletions docs/streaming-host-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,11 @@ The core API and adapter shape cover the major streaming-host requirements:
- FreeBSD uinput gamepads and pointer devices, with basic PlayStation input and
rumble but without Linux UHID-only PlayStation features.
- Windows UMDF/VHF gamepad creation through an installed driver package.

<div class="section_buttons">

| Previous | Next |
|:----------------|------------------------------:|
| [TODO](todo.md) | [Development](development.md) |

</div>
9 changes: 6 additions & 3 deletions docs/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ Proposed solution:
commit a generated capture later if it is reproducible, sanitized, and used
by tests or documentation in a way that justifies keeping it.

## PlayStation and Nintendo Rumble
<div class="section_buttons">

Status: native output-path validation and the remaining Steam and Chromium
consumer gaps are tracked in [GitHub issue #80](https://github.com/LizardByte/libvirtualhid/issues/80).
| Previous | Next |
|:--------------------------------------------|------------------------------------------------------------:|
| [Windows Driver Package](windows-driver.md) | [Streaming-Host Integration](streaming-host-integration.md) |

</div>
8 changes: 8 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,11 @@ for every profile.
The `misc1` button represents Share/Capture/Mic Mute-style controls and is
available on the generic, Xbox Series, DualSense, and Switch Pro profiles; Xbox
360 and Xbox One do not advertise that extra button.

<div class="section_buttons">

| Previous | Next |
|:----------------------------------------------------|----------------------------------------:|
| [End-User Gamepad Guide](end-user-gamepad-guide.md) | [Platform Support](platform-support.md) |

</div>
10 changes: 9 additions & 1 deletion docs/windows-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,14 @@ and must not ship the local pull-request test certificate.
The Windows UMDF driver, broker, proprietary entitlement/evaluation sources,
and generated Windows driver package artifacts, including the driver MSI, are
licensed under the LizardByte Source-Available License 1.0 (LB-SAL 1.0). See
the [license map](../LICENSES/README.md) for the full repository license split.
the [license map](../LICENSES/license-map.md) for the full repository license split.
The MSI may also include MIT-licensed helper components from this repository,
so packaged installs include both license texts.

<div class="section_buttons">

| Previous | Next |
|:----------------------------------------|----------------:|
| [Platform Support](platform-support.md) | [TODO](todo.md) |

</div>
2 changes: 1 addition & 1 deletion gh-pages-template/virtual-hid-driver.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2 class="fw-bolder mb-0">License</h2>
</div>
</div>
<div class="card-footer p-3 px-4">
<a class="btn btn-outline-theme me-3 mb-3" href="https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/README.md" target="_blank" rel="noopener">
<a class="btn btn-outline-theme me-3 mb-3" href="https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/license-map.md" target="_blank" rel="noopener">
<i class="fa-fw fa-lg fas fa-scale-balanced"></i>
View license map
</a>
Expand Down
Loading