# Introduction

MRBD is an unofficial package set for building web applications that target Meta Ray-Ban Display glasses.

The project has three parts:

- `@mrbd/core` provides framework-agnostic constants and browser helpers.
- `@mrbd/react` provides React components and hooks.
- `create-mrbd-app` scaffolds a Next.js starter app with MRBD-safe defaults.

Use these packages when you want reusable code for fixed-size wearable display apps instead of copying platform glue into every project.

## Core constraints

- Build for a fixed `600x600` viewport.
- Avoid scrolling where possible.
- Use dark backgrounds and high-contrast text.
- Treat pure black as transparent on the additive display.
- Make all interactive controls reachable by Arrow keys and Enter.
- Request sensors and location from explicit user gestures.
- Clean up listeners and geolocation watchers.
- Use high-resolution PNG icons or Unicode symbols, not SVG app icons.

## Unofficial status

This project is not affiliated with, endorsed by, sponsored by, or approved by Meta Platforms, Inc., Ray-Ban, EssilorLuxottica, or their affiliates.