Getting Started

Intro

Hello and welcome to the Geenee SDK Documentation. On this page you will find basic information about architecture of our SDK. Processors page describes pose, face, and hand tracking features. Renderers documentation is about how to build AR experiences using Geenee SDK. Or you can start building your AR app right now:

Getting Started

To develop with the Geenee SDK you’ll need access tokens that can be created on your account page. There are two access tokens: NPM token and SDK tokens. An NPM token gives access to our package registry and is required to download SDK’s npm packages. Add @geenee:registry=https://npm.geenee.ar line to the global or a project-specific .npmrc file to set Geenee registry as the provider of @geenee packages. Additionally, set your NPM access token adding //npm.geenee.ar/:_authToken="npm.geenee.ar_token line. Example of .npmrc file is provided with every demo app listed below. An SDK token is used to authenticate user account and enable the SDK on the current url. SDK token is created for the url where a web app will be hosted, e.g. yourdomain.com/ar_app. Note: validation of a url doesn’t include protocol, url params, or port, for example, for https://www.domain.io/ar/?param1=true&param2=abc address in a browser you’ll need a token for www.domain.io/ar url. You’ll need a separate SDK token for each web app you will deploy. It is worth to create an additional SDK tokens for local development, e.g. for localhost or 127.0.0.1 urls. Development access tokens do not contribute to total number of views. SDK token has to be provided to initialize instance of Engine.

• Download and unpack one of examples:
  • Pose tracking example for babylon.js
  • Pose tracking example for three.js
  • Face tracking example for babylon.js
  • Face tracking example for three.js
  • Hand tracking example for babylon.js
  • Hand tracking example for three.js
• Get access tokens on your account page.
• Replace placeholder in .npmrc file with your personal NPM token.
• Run npm install to install all dependency packages.
• In src/index.ts set your SDK access tokens (replace stubs).
• Run npm run start or npm run start:https.
• Open http(s)://localhost:3000 url in a browser.
• That’s it, you first AR application is ready.