Get access

Mimic is free and invite-only during the beta. Request access and tell us what you’re building and on which platforms. You’ll receive:

• a GitHub account invitation to the SDK repository, which hosts the Unity package and the npm packages, and
• these instructions, which work once the invitation is accepted.

npm (web and React Native)

The @vidrip packages are published to GitHub Packages. Create a GitHub personal access token (classic) with the read:packages scope, then add an .npmrc next to your package.json:

@vidrip:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Set GITHUB_TOKEN in your shell and in CI rather than committing the token. After that, installs work like any other package:

npm install @vidrip/mimic-web @mediapipe/tasks-vision

Unity (UPM)

Unity installs the package straight from the SDK repository with a git URL. Your machine needs git access to the repository (SSH key or a credential helper with your GitHub account).

In Window → Package Manager → + → Add package from git URL, enter:

https://github.com/vidrip/vidrip-mimic-sdk.git?path=unity/com.vidrip.mimic#v0.2.0

Pin the tag (#v0.2.0) so every machine on your team gets the same version. See Unity for the camera provider, which is a separate package.

Versions

Every release is a git tag and a matching npm version. See Versioning for what may change between beta releases, and the changelog for what did.