App Overview

Aulae is divided into three main sections accessible through tabs at the bottom of the screen.

Map:

A map view with all GPS-positioned objects.

• Long press anywhere on the map to add an object at that location.
• Tap on your markers to edit notes or customize their appearance.
• Tap on standard feed pins to reveal object information.

View:

The AR viewport where you can interact with objects, capture photos, scan QR codes, and configure content/viewport settings.

• Long press on any object in the AR view to reveal the objects action sheet.
• Long press on an empty space in the AR view to add custom markers at your current GPS position.
• Use a pinch gesture (like zooming on a photo) to adjust the scale of objects that support scaling.
• Press the camera button to capture the current scene.
• Tap the QR Button to scan for and add feeds.
• Tap the settings button to configure view/app settings.

Lib:

This is your library, where you can add/remove/toggle and customize your feeds and markers.

• Add Feeds: Tap the plus button in the navigation bar to add new sources to your library.
• Tap feeds to toggle or swipe left to access options.
• Tap .

Content Guidelines

Aulae offers two primary methods for creating and serving content. First, you can design and personalize objects directly within the app. These objects are visible only to you and are always available, even offline. Second, serve feeds using either Aulae's internal format or GeoJSON. These feeds can be delivered as JSON files hosted on a web server or dynamically via REST APIs. See examples here.

GeoJSON Feeds

GeoJSON can be served as is, but it's important to note that LineString and Polygon features will be converted to single points representing the average of their coordinates. See below for some GeoJSON that the app understands. Properties are optional but will soon mirror the Aulae feed content field.

{ 
  "type": "FeatureCollection",
  "features": [
      { 
          "type": "Feature",
          "geometry": {"type": "Point", "coordinates": [-45.0, 76.0, 50]},
          "properties": {
              "name": "Point A (Optional)",
              "chatURL": "Url to your chat endpoint (Optional)",
              "description": "Point info (Optional)"
          }
      }
  ]
}

Aulae Feeds

Feed Metadata (Required)

This section provides information about the feed as a whole.

{
  "id": "",  // Unique ID for the feed
  "name": "",  // Feed name (Appears throughout the app)
  "info": "",  // Feed subtitle (Lib view feed subtitle)
  "version": 0,  // Version number (Effects updates)
  "updated_utx": 0,  // Unix timestamp of last update (Effects updates)
  "thumb_url": ""  // URL of an image representing the feed (Visible in feed managemnt views, Optional)
}

Feed Content (Optional)

The content field contains an object where each key represents an item to be displayed in the viewport and map (latitude and longitude values are required for map visibility). Click here for examples

Each content item has the following properties:

• "name": "", // Item name (Action menu subtitle and chat username)
• "type": "", // Content type ("image", "gif", "usdz", "text", "marker", "audio")
• "url": "", // Content URL
• "info": "", // Item information (Action menu item)
• "chat_url": "", // REST API chat endpoint (Action menu item)
• "world_scale": true, // Toggles distance based/static scaling
• "world_position": true, // Toggles lat/long/alt vs x/y/z item positioning
• "radius": 100, // The distance from which the item will be visible in the viewport (Requires lat/long)
• "text": "", // Text for text items
• "font": "", // Font for text items
• "extrusion": 1, // Extrusion depth for text items
• "hex_color": "7122e8", // Color for text and marker items
• "lat": 0.0, // Item Latitude
• "lng": 0.0, // Item Longitude
• "alt": 0.0, // Item Altitude
• "x_pos": 0.0, // Item X Position (Left/Right)
• "y_pos": 0.0, // Item Y Position (Up/Down)
• "z_pos": 0.0, // Item Z Position (Front/Back)
• "billboard": true, // Toggles billboard item orientation
• "scale": 1.0, // Item scale
• "content_link": "https://www.google.com" // URL to open in a web browser (Action menu item)

Aulae currently supports the following file formats:

• Images: Gif, Jpg, Png
• 3D: USDZ
• Audio: Mp3

Chat Endpoints

Receiving Chat Messages:

When the user sends a message, a POST request is made to your specified "chat_url" endpoint with the following payload:

{
  "client_id": "", 
  "client_username": "",
  "chat_msg": "",
  "sid": "", 
  "lat": "0.0", 
  "lng": "0.0", 
  "alt": "0.0"
}

Sending Chat Messages:

Aulae expects a response formatted like so:

{
  "chat_msg": "This is a message from the API",
  "sid": "",
  "username": ""
}