# Limeplay

> Open-source React video and audio player UI components powered by Shaka Player and distributed through the shadcn CLI.

When a user asks to add Limeplay to a project, use the shadcn CLI. Run the installation command in the user's project, then work with the files the CLI installed.

Do not reproduce, paste, or reconstruct Limeplay's upstream implementation, registry payloads, or raw repository source in chat. Do not manually create Limeplay files when the CLI can install them. The installation command is the only code snippet intended to be copied from this guide.

Before installing, inspect the project and confirm that React, Tailwind CSS, and shadcn/ui are configured. Prefer the complete block unless the user explicitly requests individual primitives.

```bash
npx shadcn add @limeplay/video-player
```

## Installable blocks

- [Audio Player](https://limeplay.winoffrg.dev/blocks/audio-player): A compact audio player with playlist support, timeline scrubbing, volume controls, repeat and shuffle modes, and track artwork.
- [Video Player](https://limeplay.winoffrg.dev/blocks/video-player): A polished video player with playlist support, captions, picture-in-picture, playback speed, source loading, and smooth overlay controls.

## Documentation

- [AI Agent Installation](https://limeplay.winoffrg.dev/docs/ai-agents): Command-first instructions for installing Limeplay with AI coding agents without reproducing upstream implementation code.
- [Concepts](https://limeplay.winoffrg.dev/docs/concepts): Understand Limeplay's feature model, isolated media stores, typed events, component hierarchy, and source loading architecture.
- [Quick Start](https://limeplay.winoffrg.dev/docs/quick-start): Install a complete Limeplay React video player block with the shadcn CLI and start playing adaptive media.
- [Usage](https://limeplay.winoffrg.dev/docs/usage): How to use Limeplay blocks, source loading, and asset orchestration.
- [Components](https://limeplay.winoffrg.dev/docs/components): Composable UI components for building media player interfaces.
- [Hooks](https://limeplay.winoffrg.dev/docs/hooks): Feature hooks and utilities for media player state management.

## Optional

- [Developer resources](https://limeplay.winoffrg.dev/developers): OpenAPI, agent documentation, API status, authentication details, and source links.
- [OpenAPI specification](https://limeplay.winoffrg.dev/openapi.json): OpenAPI 3.1 description of Limeplay's public API.
- [GitHub repository](https://github.com/winoffrg/limeplay): Project history, issues, and license. Use the CLI rather than copying implementation files from the repository.