[Plugin Contribution] PR #5014: SpatialReal Avatar Plugin - Request for Review & PyPI Transfer

Agents
1

Hi LiveKit Team and Community,

We are the team behind SpatialReal, an on-device rendered, ultra-low bandwidth AI avatar SDK. We have successfully integrated our solution with LiveKit, tested it thoroughly through the LiveKit Playground, and it is now live and stable.

Our goal is to provide LiveKit developers with a high-performance, cost-effective alternative for real-time digital human interactions. To make this a seamless part of the ecosystem, we would like to officially contribute our integration to the livekit/agents repository.

Here are the specific items we need your guidance on to move forward:

1. PR Review We have submitted a PR to add the SpatialReal avatar plugin. We would appreciate it if the engineering team could review the code and provide any necessary feedback.

PR Link: feat: add spatialreal avatar plugin by 3DRX · Pull Request #5014 · livekit/agents · GitHub

Since we render avatar client side, we are not streaming video, instead, we stream custom animation data using livekit which gets rendered on client side. So natually the video player won’t work with spatialreal, a client side SDK is needed for rendering the avatar. Checkout a set of example at GitHub - spatialwalk/avatarkit-voice-agent-demo: Examples showing how to build lip-synced voice agents using AvatarKit by SpatialReal · GitHub .

2. Documentation To ensure developers can easily find and implement this plugin, we want to align our documentation with the existing LiveKit Agents avatar plugin standards. Could you guide us on the standard process for creating and maintaining a dedicated SpatialReal page within the official docs?

3. PyPI Package Transfer We have published the initial plugin on PyPI (livekit-plugins-spatialreal) so developers can start testing it immediately. To maintain consistency with other official LiveKit plugins, we are ready to transfer the ownership of this package to the LiveKit organization. Please let us know the preferred account or organization ID to initiate the transfer.

We look forward to your feedback on the PR and are happy to discuss how we can best support the LiveKit ecosystem.

Best regards,

The SpatialReal Team

6 Likes
2

The plugin was tested throughout the building of https://playground.spatialreal.ai and also by our early users, so we think it’s the time for it to be added to livekit’s repo.

2 Likes
3

Hi @kangjingyang , thank you for the contribution. Quite by chance, I also saw a demo of SpatialReal at https://www.youtube.com/watch?v=1qENT6HNHqI yesterday.

I’m not on the engineering team, but I can give you some feedback to make the PR process smoother, and answer your questions:

1. PR Review We have submitted a PR to add the SpatialReal avatar plugin. We would appreciate it if the engineering team could review the code and provide any necessary feedback.

Thank you, the engineering team will review the submission properly. The timescale will depend on team capacity but I’ll give you some feedback from my point of view:

2. Documentation

The process is usually that once the PR gets accepted, we ask providers to create the markdown equivalent of the docs page, then our docs team reviews that and includes it into our repo. We also ask that providers submit updates to the docs though a similar means, by providing an updated markdown file.

This is a separate process, not part of your PR.

Specifically, I mean if you navigate to any of our existing avatars, e.g. Anam virtual avatar integration guide | LiveKit Documentation there is a drop down under ‘copy page’ where you can ‘view as markdown’, that is the markdown I’m referring to.

3. PyPI Package Transfer

I’m honestly not sure how that works. What you describe sounds sensible to me, but maybe bring that up in the PR discussion.

1 Like
4

Than you for the feedback, I’ve updated the PR with more detail & context, and made changes to address the ai review.