Skip to content

immersive-web/webxr-gamepads-module

Repository files navigation

WebXR Gamepads Module - Level 1

Build Status

The WebXR Gamepads Module 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.

Taking Part

  1. Read the code of conduct
  2. See if your issue is being discussed in the issues, or if your idea is being discussed in the proposals repo.
  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 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: Main specification for JavaScript API for accessing VR and AR devices, including sensors and head-mounted displays.
  • Gamepad API Specification: Introduces a low-level JS API interface for accessing gamepad devices.
  • Legacy WebVR API Specification: 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: 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.

Relevant Links

Communication

Maintainers

To generate the spec document (index.html) from the index.bs Bikeshed document:

make

Tests

For normative changes, a corresponding web-platform-tests 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 to follow up later. Add the type:untestable or type:missing-coverage label as appropriate.

License

Per the LICENSE.md file:

All documents in this Repository are licensed by contributors under the W3C Software and Document License.