Skip to content

Commit effa608

Browse files
docs: clarify licensing and macOS backend status
Add a root license notice, move the MIT text under `LICENSES/`, and update install/packaging paths so distributed artifacts still include the expected license files. Refresh README and docs to better describe the current macOS CoreGraphics-only keyboard/mouse backend and keep planned native virtual-HID gamepad support scoped separately.
1 parent 485bf6e commit effa608

12 files changed

Lines changed: 53 additions & 43 deletions

File tree

CMakeLists.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,9 @@ if(LIBVIRTUALHID_INSTALL)
170170
"find_dependency(X11 COMPONENTS Xtst)\n")
171171
endif()
172172

173-
install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE"
173+
install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/LICENSES/MIT.md"
174174
DESTINATION "${CMAKE_INSTALL_DATADIR}/licenses/libvirtualhid"
175+
RENAME LICENSE
175176
COMPONENT library)
176177

177178
configure_package_config_file(

LICENSE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Repository License Notice
2+
3+
`libvirtualhid` contains components under different licenses. This file is a
4+
summary and does not replace the complete license texts.
5+
6+
- The cross-platform library source, public headers, non-driver backends,
7+
examples, tests, build scripts, and documentation are licensed under the
8+
[MIT License](LICENSES/MIT.md), except where the license map says otherwise.
9+
- The Windows UMDF driver, broker, proprietary entitlement and evaluation
10+
sources, and generated Windows driver package artifacts are licensed under
11+
the [LizardByte Source-Available License 1.0](LICENSES/LicenseRef-LizardByte-SAL-1.0.md).
12+
13+
See the [license map](LICENSES/README.md) for the authoritative repository path
14+
and artifact assignments.
File renamed without changes.

LICENSES/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Windows driver package.
66
- LB-SAL 1.0 SPDX custom identifier: `LicenseRef-LizardByte-SAL-1.0`.
77
- Cross-platform library source, public headers, non-driver backends, examples,
88
tests, build scripts, and documentation unless listed below:
9-
[MIT](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSE).
9+
[MIT](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/MIT.md).
1010
- Windows UMDF driver source under `src/platform/windows/driver/`, the broker
1111
service under `src/platform/windows/broker/`, and the broker entitlement and
1212
evaluation sources

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,12 @@ devices from the OS, or ship a Windows kernel-mode driver.
109109
110110
## 📌 Status
111111
112-
Linux and Windows are the active backends. Linux uses standard user-space kernel
113-
interfaces. Windows remains user-mode: the C++ library talks to a UMDF2 control
114-
driver, and the driver publishes HID gamepads through VHF. macOS support is not
115-
implemented yet.
112+
Linux and Windows provide virtual-device backends. Linux uses standard
113+
user-space kernel interfaces. Windows remains user-mode: the C++ library talks
114+
to a UMDF2 control driver, and the driver publishes HID gamepads through VHF.
115+
macOS currently provides a limited CoreGraphics synthetic-input backend for
116+
keyboard and mouse only. It is not a virtual-HID backend and does not yet
117+
support gamepads; native macOS virtual-HID gamepad support is planned.
116118
117119
The library is designed around gamepad use first because remote streaming hosts
118120
are the first consumer class. Non-gamepad device types are available through the
@@ -183,8 +185,14 @@ test app path and does not currently advertise an ARM64 build.
183185
184186
## 📄 License
185187
186-
The cross-platform `libvirtualhid` library is licensed under the MIT License.
188+
The cross-platform `libvirtualhid` library is licensed under the
189+
[MIT License](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/MIT.md).
187190
The Windows UMDF driver, broker, proprietary entitlement/evaluation sources,
188191
and generated Windows driver package artifacts, including the driver MSI, are
189-
licensed under the LizardByte Source-Available License 1.0 (LB-SAL 1.0). See the
190-
[license map](LICENSES/README.md) for the full repository split.
192+
licensed under the
193+
[LizardByte Source-Available License 1.0](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/LicenseRef-LizardByte-SAL-1.0.md)
194+
(LB-SAL 1.0). The root
195+
[license notice](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSE.md)
196+
points to both complete license texts; see the
197+
[license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/README.md)
198+
for the authoritative repository path and artifact assignments.

cmake/packaging/common.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ set(CPACK_PACKAGE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/cpack_artifacts)
1010
set(CPACK_PACKAGE_CONTACT "https://app.lizardbyte.dev")
1111
set(CPACK_PACKAGE_DESCRIPTION ${CMAKE_PROJECT_DESCRIPTION})
1212
set(CPACK_PACKAGE_HOMEPAGE_URL ${CMAKE_PROJECT_HOMEPAGE_URL})
13-
set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
13+
set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSES/MIT.md)
1414
set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}")
1515
set(CPACK_STRIP_FILES YES)
1616

cmake/packaging/windows.cmake

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,14 @@ if(LIBVIRTUALHID_DRIVER_TEST_CERTIFICATE)
5656
OPTIONAL)
5757
endif()
5858

59-
install(FILES
60-
"${PROJECT_SOURCE_DIR}/LICENSE"
61-
"${LIBVIRTUALHID_DRIVER_LICENSE_FILE}"
59+
install(FILES "${PROJECT_SOURCE_DIR}/LICENSES/MIT.md"
60+
DESTINATION "licenses"
61+
RENAME "MIT.md"
62+
COMPONENT driver)
63+
64+
install(FILES "${LIBVIRTUALHID_DRIVER_LICENSE_FILE}"
6265
DESTINATION "licenses"
66+
RENAME "LicenseRef-LizardByte-SAL-1.0.md"
6367
COMPONENT driver)
6468

6569
set(CPACK_COMPONENT_DRIVER_DISPLAY_NAME "Windows UMDF Driver")

docs/Doxyfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ INPUT = ../README.md \
4343
todo.md \
4444
streaming-host-integration.md \
4545
development.md \
46-
store-review-validation.md \
4746
../LICENSES/README.md \
4847
../examples \
4948
../third-party/doxyconfig/docs/source_code.md \

docs/development.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,11 @@ code and tests provide a better source of truth.
8888

8989
## Roadmap
9090

91-
- Finish Windows streaming-host replacement validation, especially application
92-
compatibility for the UMDF/VHF HID backend and any XInput-only fallback story.
93-
- Replace consumer-specific ViGEmBus installer/status/diagnostic flows with
94-
libvirtualhid driver-package checks.
95-
- Validate Linux host-adapter behavior across the selected controller profiles.
96-
- Define and implement the FreeBSD-supported backend subset.
97-
- Extend macOS support beyond CoreGraphics keyboard and mouse injection to
98-
native virtual HID devices, including signing, entitlement, and installer
99-
constraints.
91+
- Add native macOS virtual-HID gamepad support beyond the current CoreGraphics
92+
keyboard and mouse injection backend, including signing, entitlement, and
93+
installer constraints.
94+
- Add bindings for other languages, such as Python, Rust, and C#. Bindings will
95+
be considered for any requested language.
96+
- Evaluate an optional FreeBSD CUSE-backed `uhid(4)`-compatible device for
97+
direct HID consumers. This would supplement uinput; it is not equivalent to
98+
registering a virtual device with FreeBSD's kernel HID bus.

docs/store-review-validation.md renamed to docs/maintainer/store-review-validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Expected result:
6666
4. Run the required validation tool from the submission notes.
6767
5. Activate the review key supplied through Partner Center.
6868
6. Create the default gamepad and exercise its controls.
69-
7. Optionally run the browser validation steps.
69+
7. Optionally, run the browser validation steps.
7070

7171
If the default install location was changed during MSI installation, replace
7272
`$env:ProgramFiles\libvirtualhid` with the selected install directory.

0 commit comments

Comments
 (0)