🤖 VoxAI Installation Guide

Follow these steps in order. Do not skip ahead.

1. Download the .zip file.
2. Right-click the file and select Extract All.
3. Move the extracted folder to a simple location (e.g., C:\VoxAI).
   • Do not run it from inside the zip file!

This is a one-time setup to let VoxAI read your chat. Please read carefully.

1. Open the Twitch Developer Console.
2. Log in and click Register Your Application (on the right).
3. Fill in the form exactly like this:
   • Name: Give it a unique name (e.g., MyStreamBot_YourName). Note: This name must be unique across ALL of Twitch, not just your account.
   • OAuth Redirect URLs: http://localhost:17563
     • (Copy/Paste that URL exactly. It must look exactly like that.)
   • Category: Chat Bot
4. Click Create.

1. Click Manage next to the app you just created.
2. Copy the Client ID. Save it in a notepad.
3. Click the New Secret button.
4. Copy the Client Secret. Save it in a notepad.
   • Warning: Do not show this Secret on stream!

1. Go to your C:\VoxAI folder.
2. Run twitch_setup.exe.
3. Paste your Client ID and Client Secret when prompted.
4. A browser window will open. Click Authorize.
   • Success! Your Twitch tokens are now saved.

1. Run VoxAI.exe.
2. Enter the email and password you used to purchase VoxAI.
3. This binds the software to your PC.

You need an API key to make the AI smart. Pick ONE provider below.

Best for conversation quality.

1. ⚠️ IMPORTANT: You must set up Billing in your OpenAI account first, or the key will not work. Add Credit Here.
2. Go to OpenAI API Keys.
3. Click Create new secret key.
4. Name it “VoxAI” and copy the key (starts with sk-…).
5. In VoxAI: Go to AI > AI Settings.
6. Select Provider: OpenAI and paste your key.
7. Model: Select gpt-4o-mini (Cheap), gpt-5-mini (Cheap / Smartest) or gpt-5-nano (Cheapest).

Great alternative, very fast.

1. Go to Google AI Studio.
2. Click Create API Key.
3. In VoxAI: Go to AI > AI Settings.
4. Select Provider: Gemini and paste your key.
5. Model: Select gemini-2.5-flash.

You will want to create a billing account if you want to use Gemini past it's free tokens account.

Click SAVE in the settings window.

Pick ONE voice provider.

1. Go to the Azure Portal.
2. Click on Subscriptions you will be creating a “Pay as you go” Plan.
3. Click the + ADD button on this screen.
4. Click Add a different type of subscription
5. Choose Pay as you go
6. In the new window give your Pay as you go plan subscription a name (you will need to add your payment information during this step - which is not covered here)
7. Then click the Review + Create button
8. Click the Create button. After creation proceed to next step
9. Proceed back to Home page for Azure.

You will now need to create the Speech Service that you will use inside of VoxAI.

1. Search for Speech services at the top in the search box and click the Speech Services result.
2. Click the + Create button on the Speech Services page.
3. Select your Pay as you go subscription that you created earlier in the Subscription box.
4. In Resource Group create a new group and call it “Main”.
5. Region: Pick a region close to you (Generally East US (eastus) will be fine).
6. In the Name box put “VoxAI”.
7. In Pricing Tier choose Standard SO. Do not choose free tier!
8. Click Review + Create, then Create.
9. Wait for deployment to finish, then click the “Deployment Details” and select “VoxAI”. *
10. On the left menu, click Keys and Endpoint under Resource Management.
11. Copy Key 1 and Location/Region.
12. In VoxAI: Go to AI > AI Settings → Voice Provider: Azure.
13. Paste your Key and Region. Click Save.

*If you cannot find your created Speech Service or lost it somehow. Head to the main page and search for “VoxAI” and click the result from the search.

1. Go to ElevenLabs.
2. Click your profile icon → Profile + API Key.
3. Copy the API Key.
4. In VoxAI: Go to AI > AI Settings → Voice Provider: ElevenLabs.
5. Paste the key and click Fetch Voices.
6. Select a voice and click Save.

This option is only recommended if you do not mind investing a lot more money to get a real sounding voice.

1. Select Audio Devices:
   • Audio > Audio Output: Choose where you want to hear the bot (Speakers/Headphones).
   • Audio > Mic Selection: Choose your microphone (for voice commands).
2. Create the Persona:
   • AI > Persona: Give your bot a name (e.g., “GLaDOS”) and a personality (e.g., “Sarcastic robot”).
   • Tip: Be descriptive! “You are a helpful assistant” is boring. “You are a grumpy dwarf who loves gold” is fun.
3. Restart VoxAI:
   • Close the app and open it again.
4. Test It:
   • Look at the status bar. It should be green: Twitch: Connected.
   • Type Hello in the chat box and hit Enter.
   • If the bot replies with text and audio, you are ready to stream!

If VoxAI isn't behaving as expected, check these common solutions first.

• “I see the text in chat, but I hear no voice.”
  • Go to Audio > Audio Output and ensure the correct device is selected.
  • If using a Virtual Audio Cable (VAC), ensure the cable is not muted in Windows Sound settings.
  • Exclusive Mode: Some applications (like games) take exclusive control of audio. Try disabling “Allow applications to take exclusive control” in your Windows Sound Device properties.

• “The mic isn't picking me up.”
  • Go to Audio > Mic Selection and re-select your microphone.
  • Ensure the “Mic Ready” text in the status bar turns Orange (“Listening”) when you press the Push-to-Talk key (Default: F10).

• “Overlays or Scene switching isn't working.”
  • In OBS Studio, go to Tools > WebSocket Server Settings.
  • Ensure “Enable WebSocket Server” is checked.
  • Verify the Port (Default: 4455) and Password match what is configured in VoxAI plugins.
  • Note: VoxAI requires OBS Studio version 28.0 or newer.

• “AI says 'AI_ERROR' or stops responding.”
  • Check Billing: 99% of the time, this means your OpenAI or Gemini trial credits have expired, or a payment method is needed.
  • Check Internet: A momentary drop in internet will cause the AI request to fail.
  • Check Log: Go to About > Log Console to see the specific error message from the provider.

• “Bot is ignoring specific events (Ads / Gigantify).”
  • Scope Update Required: If you recently updated VoxAI, you MUST run twitch_setup.exe again.
  • We added new permissions (Scopes) for Ads and Power-ups. Running the setup tool authorizes these new features.

• “Twitch Status says 'Disconnected' in Red.”
  • Your login token may have expired. Close VoxAI, run twitch_setup.exe, authorize the app again, and relaunch VoxAI.
• “Key/Region Invalid” (Azure)
  • Double-check you copied the Region exactly (e.g., eastus, not East US) and that there are no spaces.