From ad15594d8c1bd539350e480cb2d417eb7ee5ddd0 Mon Sep 17 00:00:00 2001
From: AtomFry <59396830+AtomFry@users.noreply.github.com>
Date: Wed, 29 Dec 2021 23:10:19 -0600
Subject: [PATCH] Create README.md
---
README.md | 430 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 430 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..253cc25
--- /dev/null
+++ b/README.md
@@ -0,0 +1,430 @@
+# BigBoxVoiceSearch
+BigBoxVoiceSearch is a plug-in for BigBox that enables searching via speech recognition. Because this plug-in is a BigBox theme element, to make use of it, you must install the plug-in components as well as add a few lines of XAML to the views of the theme that you wish to use this plug-in with.
+
+## Installation
+1. Download BigBoxVoiceSearch.zip from the LaunchBox forums or from this github repositories Releases
+2. Extract BigBoxVoiceSearch.zip to a folder. Inside the BigBoxVoiceSearch folder is a folder called LaunchBox. Inside the LaunchBox folder is a folder called Plugins. Copy the plugins folder
+3. Go to your LaunchBox installation folder and paste the copied folder
+4. To verify the installation - confirm the following files exist in your LaunchBox\Plugins folder
+ - BigBoxVoiceSearch.dll
+ - System.Speech.dll
+ - WpfAnimatedGif.dll
+5. You can delete the downloaded zip file and extracted folder
+
+## Adding the voice search element to a theme
+In order to use the voice recognition function, a few lines of XAML must be added to whatever theme views you would like to use this with. Since it's easy to make simple mistakes while tinkering with XAML, it's strongly recommended to make a copy of whatever theme you plan to use this with and make your changes to a copy of the theme so that you can revert to the original theme if mistakes are made.
+
+### XMLNS
+Add the following line to the user control element at the top of the view. This tells the theme that we want to use the voice search user control somewhere in our theme.
+```xaml
+xmlns:BigBoxVoiceSearch="clr-namespace:BigBoxVoiceSearch.View;assembly=BigBoxVoiceSearch"
+```
+
+### Voice Search User Control inside a canvas named "Canvas"
+Most themes have a root Canvas element named "Canvas" so the following chunk can be added to the bottom of the theme view just inside the closing canvas tag. This assumes there is a canvas element named "Canvas":
+
+```xaml
+
+
+```
+
+### Voice Search User Control inside a grid
+Some themes have a root grid element instead of a canvas so the following chunk can be added inside the grid element. This assumes a grid that has 5 rows.
+
+```xaml
+
+
+```
+### Example - Unified Redux PlatformWheel1FiltersView
+The following example shows the plugin added to the PlatformWheel1FilterView in the Unified Redux theme. Note the BigBoxVoiceSearch reference near the top and bottom of the theme.
+```xaml
+
+
+
+
+
+
+
+
+
+ /Unified.HyperBox;Component/Fonts/#Bebas Neue
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+```
+
+## Settings
+When BigBox loads for the first time, a settings file will be created that will allow you specify how the plugin should select a game to launch on startup. If changes to the default settings are desired, make the desired changes and restart BigBox. The default settings look like this:
+
+```json
+{
+ "SearchOnPageUp": true,
+ "SearchOnPageDown": false,
+ "VoiceSearchTimeoutInSeconds": 5
+}
+```
+### SearchOnPageUp
+Set this to true if you want to trigger the voice search function on the page up button
+
+### SearchOnPageDown
+Set this to true if you want to trigger the voice search function on the page down button
+
+### VoiceSearchTimeoutInSeconds
+Specify the number of seconds that the voice search should stay open before it stops listening
+