> For the complete documentation index, see [llms.txt](https://docs.roomiekit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roomiekit.io/start-here/readme.md).

# Overview

Roomie Kit is a modular starter for realtime social products. It includes a Vite/React app, Supabase backend, Agora media layer, Babylon.js virtual rooms, Capacitor mobile wrappers, starter assets, and customization hooks.

Use it as a full virtual-room app, or use the media layer as a livestreaming and video-chat foundation without the 3D spaces.

## Start Here

* Running locally: [Quickstart](/start-here/quickstart.md)
* Choosing a product shape: [What you can build](/start-here/what-you-can-build.md)
* Understanding the repo: [Repository structure](/start-here/repository-layout.md)

## Roomie Kit Cloud

Roomie Kit Cloud is the paid path for teams that want browser-login setup, guided deployment, health checks, starter asset hosting, Codex/Claude Code plugin access, update tooling, and support. See the [plans section](https://roomiekit.io/#pricing) for current pricing, then follow [CLI onboarding](/roomie-kit-cloud-and-hosted/onboarding.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.roomiekit.io/start-here/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.