hz-platform-sdk
Skill200 starsChanged 53 days agoApache-2.0View on GitHub
Guides integration of the Horizon Platform SDK for Meta VR and Horizon OS Android/Kotlin apps — achievements, IAP, users, leaderboards, presence, notifications, abuse reporting, entitlements, asset files, application lifecycle, consent, device integrity, language packs, user age categories, and rate and review. Covers setup, initialization, API usage, data types, error handling, and best practices for all 17 public platform SDK packages. Build paths: Standard Android and Meta Spatial SDK; use hz-psdk-integration for guided integration, hz-unity-platform-sdk for Unity/C#, and hz-quest-verify-first if the path is unclear.
In this repository37 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- hz-android-2d-portingSkill
- hz-api-upgradeSkill
- hz-immersive-designerSkill
- hz-iwsdk-webxrSkill
- hz-metavrx-layout-sdkSkill
- hz-metavrx-ui-setSkill
- hz-new-project-creationSkill
- hz-perfetto-debugSkill
- hz-psdk-integrationSkill
- hz-quest-verify-firstSkill
- hz-react-native-expoSkill
- hz-simpleperf-debugSkill
- hz-spatial-sdkSkill
- hz-store-pwaSkill
- hz-store-submitSkill
- hz-unity-code-reviewSkill
- hz-unity-device-readinessSkill
- hz-unity-face-trackingSkill
- hz-unity-fbx-importSkill
- hz-unity-meta-core-sdkSkill
- hz-unity-meta-interaction-sdkSkill
- hz-unity-meta-mixed-reality-utility-kitSkill
- hz-unity-meta-movement-sdk-retargetingSkill
- hz-unity-meta-quest-uiSkill
- hz-unity-passthrough-camera-accessSkill
- hz-unity-placementSkill
- hz-unity-platform-sdkSkill
- hz-unity-project-analyzerSkill
- hz-unity-sdk-upgradeSkill
- hz-unity-tmp-resourcesSkill
- hz-vr-debugSkill
- hz-xr-simulator-controlSkill
- hz-xr-simulator-install-and-configureSkill
- metavr-cliSkill
- portalSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 16
Use this skill when a developer:
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Horizon Platform SDK - Android/Kotlin Integration Guide
This is the API-reference skill for the Standard Android and Meta Spatial SDK
Android/Kotlin build paths.
For a guided codebase-analysis and integration workflow, use
hz-psdk-integration. For Unity/C#, use hz-unity-platform-sdk instead.
When to Use
Use this skill when a developer:
- Wants to integrate any Horizon Platform SDK feature in a Meta VR Android/Kotlin application
- Asks about setup, initialization, or dependencies for the SDK
- Needs help with a specific public platform API (achievements, IAP, users, etc.)
- Is troubleshooting errors or status codes from any SDK package
- Asks about HorizonServiceConnection, entitlements, or HzPlatformService
Quick Start
- Setup guide: https://developers.meta.com/horizon/documentation/android-apps/ps-setup-kotlin
- Maven artifacts: https://central.sonatype.com/search?namespace=com.meta.horizon.platform.sdk
Available APIs
| Feature | Reference | Description |
| Abuse Report | abuse-report | Listen for report button events in the system panel |
| Achievements | achievements | Unlock, track progress, and query simple/count/bitfield achievements |
| Application | application | Get app version, launch other apps, manage self-update downloads |
| Application Lifecycle | application-lifecycle | Detect launch type, handle deeplinks, log deeplink results |
| Asset File | asset-file | List, download, cancel, and delete downloadable asset files (DLC) |
| Consent | consent | Check and launch user consent flows |
| Device Application Integrity | device-application-integrity | Verify device and app integrity tokens |
| Entitlements | entitlements | Verify app purchase legitimacy and user authorization |
| Group Presence | group-presence | Set/clear presence, manage sessions, send invites, launch panels |
| In-App Purchases (IAP) | iap | Retrieve products, purchase history, checkout flow, consume purchases |
| Language Pack | language-pack | Get/set language packs, track localization downloads |
| Leaderboards | leaderboards | Retrieve leaderboard info, fetch/write entries with filtering |
| Notifications | notifications | Send device notifications with actions and icons |
| Rate and Review | rate-and-review | Check eligibility and launch the rating/review UI |
| Rich Presence | rich-presence | Set/clear rich presence status and destinations (deprecated; prefer group-presence) |
| User Age Category | user-age-category | Query user age group and report age categories |
| Users | users | Retrieve user profiles, friends, access tokens, identity verification |
How to Use
- First, read
references/common-setup.mdfor shared setup instructions, initialization code, and common status codes that apply to all APIs. - Then, read the specific reference file for the API you need (e.g.,
references/iap.mdfor in-app purchases). - For exact signatures, query the API index instead of guessing:
metavr docs api-search "<feature> <operation>", thenmetavr docs api-details <entry>for the full entry.
Each reference file contains only the package-specific content: API operations, data types, examples, and package-specific notes. The common setup and error codes are centralized in common-setup.md to avoid duplication.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.