Skip to content

SETUP.md

Latest commit

 

History

History
70 lines (47 loc) · 1.41 KB

SETUP.md

File metadata and controls

70 lines (47 loc) · 1.41 KB
Raw

Setup

Requirements

  • Unity 2022.3.62f3c1 or another compatible Unity 2022.3 LTS editor.
  • Git.
  • Optional: Ollama for local LLM responses.

Open the Project

git clone https://github.com/<owner>/OPEN-AVATAR.git
cd OPEN-AVATAR

Open the folder with Unity Hub, then open:

Assets/00_Scenes/AvatarAgent_DemoScene.unity

Press Play to run the scene.

Run Without an LLM

Set AvatarAgentController > LLM > Provider Mode to Mock. This mode does not need network access or API keys.

Run With Ollama

Install Ollama, start the service, and pull a lightweight model:

ollama pull qwen2.5:3b

In Unity, set:

Provider Mode: Ollama
Ollama Endpoint: http://127.0.0.1:11434/api/generate
Ollama Model: qwen2.5:3b
Auto Resolve: true

When auto-resolve is enabled, OpenAvatar checks local Ollama models and can fall back to another installed model if the configured one is unavailable.

Run With a Custom JSON API

Set:

Provider Mode: CustomJsonApi
Custom Endpoint: http://127.0.0.1:8000/agent-response
API Key: optional bearer token

See docs/API_CONTRACT.md for the request and response format.

Editor Utility

To rebuild the demo Animator Controller inside Unity:

Tools/OpenAvatar/Rebuild Avatar Animator Controller

The utility generates Assets/09_Animations/AvatarAnimatorController.controller and tries to bind it to the demo avatar prefab.