This repository contains the Android SpaceKit-Sample project, and hosts the Gradle/Maven
com.dentreality.spacekit:android artifact which contains the SpaceKit SDK.
The iOS repository can be found here.
- Minimum supported Android version: 24/7.0/Nougat
- Device must include a backwards-facing camera
- Must be an ARCore Supported Device
- Note: Work continues on optimisation of the SDK for lower-end devices. For the time being, we recommend using devices with greater computational power such as recent flagship devices from Samsung or Google.
Access to the com.dentreality.spacekit:android library via Gradle requires the creation of a Github Personal Access Token (PAT) with the appropriate scopes specified. To create one, go to the Personal Access Tokens area of your GitHub user settings, click "Generate new token" and create a token that includes the read:packages and read:org scopes. Once you have created your token, save the key and add it to your ~/.gradle/gradle.properties file along with your github username:
dentMavenUser=[your github username]
dentMavenKey=[your PAT key]
The SpaceKit SDK includes a dependency on the Google Maps SDK for Android, which requires the use of an API key. For convenience, we have included a debug key valid for this sample app but when you integrate the SpaceKit SDK into your own app, you will need to create your own key. Details on how to do this can be found here.
You will need two data files to run this project. We will provide you with sampple data directly. If you would like to make use of this or your own data you will need two files:
- A zip file containing HMDF data
- A JSON file containing sample product data
Both of these files should be placed in app/src/main/assets. You will then need to reference these file names in the DataLoaderFragment (in the SpaceKit.initialise call) and ProductDatabase (as sampleFileName) respectively.
For further information please refer to the KDoc API reference. If you have any questions or feedback, please send us an email.