{"id":125,"date":"2018-08-27T20:44:44","date_gmt":"2018-08-27T20:44:44","guid":{"rendered":"https:\/\/www.xlsoft.com\/doc\/kudan\/?page_id=125"},"modified":"2019-03-05T01:44:30","modified_gmt":"2019-03-05T01:44:30","slug":"android-getting-started","status":"publish","type":"page","link":"https:\/\/www.xlsoft.com\/doc\/kudan\/android-getting-started\/","title":{"rendered":"Android Getting Started"},"content":{"rendered":"

This tutorial will show you how to setup an augmented reality project on Android using KudanAR.<\/p>\n

\n

Download Kudan’s AR Framework for Android<\/h2>\n

To get started, the first thing you’ll need is Kudan’s AR framework. You can download it on our Download<\/a>\u00a0page.<\/p>\n

\"Download<\/p>\n

Create a new Android Studio project<\/h2>\n

Start up Android Studio and create a new project.<\/p>\n

Amongst other details, you’ll be required to enter an Application Name and Company Domain. These two fields together make up your Package Name. You must make sure that this is the same as the Application Identifier associated with your API Key. This will either be the Application Identifier you used when generating a free API Key, or, if you are using the Development License Key<\/a>, simply com.xlsoft.kudanar<\/code>.<\/p>\n

Once you’ve made sure your [Package Name] is correct, select a save location, click next and choose a basic activity.<\/p>\n

\"Create<\/p>\n

Import Kudan’s AR Framework to the project<\/h2>\n

Import the .aar package to your project by going to (File -> New -> New Module…) and selecting Import .JAR\/.AAR package. Navigate to your newly downloaded KudanAR.aar file and open it. Name the subproject ‘KudanAR’.<\/p>\n

\"\"<\/p>\n

Add Kudan’s module to the project<\/h2>\n

Add module folder into settings.gradle and sync gradle.<\/p>\n

settings.gradle<\/span><\/div>
[code lang=”Java”]include ‘:app’, ‘:KudanAR'[\/code]<\/div><\/div><\/div>\n

Add KudanAR as a module dependency<\/h2>\n

Go to (File -> Project Structure…), select your app module, click the dependencies tab, click the plus in the lower left and select Module Dependancy to add KudanAR as a dependancy to your project.<\/p>\n

\"Add<\/p>\n

Add permissions and settings to your Android manifest<\/h2>\n

Add the required permissions to the manifest file. If you are building for Android 6.0 and above you will need to include a permissions request for the camera before opening your ARActivity. Click here<\/a> for more information about handling permissions.<\/p>\n

Add the configChanges and screenOrientation options to all of the activities that will display AR content.<\/p>\n

AndroidManifest.xml<\/span><\/div>
\n[code lang=”XML”]<uses-permission android:name="android.permission.CAMERA" \/>
\n<uses-permission android:name="android.permission.INTERNET" \/>
\n<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" \/>
\n<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" \/>
\n<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" \/>
\n<uses-permission android:name="android.permission.READ_PHONE_STATE" \/><\/p>\n

<activity android:name=".MainActivity"
\n…
\nandroid:configChanges="orientation|screenSize"
\nandroid:screenOrientation="fullSensor">
\n …
\n <\/activity>
\n[\/code]<\/div><\/div><\/div>\n

Adjust Gradle settings<\/h2>\n

Add the following noCompress<\/code> block to the app<\/code> module’s build.gradle<\/code>.
This prevents Android Studio compressing important Kudan assets.<\/p>\n

Kotlin<\/span>Java<\/span><\/div>
\n[code lang=”Java”]android
\n{
\n…
\n aaptOptions
\n {
\n noCompress ‘KARMarker’
\n noCompress ‘armodel’
\n }
\n}[\/code]<\/div>\n
\n[code lang=”Java”]android
\n{
\n…
\n aaptOptions
\n {
\n noCompress ‘KARMarker’
\n noCompress ‘armodel’
\n }
\n}[\/code]<\/div><\/div><\/div>\n

Add ARAPI key to activity<\/h2>\n

Open your MainActivity<\/code> and change it to the following:<\/p>\n

MainActivity<\/strong><\/p>\n

Kotlin<\/span>Java<\/span><\/div>
\n[code lang=”Java”]package com.xlsoft.kudanar<\/p>\n

import android.support.v7.app.AppCompatActivity
\nimport android.os.Bundle
\nimport eu.kudan.kudan.ARAPIKey;<\/p>\n

class MainActivity : AppCompatActivity() {<\/p>\n

override fun onCreate(savedInstanceState: Bundle?) {
\n super.onCreate(savedInstanceState)<\/p>\n

\/\/ setContentView(R.layout.activity_main)<\/p>\n

val key = ARAPIKey.getInstance()
\n key.setAPIKey("<Put API Key here>")
\n }
\n}[\/code]<\/div>\n

\n[code lang=”Java”]package eu.kudan.gettingstarted;<\/p>\n

import android.support.v7.app.AppCompatActivity;
\nimport android.os.Bundle;<\/p>\n

import eu.kudan.kudan.ARAPIKey;<\/p>\n

public class MainActivity extends AppCompatActivity {<\/p>\n

@Override
\n protected void onCreate(Bundle savedInstanceState) {
\n super.onCreate(savedInstanceState);<\/p>\n

\t\/\/ Comment this out for the time being unless you plan to create UI elements
\n \/\/setContentView(R.layout.activity_main);<\/p>\n

ARAPIKey key = ARAPIKey.getInstance();
\n key.setAPIKey("<Put API Key here>");
\n }
\n}[\/code]<\/div><\/div><\/div>\n

Find the API Key for your corresponding Package Name:<\/p>\n