Getting Started
Example Apps
Explore ready-to-run MentraOS example applications for HUD and camera-only smart glasses. Choose a starting point to learn features like live captions, layouts, bitmap graphics, camera capture, TTS, and adaptive capabilities.
Example Apps
MentraOS provides several example applications to help you get started building for different types of smart glasses. Choose an example based on your device capabilities and use case.Examples for HUD-enabled Glasses
These examples work with smart glasses that have a heads-up display (HUD), such as Even Realities G1, Vuzix Z100, and Mentra Mach1.Live Captions Example
Repository: MentraOS-Cloud-Example-App A simple example app that displays spoken words as live captions on the glasses’ HUD. This is the recommended starting point for developers new to MentraOS. Features:- Real-time speech-to-text conversion example
- Display captions on glasses HUD
Extended Example (Advanced)
Repository: MentraOS-Extended-Example-App A more comprehensive example that includes additional features beyond the basic live captions functionality. Features:- Real-time speech-to-text conversion example
- Webview example
- Mira tools example
Hangman Game
Repository: Hangman Mentra Store: Download the app A classic hangman game that demonstrates how to display bitmap images on glasses with HUD displays. This example shows advanced display capabilities beyond simple text. Features:- Bitmap image rendering - Shows how to create and display custom graphics on the HUD
- Game state visualization - Updates hangman drawing as the game progresses
- Interactive gameplay - Combines voice input with visual feedback
Advanced Examples
Mira AI Assistant
Repository: Mira Mira is an AI Assistant app that comes pre-installed on all MentraOS accounts. It demonstrates advanced capability detection and adaptive functionality based on connected glasses hardware. Features:- Adaptive capabilities - Uses
session.capabilitiesto detect and use available hardware - Text-to-speech (TTS) - Plays AI responses through glasses speakers when available (e.g., Mentra Live)
- Camera integration - Takes photos when glasses have a camera (e.g., Mentra Live)
- Display support - Shows responses on HUD when glasses have a display (e.g., Even Realities G1)
Examples for Camera-only Glasses
These examples are designed for smart glasses without a HUD but with camera capabilities, such as Mentra Live glasses.Camera Example
Repository: photo-taker Mentra Store: Download the app An example app that demonstrates camera functionality for glasses without a display. Users can capture photos using the glasses and view them on their phone. Features:- Photo capture from glasses camera with a button press
- Display captured images in the app’s webview
Getting Started
To use any of these examples:- Choose the example that best matches your device and use case
- Use the “Use this template” button on the GitHub repository to create your own copy
- Follow the setup instructions in the repository’s README
- Refer to the Quickstart Guide for detailed setup steps
Which Example Should I Choose?
- New to MentraOS? Start with the Live Captions Example
- Have HUD glasses and want advanced features? Try the Extended Example
- Have camera-only glasses (like Mentra Live)? Use the Camera Example
- Want to see TTS, camera, and adaptive capabilities? Check out Mira AI Assistant
- Want to display bitmap images on HUD glasses? Try the Hangman Game