====== 🗣️ Avatar Guide: Make it Talk! ======

This guide will help you create a basic and very simple "2-Frame" avatar (Mouth Closed / Mouth Open) that reacts when VoxAI speaks.

**How it works:**
  - **VoxAI** sends audio to a "Virtual Cable".
  - **OBS** listens to that cable.
  - The **Move Plugin** hides/unhides your "Open Mouth" image based on the volume.

----

===== 🛠️ Part 1: Prerequisites =====

Before opening OBS, download and install these two required tools.

**1. The Audio Driver (Virtual Cable)**
This allows VoxAI to "talk" directly to OBS without your microphone picking it up.
  * Download: [[https://vb-audio.com/Cable/|VB-Audio Cable]]
  * **Action:** Install it, then **RESTART YOUR COMPUTER**. //(Do not skip the restart!)//

**2. The OBS Move Plugin**
This handles the animation logic.
  * Download: [[https://obsproject.com/forum/resources/move.913/|OBS Move Plugin]]
  * **Action:** Download the installer for your OS and run it.

**3. Your Art**
You need two PNG images with transparent backgrounds:
  * ``avatar_closed.png`` (Mouth Closed)
  * ``avatar_open.png`` (Mouth Open)

----

===== 🎬 Part 2: OBS Scene Setup =====

Open OBS and follow these steps exactly.

**A. Add the Images**
  - Add your **Mouth Closed** image to the scene.
  - Add your **Mouth Open** image to the scene.
  - **Important:** Ensure the "Mouth Open" layer is **ABOVE** the "Mouth Closed" layer in the sources list.
  - Click the **Eye Icon** 👁️ next to the **Mouth Open** layer to hide it. (It should be invisible by default).

**B. Add the Audio Source**
  - In Sources, click **+** and select **Audio Output Capture**.
  - Name it "VoxAI Audio".
  - Device: Select **"Cable Input (VB-Audio Virtual Cable)"** (or similar).

----

===== ⚙️ Part 3: The Animation Logic =====

This is where the magic happens. We will tell OBS: //"When the audio gets loud, show the open mouth."//

  - Right-click your new **VoxAI Audio** source and select **Filters**.
  - Click **+** and select **Audio Move**.
  - Configure the settings exactly as shown below:

| Setting | Value |
| :--- | :--- |
| **Meter Type** | Magnitude |
| **Easing** | 0.00 |
| **Action** | Source Visibility |
| **Scene** | (Select your current Scene) |
| **Source** | (Select your **Mouth OPEN** image) |
| **Threshold Action** | **Enable Over and Disable Under** |
| **Threshold** | 0.05 (Start here, then adjust until it looks right) |

{{:audiosettings.png?500|}}

//**Pro Tip:** If the mouth isn't opening, lower the **Threshold**. If it gets stuck open, raise the **Threshold** slightly (e.g. to 5.00 or higher depending on volume).//

----

===== 🤖 Part 4: Connect VoxAI =====

Now tell VoxAI to use that special cable we installed.

  - Open **VoxAI**.
  - Go to **Audio > Audio Output**.
  - Select **"CABLE Input (VB-Audio Virtual Cable)"**.
    * //Note: The name might be cut off, looking like "CABLE Input (VB-Audio...".//

----

===== ✅ Testing =====

  - Type "Hello" in VoxAI.
  - Watch OBS.
  - You should see the **VoxAI Audio** bar move, and your avatar's mouth should open and close with the voice!

**Can't hear the bot?**

This is because the audio is going to the Virtual Cable, and not going to your speakers (as intended). To hear it yourself:
  - In OBS, click the **Gear Icon ⚙️** in the Audio Mixer next to "VoxAI Audio".
  - Select **Advanced Audio Properties**.
  - Change "Audio Monitoring" to **Monitor and Output**.

**Note: You will not be able to hear your bot unless OBS is open. This is because the audio source is not playing anywhere else where you can hear it.**