Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/RealComputer/GlassKit/llms.txt

Use this file to discover all available pages before exploring further.

GlassKit gives you three ways to start building Rokid Glasses apps, depending on whether you want agent-assisted development, a minimal scaffold, or a feature-complete starting point. This page walks through each approach with the exact commands you need.

Choose Your Starting Point

Agent Skill

Best when using Codex, Claude Code, Cursor, or another coding agent to build your app.

Starter App

Best when you want a minimal scaffold with HUD layout and navigation already wired up.

Complete Example

Best when an existing demo is close to the app you want to build.

Hardware Setup

Need to set up your Rokid Glasses or ADB first? Start here.

Option 1: Install the GlassKit Agent Skill

Use this approach when you want Codex, Claude Code, Cursor, or another coding agent to understand smart-glasses app development while it builds your app. Smart-glasses apps have unique aspects that coding agents are not used to handling: vision AI pipelines, small HUDs, camera and microphone access, touchpad and voice inputs, battery constraints, and wearer-facing UX. The GlassKit agent skill packages that context — along with reference patterns and the starter template — so agents can build more realistic glasses apps from the first pass.
1

Install the skill

Run the following command in your project directory. It uses the Agent Skills CLI and does not require a global install.
npx skills add RealComputer/GlassKit
2

Start building with your agent

Open your coding agent and describe what you want to build. The skill gives your agent the Rokid device constraints, HUD layout patterns, sensor access patterns, and real-time AI integration context it needs.Example prompts to get started:
  • Create a starter Rokid Glasses app
  • Add a camera preview to the first screen using the glasskit skill
  • Create a Rokid Glasses app that connects to OpenAI Realtime and talks about what it sees
3

Keep the skill up to date

As GlassKit evolves, update the skill to get the latest references and patterns:
npx skills update glasskit
The agent skill works best with coding agents that support skill context injection, such as Codex, Claude Code, and Cursor. Check your agent’s documentation for how it discovers and applies skills.

Option 2: Copy the Rokid Starter App

Use this approach when you want a small app scaffold with Rokid HUD layout and navigation patterns already in place. The starter is the same template the agent skill uses — it is the recommended foundation for new apps.
1

Clone the GlassKit repository and extract the starter

These commands clone the repo and extract just the starter app into a new directory, without copying the rest of the GlassKit repository:
git clone https://github.com/RealComputer/GlassKit.git
mkdir rokid-starter
git -C GlassKit archive HEAD:skills/glasskit/assets/rokid-hello-world | tar -x -C rokid-starter
2

Open the project in Android Studio

Open the rokid-starter directory in Android Studio. Let Gradle sync complete before building.
3

Build and install

Run these commands from the rokid-starter directory with your Rokid Glasses connected via the development cable (or an Android phone/emulator):
./gradlew :app:assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk
adb shell am start -n com.example.rokidhello/.MainActivity
4

Rename the package (optional)

The starter uses the com.example.rokidhello package name. Rename it in Android Studio before publishing or distributing your app.
The starter app includes a touchpad navigation scaffold and a viewport wrapper that maps touchpad gestures to touchscreen controls for phone and emulator testing. See Hardware Setup for controls reference.

Option 3: Copy a Complete Example

Use this approach when one of the GlassKit demos is close to the app you want to build. Copying a complete example gives you working code with all integrations already in place. The pattern is the same for any example. The steps below use rokid-feature-demo — a device-feature reference app covering touchpad navigation, offline voice commands, camera, mic, audio, and reusable screen controllers — but you can substitute any example name.
1

Clone the GlassKit repository and extract the example

Replace rokid-feature-demo with the name of the example you want to copy:
git clone https://github.com/RealComputer/GlassKit.git
mkdir my-glasses-app
git -C GlassKit archive HEAD:examples/rokid-feature-demo | tar -x -C my-glasses-app
2

Follow the example's README

Each example has its own README with exact setup steps, required environment variables, and any backend setup. Open my-glasses-app/README.md and follow it from the top.
3

Build and run

Build, install, and launch commands follow the same pattern across examples:
./gradlew :app:assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk
adb shell am start -n com.example.YOURPACKAGE/.MainActivity
Check the example README for the exact package name and any backend commands you need to run alongside the app.
Browse the full list of examples at Examples Overview to find the one closest to what you want to build.

Requirements

All three approaches share the same base requirements:
  • adb — Android Debug Bridge, included with Android Studio or installable separately
  • Rokid Glasses with a development cable — for on-device testing and debugging; see Hardware Setup
  • Android phone or emulator — for quick iteration before testing on device
Examples that include a backend also require:
  • uv — for Python backends
  • node — for TypeScript backends
  • API keys — such as OPENAI_API_KEY, OVERSHOOT_API_KEY, or ROBOFLOW_API_KEY depending on the example

Build docs developers (and LLMs) love