____________________________________ |RUNNING THE APP FOR THE FIRST TIME| ------------------------------------ 1) Download Android Studio from https://developer.android.com/studio/index.html. Follow default installation instructions; it will take a while to fully set up and load. This is normal. 2) Allow debugging permissions on your Andrid phone. Follow simple instructions from http://www.phonearena.com/news/How-to-enable-USB-debugging-on-Android_id53909 _______________________________ |TO WORK WITH AND RUN THE CODE| ------------------------------- 1) Download *entire* project file 2) Open Android Studio and click File --> New --> Import Project. Locate downloaded project file. Click it and open it. 3) THIS APP USES WIKITUDE SDK, WHICH, AT THE TIME OF WRITING, IS OPERATING UNDER A WIKITUDE EDUCATIONAL LICENSE, GOOD TIL ~END OF MAY 2017. To get yours and enable the app to work, go to https://www.wikitude.com/wikitude-academy/ and apply for an edu license. Once approved, you will be sent a license key, which you will paste in the VIEWARACTIVITY.JAVA file (see ABOUT.TXT). It will be an ungodly length. Replace the key that’s already there. *NOTE* See WIKITUDEREF.TXT to view a complete summary of the Wikitude SDK and helpful knowledge and notes. IT IS HIGHLY RECOMMENDED THAT THIS BE READ. 3) Plug phone (on which you recently enabled debugging) into your computer. There is a green triangle at the very top; click it. 4) A window will pop up with perhaps one or more possibilities on which to run it. The phone you have plugged in should appear at the top of the list, under "Connected Devices". If not, jiggle the cord a little, unplug it and plug it back in, etc. It should appear. If it still does not, confirm you'e enabled debugging on your device. 5) Click OK. It will begin the Gradle build, which may take a few minutes, especially since this is the first run. Let it sit. Eventually, the app should install and automatically begin running on your device. _____________________________ |TO NAVIGATE AND USE THE APP| ----------------------------- 1) The main introductory screen will appear with two buttons: ------- "TOUR" will take you to the camera, on which the AR markers will appear. Click on a marker to view its info. The info that appears is determined by the selection in the "Tell me about" dropdown; default is the first option--at the time of writing this, it is History. Information will also appear when you are within the proper range and the marker is in the camera view. If there are multiple markers in view, the user will be notified and urged to tap the marker for which they wish to see information. Selecting a POI in the "Point me to" dropdown will color the corresponding marker red, indicating its location. Selecting "Exit Guide Mode" will deselect it. Selecting another POI in the dropdown will disable Guide Mode on the current marker and enable it on the newly-chosen one. Coming into range of a marker in Guide Mode will prompt a popup informing the user and deselect the marker. Tapping on the Guide Mode marker wil also deselect it to disable Guide Mode. Tapping the radar will take the user to the Google Maps screen (Activity). If a marker is in Guide Mode, it will appear as a red marker instead of a green one. Tapping the "i" on the bottom will inform the user of the AR Activity's current state. Whenever a marker is selected, it will be recolored on the radar in yellow. Markers in Guide Mode will have their corresponding dots recolored in red. ------- "MAP" will take you to the Google Maps page, on which is displayed all of the POIs as green markers. The user's current location is blue. Tapping a marker will display the POI's name. Tapping on the blue marker will display "You are here." All the usual abilities apply--pinch to zoom in and out, ability to move around the map, etc. ____________ |EXCEPTIONS| ------------ 1) Deselecting a marker to exit Guide Mode (tapping on it while it is red) will select the correct "Exit Guide Mode" option in the "Point me to" dropdown, but the option does not visually replace the currently selected option. Possible JavaScript quirk. _________________________________________ |SUGGESTIONS FOR EXTENSIONS/IMPROVEMENTS| ----------------------------------------- 1) Utilize the Google Maps Directions API to load actual visual directions to POIs in the Maps activity 2) Disable informational popups after first appearance until exiting the geofence 3) Implement a map overlay for the Google Map, of the SNC campus map graphic 4) Implement back buttons and navigation buttons 5) Possible ability to save POIs/POI information 6) Possible ability to link to related information on SNC site _____________ |ATTRIBUTION| ------------- Direction indicator image provided by Wikitude, recolored by me POI markers taken from pixabay (public domain) and recolored by me Intro background taken from 123rf.com Original INDEX.HTML, ARWORLD.JS, MARKER.JS, and RADAR.JS taken from Wikitude-provided sample project "Selecting POIs", generally viewed at https://www.wikitude.com/external/doc/documentation/5.1/android/browsingpois.html and in entirety in downloaded Wikitude folder.