Metadata-Version: 2.5
Name: livekit-plugins-truefan
Version: 0.1.0
Summary: LiveKit Agents plugin for TrueFan AI avatars
Project-URL: Homepage, https://www.truefan.ai/
Author-email: TrueFan AI <support@true-fan.in>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: ai,audio,avatar,livekit,realtime,video,voice,webrtc
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10.0
Requires-Dist: livekit-agents>=1.6.7
Description-Content-Type: text/markdown

# TrueFan AI plugin for LiveKit Agents

Support for the [TrueFan AI](https://www.truefan.ai/) realtime avatar.

## Installation

```bash
pip install livekit-plugins-truefan
```

## Pre-requisites

You'll need TrueFan AI API credentials (an API key, or a username and password), the API base URL and an avatar ID.

The avatar joins your LiveKit room using `LIVEKIT_URL`, `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET` from the environment.

## Usage

Start the avatar before `AgentSession.start()`:

```python
from livekit.plugins import truefan

avatar = truefan.AvatarSession(
    avatar_id="...",
    api_base="...",
    username="...",
    password="...",
)
await avatar.start(session, room=ctx.room)

await session.start(agent=Agent(instructions="..."), room=ctx.room)
```
