Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
voiceattack [2020/09/20 10:49] expertsonlinevoiceattack [2022/11/06 17:30] (current) – [Voice Attack and Deepbot] Addjusted Main Title To Reflect That This Is An Integration dante557
Line 1: Line 1:
-====== Voice Attack and Deepbot ======+===== Voice Attack Integration =====
  
-  * [[voiceattack#Overview|Overview]] +===== Overview =====
-  * [[voiceattack#Setup|Setup]]+
  
-----+This guide is with regards to a piece of software called [[https://www.voiceattack.com/|VoiceAttack]] which allows various actions and commands can be executed via your own voice or hotkeys. VoiceAttack itself is a paid product which costs $10 for a lifetime licence. It does, however, have 21-day free trial.
  
-==== Overview ====+The integration enabled via a plugin that is added to VoiceAttack allows a number of interesting possibilities for occur with your game (i.e. VoiceAttack sending mouse movements and key presses) when chat execute a command, trigger a Twitch channel point command as well as other user actions like subscriptions, follows and cheer messages.  
 + 
 +Please let us know what you think and feel free to share how you would use this feature on our [[https://discord.deepbot.tv/|Discord!]]. Examples may end up in the guide to give our users ideas of how best to make use of this integration. 
 + 
 +**Note:** This guide is meant for VoiceAttack **ONLY**. This is due to a plugin being available which directly communicates with Deepbot. There are other combinations of software that can achieve the same effect (without voice commands) should you wish to look into those options instead (I.e. Directory Monitor and AutoHotkey)
  
 ---- ----
  
-This guide will show you how to use [[http://www.voiceattack.com/|VoiceAttack]] with Deepbot to run commands by voice or hotkeys! VoiceAttack offers a 21-day free trial and it costs $10 to buy a registration key to use the software forever.+===== Setup ===== 
 +==== Installing And Setting Up The DeepBot VoiceAttack Plugin ====
  
-This guide is meant for VoiceAttack onlybut there are other programs that can do the same thing.+This integration requires a plugin to be downloaded and enabled within VoiceAttack. The plugin in question can be found and downloaded [[https://deepbot.tv/download/VADeepBotPlugin_1.0.0.zip|here]] 
 + 
 +  - Ensure that the option "Enable Plugin Support" is enabled within the VoiceAttack settings. If not, tick the option then close VoiceAttack. \\ {{::voiceattack_plugin_option.png?nolink&400|}} 
 +  - With the downloaded ZIP file, select "Extract All..." then navigate to the "Apps" folder where VoiceAttack is installed (Default location for this, assuming this is on the C drive, is C:\Program Files (x86)\VoiceAttack\Apps) 
 +  - Open VoiceAttack. If successfulyou should receive a prompt regarding inputting your Deepbot IP and Secret into the plugin's config file. This should also state the location of this particular config file. Your Deepbot secret can be found in the Deepbot Master Settings.\\ {{::voiceattack_config_message.png?nolink&600|}} 
 +  - Once the information has been entered into the config file, restart VoiceAttack. 
 +  - If the process was successful it should state that you have successfully connected to Deepbot.\\ {{::voiceattack_plugin_enabled_deepbot.png?nolink&600|}}
  
 ---- ----
  
-==== Setup ==== +==== Running a VoiceAttack Command From Deepbot ==== 
-=== Using the DeepBot Voice Attack Plugin ===+In your custom command edit screen ensure that the message box contains the following variable <code>@customwebmsg@[va|VoiceAttackCommand]</code>
 +Replace VoiceAttackCommand with the name of the command that you have set in VoiceAttack.
  
 +----
  
-As of version 0.11.5.7, we now have dedicated voice attack plugin that allows for communication between Voice Attack and DeepBot. +==== Running Deepbot Command From VoiceAttack ==== 
-To install, do the following: +To run a DeepBot command from VoiceAttack 
-  - Get the plugin from http://deepbot.tv/download/VADeepBotPlugin_1.0.0.zip +  - Click on the pencil icon in VoiceAttack\\ {{::voiceattack_pencil_icon.png?nolink&600|}} 
-  - Extract that in the Apps folder of your Voice Attack install directory as folder +  - In the "Edit Profile" click "New Command" 
-  - Then run voice attack and ensure plugins are enabled. It should tell you to put your DeepBot IP and secret (found in your DeepBot master settings) in a config file. +  - In the "Add A Command" windowon the left hand sideselect Other > Advanced > Execute An External Plugin
-  - Once donerestart Voice Attack and it should say Connected to DeepBot. +  - In the plugin dropdown box select Deepbot VoiceAttack Plugin and in the plugin context text box type **Run** followed by the command you wish to execute. I.e. <code>Run !testadd</code>\\ {{:va_plugin.png?nolink&600|}} 
-  - To run a Voice Attack command you can use @customwebmsg@[va|SayWorking] this will run the Voice Attack command SayWorking +  - To test your command is working - right click the command in the "Edit A Profile" screen from earlier and select **Execute**
-  - To run a DeepBot command from Voice Attackcreate a new command and under Other > Advanced > Execute an External Plugin Function, select the Deepbot plugin and under context type Run followed by the command. e.g. Run !add 50 all +
-      {{ :va_plugin.png?nolink&400 |}} +
- +
-With this integration, it opens up a number of interesting possibilities of allowing chat to interact with your PC/game through (through VA sending mouse movements and key presses) via. messages, twitch points and bits, tips. Please let us know what you think and feel free to share how you would use this feature on our Discord!+
  
 ---- ----
  
-=== Using the Generic DeepBot Command Line Interface ===+===== OLD METHOD - Using the Generic DeepBot Command Line Interface (CommandCLI.exe) =====
  
-If you are on a previous version, you can use the CommandCLI to achieve this as well+Aside from the VoiceAttack direct plugin you can use CommandCLI.exe to achieve the above
-To use that approach, please see steps below:+As a bonus using the old method will allow Deepbot to communicate with other software that allows exe files to be run with parameters.
  
-**1.** Grabbing your unique API key from Deepbot.  +==== Setting Up CommandCLI.exe ====
-  * **A.** With Deepbot open, go to the Config tab. +
-  * **B.** Click on Master Settings (located near the top right). +
-  * **C.** On the General tab, scroll down to API Secret. +
-  * **D.** Copy your API key. (//Note: All API keys are different.//)+
  
-----+  Within Deepbot, click on the "Master Settings" option that can be found on the Config tab. 
 +  Scroll down until you see the API Secret text box. 
 +  Copy the API key that is present in this box (**Note:** All API keys are unique) 
 +  In the folder where Deepbot is installed, locate **CommandCLI.exe.config**, right click the file then select "Open With..." 
 +  - Select Notepad from the box that appears 
 +  - Paste the API key that was copied in step 3 in place of the text that mentions "**Enter API Key here!**"
  
-**2.** Setting up CommandCLI.exe.config. (It is usually located in C:\DeepBot - Twitch Streamer Assistant)  +If you are using a dual-PC setup for streaming 
-  * **A.** Find CommandCLI.exe.config. It should be a config/text file. +  - Copy the IP address of the PC with Deepbot installed and paste it above the API Key, where it says "127.0.0.1"
-  * **B.** Right-click the config file and choose "Open with". Select Notepad from the list of programs. +  - Create a copy of both **CommandCLI.exe** and **CommandCLI.exe.config** and move these copies to the streaming PC with VoiceAttack on it.
-  * **C.** Paste your API key where it says "Enter API Key here!" +
-**//OPTIONAL://** +
-  * **D.** If you have a dual-PC setup for streaming, copy the IP address of the PC with Deepbot installed and paste it above the API Key, where it says "127.0.0.1"+
-    * You will need to copy CommandCLI.exe and CommandCLI.exe.config over to your streaming PC with VoiceAttack on it.+
  
 ---- ----
- +==== Adding A Command In VoiceAttack To Execute Through CommandCLI.exe ==== 
-**3.** Configuring VoiceAttack with Deepbot for the first time+  - Click on the pencil icon in VoiceAttack\\ {{::voiceattack_pencil_icon.png?nolink&600|}} 
-  * **A.** When you first launch VoiceAttackyou will want to do voice recognition on your computer so that your computer learns your voice. This may take about 5-15 minutes and can be done by going to Control Panel Ease of Access Speech Recognition+  - In the "Edit a Profile" click "New Command" 
-  * **B.** Once VoiceAttack is open, click on the person with a pencil over them, above My Profile, then add command. +  - In the "Add Command" window, on the left hand side, select Other Windows Run An Application
-**//OPTIONAL://** +  - Click on the "..." button then browse to the location of **CommandCLI.exe** on your PCThis is typically located at **C:\DeepBot - Twitch Streamer Assistant\CommandCLI.exe** 
-  * **C.** It is highly recommended to set up a "Start/Stop Listening" command so that you don't run other commands by accident. +  - Type the Deepbot command that you wish to execute in the **With these parameters** text box
-    Click "New Command"+  - To test your command is working - right click the command in the "Edit A Profilescreen from earlier and select **Execute**
-    When you say "Listen", VoiceAttack will start listening to anything you say.  +
-    * Click the "Otherbox (located about halfway down) > "VoiceAttack Action" > "Make VoiceAttack Start Listening"+
-    Repeat this process for "Make VoiceAttack Stop Listening".+
  
 ---- ----
  
-**4.** Setting up a command. +===== Useful Information ===== 
-  * **A.** Select "New Command".  +  - It is recommended to "train" the VoiceAttack voice detection engine to better understand your voiceYou can do this by going to **Control Panel > Ease of Access Speech Recognition**. This process can take anywhere between 5 to 15 minutes but the more you train the speech recognition engine the better results you will receive.  
-  * **B.** Type "Run Arenain the "When I Say" box +  - It is highly recommended to set up a "Start/Stop ListeningcommandThis is especially important when you don't want to accidentally trigger a command 
-  * **C.** Click the box labeled "Other" about halfway down. +      To make the command stop listening - Other > VoiceAttack Action > Stop Listening 
-  * **D.** Hover over "Windows" "Run an Application" +      To make the command start listening - Other > VoiceAttack Action > Start Listening
-  * **E.** Click the "..." button. Browse and find "CommandCLI.exe" (C:\DeepBot - Twitch Streamer Assistant\CommandCLI.exe).  +
-  * **F.** Type the Deepbot command you wish to add into the box labeled "With these parameters".  +
-  * **G.** Click "OK".  +
-  **H.** Click "Done" from the command list box. +
-  **I.** Test the command!+