DeviceHub Mask Keymaps

This is the official, read-only catalog of downloadable DeviceHub Mask key-mapping profiles. It is a static repository, not a synchronization target: the desktop application downloads a selected profile into the user's local profile directory, where it can be edited and activated independently.

The client reads catalog-v1.json from this fixed HTTPS URL:

https://raw.githubusercontent.com/devicehub-mask/devicehub-mask-keymaps/main/catalog-v1.json

It only downloads profile paths relative to that catalog, verifies the published SHA-256 and byte count, then validates the native version: 2 profile before writing it locally. Downloads do not activate a profile automatically.

Repository Layout

catalog-v1.json                  Published discovery catalog
profiles/<entry-id>/profile.json Native DeviceHub Mask v2 profile for one entry
schemas/                         Editor-facing JSON Schemas
scripts/                         Catalog refresh and validation tools

The catalog starts empty deliberately. A real mapping must be tested on its listed application, stream resolution, orientation, and device family before it is published.

Add a Mapping

1. Export or save a working native DeviceHub Mask version: 2 profile.
2. Choose a permanent entry ID and an ASCII slug. Put the profile at profiles/<entry-id>/profile.json; its internal name must equal the slug.
3. Add the metadata to catalog-v1.json. match.bundle_ids and match.stream_resolution must exactly match the profile's bundleIdentifiers and targetResolution. product_types is optional and narrows compatible device models.
4. Run the two checks below and include the changed profile plus catalog in the pull request.

node scripts/refresh-catalog.mjs
node scripts/validate-catalog.mjs

refresh-catalog.mjs calculates the profile bytes and sha256 descriptors and updates the catalog timestamp. Do not hand-edit those values.

See CONTRIBUTING.md for the complete publishing contract.

Compatibility Fields

The application filters catalog entries by exact iOS Bundle ID and, when a live frame is available, by the stream width, height, orientation, and optional product_types. A matching entry is only a compatibility aid: game UI may change, so every published mapping needs a clear title, concise description, and current test results.

Published profiles and catalog metadata are public. Do not commit credentials, personal identifiers, screenshots, or private game/account data.