diff --git a/README.md b/README.md index bc70e4f..a19a7b0 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,90 @@ -HDT-Voice is a plugin for Hearthstone Deck Tracker that allows you to play -the game and navigate the menus using simple voice commands. +

What is HDT-Voice?

+HDT-Voice is a plugin for Hearthstone Deck Tracker that allows you to play the game and navigate the menus using simple voice commands. + +

Sounds good, how do I get it?

+The latest version of HDT-Voice will always be available here: +https://github.com/topher-au/HDT-Voice/releases + +Since HDT-Voice is a plugin for Hearthstone Deck Tracker, you'll also need to download and configure it before you are able to use HDT-Voice. Hearthstone Deck Tracker is available from: https://github.com/Epix37/Hearthstone-Deck-Tracker/releases -To install, simply copy HDT-Voice.dll into your Hearthstone Deck Tracker plugins -folder, then right click and select Properties and check "Unblock" at the bottom -of the panel. - -Once you have installed the DLL file, open Hearthstone Deck Tracker and go to the -Options menu. Select Plugins, then select HDT-Voice and click "Enable". - -Click the "Configure" button to select the audio device that HDT-Voice will use -to receive voice commands (NYI: default audio device only), as well as adjust the threshold for voice recognition. - -Once you've completed the above steps, next time you load Hearthstone you should -see "HDT-Voice: Listening..." in the upper left hand corner of the window. That -means that everything has worked and you should now be able to use voice commands -in Hearthstone! - -Menu Navigation ---- -

Main Menu

-- Play -- Solo (NYI) -- Arena (NYI) -- Brawl (no deck editor) - -

Play Menu

-- "Basic", "Custom" and "Deck 1-9" to select deck -- "Casual", "Ranked" for game type -- "Start Game" to start the game -- "Cancel" to cancel the opponent finder -- "Back" to go back - -

Brawl Menu

-- "Start Brawl" to start brawl -- "Cancel" to cancel the opponent finder -- "Back" to go back - -Playing the Game ---- -You can refer to a card or minion as either "card x" or "minion x", or you -can use it's name. If there are multiple with the same name, they will be -numbered as they are ordered in the game, i.e. "Wisp 1", "Wisp 2" from left -to right. - - -

In Game Commands

-

Mulligan

-"click <card>" -"click confirm" - -

During Play

-- "focus <target>" -eg "focus my hero", "focus enemy Mana Addict", "focus enemy face" - -- "play <card>" - play a card to the right of the board -- "play <card> to <target>" - play a card to the specified target location -e.g. "play 3", "play Pyroblast to opponent face" - -- "attack <enemy> with <friendly>" -e.g. "attack face with huffer" or "attack minion 1 with hero" -NOTE: you do not need to specify who each minion belongs to - -- "say <emote>" -thanks, well played, greetings, sorry, oops, threaten - -- "choose option <x> of <y>" +

OK, I got the download, now what?

+ +To install, simply copy HDT-Voice.dll into your Hearthstone Deck Tracker plugins folder, then right click and select Properties and check "Unblock" at the bottom of the panel. + +Once you have installed the DLL file, open Hearthstone Deck Tracker and go to the Options menu. Select Plugins, then select HDT-Voice and click "Enable". + +Click the "Configure" button to select the audio device that HDT-Voice will use to receive voice commands (NYI: default audio device only), as well as adjust the threshold for voice recognition. + +Once you've completed the above steps, next time you load Hearthstone you should see "HDT-Voice: Listening..." in the upper left hand corner of the window. That means that everything has worked and you should now be able to use voice commands in Hearthstone! + +

I've done all that, now how do I attack face?!

+Good thing you asked! The first thing you need to know is that the plugin operates in two different modes: menu mode and game mode. + +

Menu Mode

+ +From the main menu you will probably want to say... +- "Play" +- "Solo" (NYI) +- "Arena" (NYI) +- "Brawl" (no deck editor) + +If you're at the Play menu/deck selection screen, you might want to say... +- "Basic", "Custom" or"Deck 1-9" to select deck +- "Casual" or "Ranked" for game type +- "Start Game" to start the game +- "Cancel" to cancel the opponent finder +- "Back" to go back + +Or maybe the plugin thought you said "brawl", in which case say... +- "Start Brawl" to start brawl +- "Cancel" to cancel the opponent finder +- "Back" to go back + +

Game Mode

+When referring to a card or minion, you may refer to it by it's name or by it's number. +- <card> - a card name or number ("1", "2", "Sludge Belcher", "Armorsmith 2") +- <friendly> - a friendly minion ("minion 3", "Sludge Belcher 2") +- <enemy> - an enemy minion +- <target> - a target, specify which side ("friendly minion 4", "enemy hero") + +The first thing you do when you start a game of Hearthstone is mulligan a card (or all of them). To do so, say one of the following: +- "click <card>" ("click 2", "click Dr. Boom") +- "click confirm" + +Once the game has started, you can perform a variety of commands as listed below. + +- "target <target>" ("target friendly face", "target my minion 1", "target enemy hero") + +- "play <card>" - play a card to the right of the board +- "play <card> to <friendly>" - play a minion to the left of the friendly minion specified +- "cast <card> on <target>" - play a card onto the minion specified + +- "use hero power" - use hero power +- "use hero power on <target>" - use hero power on specified minion + +- "attack <enemy> with <friendly>" ("Attack Sylvanas Windrunner with Dr. Boom") +- "<friendly> go <enemy>" ("Huffer go face") + +- "say <emote>" +thanks/thank you, well played, greetings/hello, sorry, oops, threaten + +- "choose option <x> of <y>" when presented with options (such as certain Druid cards), x is the option you want to select and y is the number of total options, up to 4. Say "click" afterwards to confirm your selection. -- "end turn" - ends your turn +- "end turn" - ends your turn + +

Synonyms!

+You can use the following synonyms: +- hero, face +- enemy, opposing, opponent +- my, friendly + +

Troubleshooting

+Please check that your default audio device is set to the microphone used for speech recognition and restart Hearthstone Deck Tracker. You may also want to adjust the threshold level in the settings window (available from within the HDT plugins panel) + +You can also enable the debug log and send it to me, it might help!