Installation

VoiceReact is distributed as a Unity package. Follow the steps below to install it in your project.

Prerequisites

• Unity 2021.3 or newer
• A microphone input device for testing

Installation Steps

1. Import VoiceReact Package

Import the VoiceReact .unitypackage file into your Unity project:

1. Open your Unity project
2. Go to Assets > Import Package > Custom Package
3. Select the VoiceReact package file
4. Click Import in the import dialog (import all files)

VoiceReact will be installed to Assets/VoiceReact/.

2. Verify Installation

Check that VoiceReact installed correctly:

1. Look for Tools > VoiceReact in the Unity menu bar
2. You should see menu items:
   • Quick Setup Scene
   • Control Panel
   • Welcome Window

If you see these menu items, VoiceReact is installed successfully.

3. Quick Setup (Recommended)

The fastest way to set up a scene:

1. Go to Tools > VoiceReact > Quick Setup Scene
2. This automatically adds:
   • VoiceReact Manager (required coordinator)
   • VoiceReact Controller on your player (voice detection)
   • Configures everything with sensible defaults

You’re ready to use VoiceReact.

Manual Setup

If you prefer manual setup or need custom configuration:

Add VoiceReact Manager

The manager is required for VoiceReact to function:

1. Create an empty GameObject in your scene
2. Name it “VoiceReact Manager”
3. Add the VoiceReactManager component
4. Leave all settings at defaults (they’re already optimized)

Add Player Voice Detection

Add voice detection to your player:

1. Select your player GameObject
2. Add the VoiceReactController component
3. This automatically adds the required MicrophoneInputHandler component
4. Configure detection preset (default: Balanced)

Add Listener to Enemy

Make an enemy hear the player:

1. Select an enemy GameObject
2. Add the VoiceListener component
3. Set Base Hearing Range (e.g., 10 meters)
4. Hook the OnPlayerHeard event to your AI script

Optional Components

Dissonance Integration

If you’re using Dissonance VoIP for multiplayer voice chat:

1. Add the scripting define symbol VOICEREACT_DISSONANCE:

   • Go to Edit > Project Settings > Player
   • Expand Other Settings
   • Find Scripting Define Symbols
   • Add VOICEREACT_DISSONANCE
   • Click Apply

2. On your MicrophoneInputHandler:

   • Set Provider Type to Dissonance
   • Assign your DissonanceComms component reference

3. VoiceReact will now use Dissonance’s microphone input instead of Unity’s built-in Microphone API

This lets you use the same microphone input for both voice chat and gameplay mechanics.

Project Settings

VoiceReact includes project-wide defaults that apply to all components:

1. Go to Edit > Project Settings > VoiceReact
2. Configure default settings:
   • Default microphone device
   • Sample rate (16000 Hz recommended)
   • Detection presets
   • Listener hearing ranges
   • Logging verbosity

All new VoiceReact components will inherit these defaults, saving you configuration time.

Microphone Permissions

Standalone (Windows/Mac/Linux)

Unity automatically requests microphone permission. No special setup needed.

Mobile (iOS/Android)

Add microphone permission to your project:

iOS:

1. Go to Edit > Project Settings > Player > iOS > Other Settings
2. Add to Microphone Usage Description:

   This game uses your microphone for voice-reactive gameplay mechanics.

Android:

1. Go to Edit > Project Settings > Player > Android > Other Settings
2. Ensure Microphone is checked under Required Permissions

Verification

Test your installation:

1. Enter Play mode
2. Check the Console for VoiceReact initialization logs
3. Speak into your microphone
4. You should see:
   • VoiceReact Manager initialization
   • MicrophoneInputHandler starting
   • Voice detection when you speak

If you see errors, check:

• VoiceReactManager exists in scene
• Microphone device is connected
• Microphone permissions are granted

Troubleshooting

”VoiceReactManager is REQUIRED but not found”

You need to add VoiceReactManager to your scene:

• Use Tools > VoiceReact > Quick Setup Scene, or
• Manually add it following steps above

”No microphone devices available”

Check that:

• A microphone is connected to your computer
• Microphone permissions are granted (especially on macOS)
• No other application is exclusively using the microphone

”Multiple instances detected”

You have more than one VoiceReactManager in the scene. There should only be one per scene.

Next Steps