https://github.com/immersive-web/webxr-gamepads-module
Repository for the WebXR Gamepads Module
https://github.com/immersive-web/webxr-gamepads-module
augmented-reality gamepad virtual-reality webxr
Last synced: 3 months ago
JSON representation
Repository for the WebXR Gamepads Module
- Host: GitHub
- URL: https://github.com/immersive-web/webxr-gamepads-module
- Owner: immersive-web
- License: other
- Created: 2019-07-29T20:20:50.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T02:56:44.000Z (10 months ago)
- Last Synced: 2025-01-29T21:24:00.751Z (3 months ago)
- Topics: augmented-reality, gamepad, virtual-reality, webxr
- Language: Bikeshed
- Homepage: https://immersive-web.github.io/webxr-gamepads-module
- Size: 3.8 MB
- Stars: 30
- Watchers: 34
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# WebXR Gamepads Module - Level 1
[](https://travis-ci.org/immersive-web/webxr-gamepads-module)
The [WebXR Gamepads Module][21] is for accessing the state of buttons, triggers, thumbsticks, and touchpads associated with virtual reality (VR) and augmented reality (AR) motion controllers on the Web. This specification is a product of the [Immersive Web Working Group][17].
## Taking Part
1. Read the [code of conduct][18]
2. See if your issue is being discussed in the [issues][21], or if your idea is being discussed in the [proposals repo][19].
3. We will be publishing the minutes from working group's bi-weekly calls.
4. You can also join the working group to participate in these discussions.
## Specifications
This repo is for the design of the [WebXR Gamepads Module - Level 1][21] which adds extends the WebXR Device API to allow developers to query button, trigger, thumbstick, and touchpad state.
### Related specifications
* [WebXR Device API - Level 1][1]: Main specification for JavaScript API for accessing VR and AR devices, including sensors and head-mounted displays.
* [Gamepad API Specification][5]: Introduces a low-level JS API interface for accessing gamepad devices.
* [Legacy WebVR API Specification][2]: Legacy WebVR API 1.1 specification for JavaScript API for accessing VR displays. Development of the WebVR API has halted in favor of being replaced the WebXR Device API. Several browsers will continue to support this version of the API in the meantime.
* [Legacy Gamepad Extensions API Specification][6]: Legacy WebVR API extensions the Gamepad API to enable access to motion controller capabilities.
See also [list of all specifications with detailed status in Working Group and Community Group](https://www.w3.org/immersive-web/list_spec.html).
## Relevant Links
* [Immersive Web Community Group][3]
* [Immersive Web Early Adopters Guide][16]
* [Immersive Web Working Group Charter][4]
## Communication
* [Immersive Web Working Group][17]
* [Immersive Web Community Group][3]
* [GitHub issues list: `webxr-gamepads-module`][21]
* [`public-immersive-web` mailing list][20]
* [Legacy `public-webvr` mailing list archive][7]
## Maintainers
To generate the spec document (`index.html`) from the `index.bs` [Bikeshed][10] document:
```sh
make
```
## Tests
For normative changes, a corresponding
[web-platform-tests][11] PR is highly appreciated. Typically,
both PRs will be merged at the same time. Note that a test change that contradicts the spec should
not be merged before the corresponding spec change. If testing is not practical, please explain why
and if appropriate [file a web-platform-tests issue][12]
to follow up later. Add the `type:untestable` or `type:missing-coverage` label as appropriate.
## License
Per the [`LICENSE.md`](LICENSE.md) file:
> All documents in this Repository are licensed by contributors under the [W3C Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software).
[1]: https://immersive-web.github.io/webxr/
[2]: https://immersive-web.github.io/webvr/
[3]: https://www.w3.org/community/webvr/
[4]: https://www.w3.org/2020/05/immersive-web-wg-charter.html
[5]: https://w3c.github.io/gamepad/
[6]: https://w3c.github.io/gamepad/extensions.html
[7]: https://lists.w3.org/Archives/Public/public-webvr/
[8]: https://github.com/immersive-web/webxr/issues
[10]: https://github.com/tabatkins/bikeshed
[11]: https://github.com/web-platform-tests/wpt
[12]: https://github.com/web-platform-tests/wpt/issues/new
[13]: http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
[14]: https://www.w3.org/community/about/agreements/cla/
[15]: https://www.w3.org/Consortium/Legal/2008/03-bsd-license.html
[16]: https://immersive-web.github.io/webxr-reference/
[17]: https://w3.org/immersive-web
[18]: https://immersive-web.github.io/homepage/code-of-conduct.html
[19]: https://github.com/immersive-web/proposals
[20]: https://lists.w3.org/Archives/Public/public-immersive-web-wg/
[21]: https://immersive-web.github.io/webxr-gamepads-module
[22]: https://github.com/immersive-web/webxr-gamepads-module/issues