Kiosk Mode

PromethistAI provides Relational Agents that can be deployed in kiosk distributions. This section covers the setup, configuration, and hardware requirements for running PromethistAI agents in kiosk mode, enabling interactive displays for events, retail, or public installations.

PromethistAI Kiosk mode is currently available only on iOS devices.

Installation

To get started with the PromethistAI Kiosk application:

Download the App: Install the PromethistAI Kiosk app from the App Store.

Creating Your Agent

Before displaying an agent in kiosk mode, create one via the PromethistAI platform:

  1. Log in to the PromethistAI Platform and navigate to Platform → Projects → Agent → Agent Specific Identifier

  2. Create a new agent or select an existing one

  3. In the agent’s configuration settings, locate and copy the agent key (e.g., martha1). This key will be used in your kiosk configuration file

This agent will power the interactive experience in your kiosk setup.

Configuration

The PromethistAI Kiosk app stores configuration files in:

/Users/{username}/Library/Containers/PromethistAI Kiosk/Data/Documents

On first launch, the app creates default config files in this directory. It’s recommended to launch the app once before editing to ensure the container is initialized.

To quickly navigate to the configuration folder on macOS, press Cmd+Shift+G in Finder and continue with the path structure above.

config.txt

This file controls the agent, environment, and backend URL. Edit it with a text editor.

Environment (for background handling):

  • For greenscreen keying (e.g., custom backgrounds): environment=greenscreen

  • For automatic detection: environment=auto (default)

URL (backend endpoint):

  • Default: EU region (no change needed; uses https://PromethistAI.eu)

  • For US or other regions: url=https://PromethistAI.com

Key (agent identifier): Enter the agent key from the platform (e.g., key=martha1)

Anonymous (privacy setting):

  • Starts session without memory (no persistent user data)

  • Default: anonymous=true

Example config.txt
key=martha1
url=https://PromethistAI.eu
environment=auto
anonymous=true

camera.txt

This file handles Unity-based camera settings and is provided as-is—no Unity expertise required. Save it as a plain text file in the config directory with the following JSON structure:

{
  "position": [0, 1.47, -1.5],
  "rotation": [0, 0, 0],
  "FOV": 35
}

This example configures a shot focusing on the upper half of the body.

Parameters

Position

Camera position in 3D space (array of three floats).

  • X: Right/left offset

  • Y: Up/down offset

  • Z: Forward/back offset

Rotation

Camera rotation in 3D space (array of three floats).

  • First: Pitch (up/down tilt)

  • Second: Yaw (left/right pan)

  • Third: Roll (tilt)

FOV

Field of view in degrees (float).

  • Lower values zoom in (e.g., 35 for tighter framing)

  • Based on vertical FOV, so aspect ratio changes affect only horizontal width

Advanced Camera Parameters

Add these optional fields for fine-tuning:

{
  ...
  "sensorShift": [0, 0],
  "viewport": [0, 0, 1, 1]
}
sensorShift

2D shift of the camera view, simulating a tilt-shift lens.

viewport

Shift and scale of the image within the window.

  • The first two numbers represent the percentage offset from left and bottom

  • The second two numbers represent the percentage scaling of width and height

  • Example: setting values so the image only appears in the bottom-left quarter of the window

Updating Builds/Keys: Delete previous app builds and clear the container folder before installing updates, especially if agent keys change.

Applying Changes: Restart the app after editing config files for changes to take effect.

Troubleshooting: If configs don’t load, verify file permissions and relaunch.

Usage and Interaction

Once you are set up and configured, interact with your PromethistAI agent in your kiosk mode:

Starting a Conversation

To initiate a conversation, you need to enable the Push to Talk Mic option. This integrates with your hardware microphone.

Ending a Conversation

  • Type "Q" on a connected hardware keyboard to end the session

  • The conversation will also end automatically if user silence is detected twice (e.g., after a few seconds of inactivity without response)

These controls ensure smooth, user-friendly operation in public settings.

Hardware Recommendations

For optimal kiosk performance, use Apple Silicon-based hardware. We’ve tested setups for reliability in public environments.

Component Recommendations

Computer

  • Recommended: Mac Mini with M4 chip or better (Apple Silicon)

  • Minimum: 16GB unified RAM, 128GB SSD

  • Avoid laptops due to sleep modes, secondary display issues, and touch input challenges

  • Mac Mini is more cost-effective and stable

Touchscreen

  • Recommended: ELO Touch monitors (most robust and MacOS-compatible)

  • Alternatives: Philips, ViewSonic, Panasonic

  • Minimum size: 22"; ideal: 32" or 43" at 1920x1080 resolution

  • Use VESA mounts for flexibility; add a shelf for the Mac Mini if wall-mounting

  • Stand: Movable VESA TV Stand for ELO Touch

Audio Input (Push-to-Talk Microphone)

  • Recommended: Gooseneck microphone with USB interface, one-touch mute, and stand for podium-style use

  • Soundcard/Amplifier: Focusrite Scarlett Solo (USB Audio Interface) (or similar for Mac compatibility)

  • You need XLR cables with phantom power: AmazonBasics XLR Cable