Skip to content

Quickstart Guide

VRCWizard edited this page Apr 17, 2024 · 122 revisions

🔑 Unlock VoiceWizardPro Benefits!

Subscribe to Ko-Fi or Patreon and experience a world of powerful features that will transform your TTS and translation experience:

  • Instant Access to Premium Voices: Enjoy hundreds of voices from leading cloud services, including:

    • Microsoft Azure
    • Amazon Polly
    • Google Cloud
    • IBM Watson
  • 🌍 Multilingual Magic: Translate your voices into 70+ supported languages, talk to your friends from all over the world

  • 🎤 Crystal-Clear Transcriptions: Gain access to speech recognition through DeepGram's Nova-2 model, the fastest and most accurate speech-to-text API.

Your subscription not only enhances your capabilities but also supports future development:

  • 💪 Empower Ongoing Development: Your contribution assists in server upkeep, covers character costs from premium APIs, and fuels future software innovations.

Ready to elevate your TTS game? Dive into VoiceWizardPro now! For detailed insights, explore our VoiceWizardPro GitHub Wiki page.

Unlock the power of VoiceWizardPro today! 🚀

Ko-Fi Ko-Fi

Patreon

GitHub Wiki Table of Contents

Quick Start Guide

Additional Guides

Getting Started Video

The Tutorial Video will run you through the essentials of the guide.

Getting Started with TTS Voice Wizard

Installation

  1. Download the latest version here:
  2. Unzip/extract the files
  3. Run the .exe file

  1. It may ask you to install the missing framework for .Net upon running the .exe file


(as of update 1.0.8.9 aspnetcore-runtime is no longer a dependency for the main app)

Speech-to-Text and Text-to-Speech

  • Convert Speech to Text to send through OSC (to VRChat or anywhere else)
  • Text to Speech
  • Do Speech to Text which is then converted to Text to Speech

🔌 Playing Audio Through Your Microphone

  1. First, you will need to download and set up a virtual cable
  2. You will then need to change TTS Voice Wizard's output device to the virtual cable allowing you to play the System Speech TTS through your microphone.
  3. Consequently your microphone in other application like VRChat, Discord, Overwatch etc. would be the Virtual Cable.

🎙️ Speech-to-Text

  • Change the speech to text method from Settings > Audio > Speech to Text

  • Each of these methods require some sort of setup (except system speech). Click the name of the Speech-to-Text method to take you to its respective wiki page for more information.
Speech-to-Text Method Description Free Pricing Continuous
System Speech This method is the default and has the worst recognition quality. Although it can improved with training and editing the speech dictionary Unlimited yes
Azure Great recognition quality without needing to sacrifice computational resources. Built in Translations 5 speech recognition hours + 5 speech translation hours. This is actually much more than it seems when not using continuous recognition. (yes you can for example translate from English to English after your recognition hours run out for 10 total hours.) both
Vosk Ok recognition quality at the cost of computational resources (CPU and RAM). Can have higher recognition quality than Web Captioner depending on model used. (does not work on x86 version) Unlimited yes
Web Captioner Ok recognition quality using "Web Speech API" through Web Captioner. Only available on Google Chrome. Multi-Language support. Unlimited yes
Whisper AMAZING recognition quality at the cost of computational resources (GPU and RAM). Can have higher recognition accuracy than Azure depending on model used. (Experimental implementation) (does not work on x86 version) Unlimited yes
DeepGram Similar quality to Azure Recognition Only available with Voice Wizard Pro, limits vary with selected tier no

🔊 Text-to-Speech

  • Change and use various TTS methods from the Text to Speech Tab

  • Some of these methods require some sort of setup. Click the name of the Text-to-Speech method to take you to its respective wiki page for more information.
Text-to-Speech Method Included with VoiceWizardPro Description Free Character Pricing Audio Sample
System Speech Included by default This option uses voices from the voice packages you have installed on your windows system. Any SAPI5 voices you install on your system should work.
- Japanese "Anime Style" Voices for SAPI5: shigobu/SAPIForVOICEVOX
- Windows XP Voices (including Microsoft Sam) for SAPI5: Get WinXP_TTS_Voice_v1.3 (file sourced from here)
Unlimited download
Azure Yes Realistic TTS Voices accessible via API 500k characters for free a month FOREVER download
Amazon Polly Yes Realistic TTS Voices accessible via API. These voices are iconically used by many TTS VTubers 5mill characters (1mill for neural voices) for free each month for the first 12 months download
Google Cloud Yes Realistic TTS Voices only accessible via VoiceWizardPro N/A download
TikTok Included by default Voices accessible for free via the TikTok API (made possible by Weilbyte's Tiktok TTS endpoint). Best option if you are looking for high fidelity TTS voices to use without limits Unlimited download
Moonbase Included by default Moonbase Alpha style voices (renamed from FonixTalk to Moonbase in update v1.0.3, no longer required x86 version of TTS Voice Wizard). Made possible by whatsecretproject/SharpTalk a C# wrapper for FonixTalk the successor to DecTalk Unlimited download
Locally Hosted No Here is an example of a project that can be used with Local: https://github.com/VRCWizard/TTS-Voice-Wizard/wiki/Glados-TTS . This method works by sending a GET request to http://127.0.0.1:8124/synthesize/ with the string parameter 'text'. If you create compatible projects or models, feel free to share them in the Discord server. Unlimited
Eleven Labs No Realistic TTS Voices accessible via API. You can also use any voices you clone in TTS Voice Wizard. 10k for free a month download
Uberduck No Extensive catalog of voices of actors from Movies, TV Shows and Cartoons as of 7/12/2023 the Uberduck's catalog of voices has been drastically cut N/A download
IBM Watson Yes Realistic TTS Voices only accessible via VoiceWizardPro N/A

🔑 VoiceWizardPro

The VoiceWizardPro API, will allow you to access Microsoft Azure, Amazon Polly, and the new Google Cloud voices without the need to create and manage multiple accounts. By choosing a tier and becoming a member on Ko-Fi, you will receive an allotted amount of TTS and Translation characters that refresh monthly. This money goes toward server upkeep costs, paying for characters from the respective APIs, and funding future software development. For more information, please visit the VoiceWizardPro GitHub Wiki page

Buy Me a Coffee at ko-fi.com

How to get Text in VRChat

Can I set hotkey on my VR controllers or mouse for Speech to Text?

  • This feature is not available as apart of this ATM but you can use this handy program!
  • Make sure TTSVoiceWizard is not running then set a button to "ctrl + g" (the default key bind)
    • Close TTS Voice Wizard before doing this, if it is running it will steal the input
  • Additionally, you can add a bool for /avatar/parameters/DoSpeechToText to your avatar to toggle speech-to-text

Spotify / Windows Media Integration for VRChat

This Tutorial Video will show you how to display your 'Now Playing Song' in VRChat. How to display your 'Now Playing Song' in VRChat

OBS Text for Streaming and Recording Videos

  • Turn on OBS Text in the settings tab of TTS Voice Wizard

image

  • Go to OBS, create a text source then tick "Read from file" then select "Output/TextOutput/OBSText.txt" located in the TTS Voice Wizard download folder.
    • Note that this feature will not work if you disable outputting transcript to log