diff --git a/docs/application_guide.md b/docs/application_guide.md index 423ff58..2bd41fa 100644 --- a/docs/application_guide.md +++ b/docs/application_guide.md @@ -7,8 +7,8 @@ Let's start with the Main tab... ![](images/application_guide/main_tab.png) 1. The *Info* area displays basic information about the application along with some clickable links -2. The *Status* area displays information pertaining to the XBOFS.win WinUSB driver and Device Manager as well as VigEmBus -3. This checkbox controls whether the application is started automatically when you login to Windows +2. The *Status* area displays information pertaining to the **XBOFS.win WinUSB Driver** and Device Manager as well as **VigEmBus** +3. This checkbox controls whether the application is started automatically when you log in to Windows 4. This checkbox determines whether the application minimizes to the taskbar or the system tray 5. This checkbox determines whether the application will check for updates on start-up. In order for this functionality to work the [Win64 OpenSSL Light](http://slproweb.com/products/Win32OpenSSL.html) distribution needs to be installed diff --git a/docs/binding_buide.md b/docs/binding_buide.md index 7a809b9..4f7eca7 100644 --- a/docs/binding_buide.md +++ b/docs/binding_buide.md @@ -11,7 +11,7 @@ always be loaded for that device. The Control Binding system also introduces the concept of alternate bindings. Simply put, this enables you to configure two different bindings for a given control on your **XBO Fight Stick**. Access to the alternate binding for a given control is provided by the -**XBox Guide Button** which has been repurposed to function as a modifer button, similar to the *Shift* key on your keyboard. +**XBox Guide Button** which has been repurposed to function as a modifier button, similar to the *Shift* key on your keyboard. The utility of the Control Binding system may not immediately obvious but once you consider that whereas a **XBO Fight Stick** provides 15 unique inputs (11 buttons and 4 directions) the **Virtual XBox 360 Controller** has many more (2 analog thumbsticks, 2 analog triggers, @@ -25,7 +25,7 @@ in v1.0.0 of **XBOFS.win** there is no impact terms of performance when using th Without further ado, let's explore! ## First Steps -In order to enable the Control Binding sytem for your **XBO Fight Stick** the *Binding* checkbox needs to be enabled in the *Device tab* +In order to enable the Control Binding system for your **XBO Fight Stick** the *Binding* checkbox needs to be enabled in the *Device tab* for your **XBO Fight Stick** and a Profile needs to be added. ![](images/binding_guide/binding_enabled_no_profile.png) @@ -34,7 +34,7 @@ for your **XBO Fight Stick** and a Profile needs to be added. 2. The *Add Profile* button Clicking the Add Profile button will present a dialog allowing you to enter a name for the Profile. The name of your profile must not -exceed 256 characterd, it it does the trailing characters will be removed. +exceed 256 characters, if it does the trailing characters will be removed. ![](images/binding_guide/add_profile.png) @@ -117,7 +117,7 @@ When *Bind* is checked the remaining controls in the dialog become enabled: ![](images/binding_guide/configure_binding_dialog_02.png) 1. The *D-Pad* section handles the binding of D-Pad directional inputs -2. The *Buttons* section handles the binding of the the large majority of the other button-style inputs, including the +2. The *Buttons* section handles the binding of the large majority of the other button-style inputs, including the Guide Button 3. The *Left Analog Stick* section handles binding of the X and Y axis of the left thumbstick as well as the left thumbstick button input @@ -129,18 +129,18 @@ When *Bind* is checked the remaining controls in the dialog become enabled: * The minimum value for a given axis is -32768 * For the X-axis this corresponds to the left-most position of the thunmbstick - * For the Y-axis this corresponnds to the bottom-most position of the thumbstick + * For the Y-axis this corresponds to the bottom-most position of the thumbstick * The maximum value for a given axis is 32767 * For the X-axis this corresponds to the right-most position of the thumbstick - * The the Y-axis this corresponds to the upper-most position of the thumbstick + * For the Y-axis this corresponds to the upper-most position of the thumbstick * The spinner controls on the inputs increment/decrement the value in steps of 8192 ##### Notes on the Triggers and Bumpers section * The minimum trigger strength value is 0, which corresponds to the trigger being free -* The maximum trigger streingth value is 255, which corresponds to the trigger beind held completely +* The maximum trigger strength value is 255, which corresponds to the trigger being held completely * The spinner controls on the inputs increment/decrement the value in steps of 255 ## Sample Configurations @@ -174,8 +174,8 @@ overriding other bindings which annoyed me a lot. * RB is set to Right Analog stick X-axis -32768 * LB is set to Right Analog stick X-axis 32767 -The purpose of this configuraiton is to allow the Fight Stick to be used to navigate in the Krypt -mode. The Kyrpt mode uses the Left Analog Stick for movement while the Right Analog Stick contols the +The purpose of this configuration is to allow the Fight Stick to be used to navigate in the Krypt +mode. The Kyrpt mode uses the Left Analog Stick for movement while the Right Analog Stick controls the camera. Looking up and down is not that important but being able to rotate the view left and right is. This configuration allows you to switch to the Alternate bindings and navigate the game world in the Krypt mode without needing to plug in a normal game controller. When you want to play the rest of the diff --git a/docs/device_contributor_guide.md b/docs/device_contributor_guide.md index 9c5de56..3ac6d05 100644 --- a/docs/device_contributor_guide.md +++ b/docs/device_contributor_guide.md @@ -1,6 +1,6 @@ # Device Contributor Guide -This document aims to provide users of unsuppored XBO fight stick controllers with the tools and knowledge they need to assist in the +This document aims to provide users of unsupported XBO fight sticks with the tools and knowledge they need to assist in the process of adding support for new devices @@ -26,7 +26,7 @@ process of adding support for new devices ## Preparation Before you can start capturing data for your device it is necessary to ensure it is not configured to use the XBO Controller beta drivers -from 2014. If these drivers are active for your device then Device Montioring Studio will be unable to see the controller. +from 2014. If these drivers are active for your device then Device Monitoring Studio will be unable to see the controller. ##### In order to determine whether you are using the beta drivers 01. Press *Win* + *R* to open the *Run* dialog @@ -98,7 +98,7 @@ from 2014. If these drivers are active for your device then Device Montioring St ## Data Capture -01. Plug in your controller. It is also recommended to unplug any other controllers +01. Plug in your **XBO Fight Stick**. It is also recommended to unplug any other controllers 02. Confirm the controller is detected correctly using *Device Manager* ![](images/device_contributor_guide/data_capture/01.jpg) @@ -184,7 +184,7 @@ from 2014. If these drivers are active for your device then Device Montioring St are not sure whether you pressed diagonally, try again and check the data in the *Complete* tab 29. Once you have collected data on all the buttons and stick directions you can close *Device Monitoring Studio* and make sure your data capture text file is - saved. Not that you **DO NOT** need to capture diagonal directions on the stick or any buttom press combinations (E.g. *X* and *Y* together). All that is + saved. Not that you **DO NOT** need to capture diagonal directions on the stick or any button press combinations (E.g. *X* and *Y* together). All that is required are the single button/direction values diff --git a/docs/faq.md b/docs/faq.md index 587c0a7..6a1b184 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,7 +2,7 @@ ## Why did you develop this piece of software? Long story short, I bought a Razer Atrox on special and rather than return it I decided to see if I could work out why it didn't work without jumping -through a lot of hoops. The problemn ended up being solvable and here we are. More details can be found [here](https://forums.vigem.org/topic/282/xbo-arcade-sticks-vigem-and-a-whole-ton-of-fun/) +through a lot of hoops. The problem ended up being solvable and here we are. More details can be found [here](https://forums.vigem.org/topic/282/xbo-arcade-sticks-vigem-and-a-whole-ton-of-fun/) ## Can you support my device? It's very likely. Take a look at the [device contributor guide](/device_contributor_guide.md) to see how you can collect the data I need to do so... diff --git a/docs/index.md b/docs/index.md index f81866f..782af1b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,9 +6,9 @@ The application achieves this by communicating directly with your **XBO Fight St forwarding the input data from the controls to a **Virtual XBox 360 Controller** provided by **VigEmBus**. From the perspective of games and other software, the **Virtual XBox 360 Controller** is identical to a real controller and -**XBOFS.win** is thus able to achieve maximum compatiblity with minimum overhead. +**XBOFS.win** is thus able to achieve maximum compatibility with minimum overhead. -## Supported Fight Sticks +## Supported XBO Fight Sticks * Razer Atrox XBO * Madcatz TE2 XBO @@ -28,7 +28,7 @@ From the perspective of games and other software, the **Virtual XBox 360 Control 4. **XBOFS.win** should detect your **XBO Fight Stick(s)** and once it does you're good to go! #### Don't forget... -The **XBOFS.win** application needs to be running in order for your Controller to work so it's a good idea to set it to start +The **XBOFS.win** application needs to be running in order for your Controller to work, so it's a good idea to set it to start automatically with Windows! #### Need more detail? @@ -44,7 +44,7 @@ Read the [Control Binding](/binding_guide.md) page to learn more about why you m ## Debugging Another useful feature is the debugging window. When this feature is enabled you can view application performance data and in-depth as well -as a complete summary of the data being received from your controller and sent to the virtual XB360 controller. +as a complete summary of the data received from your **XBO Fight Stick** and sent to the **Virtual XBox 360 Controller**. Read the [Debugging](/debugging_guide.md) page to learn more about this feature. diff --git a/docs/installation_guide.md b/docs/installation_guide.md index ea2dc42..e58f257 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -64,7 +64,7 @@ This guide will lead you through the process of installaing VigEmBus and XBOFS.w 06. Once the progress dialog has disappeared the *Diagnostics* area of the **Driver Manager** will update. A result of code of 0 or -13 are both indicative of success. Other results may indicate an issue. You can now close the **Driver Manager** or, if you have another supported **XBO Fight Stick** of a different make (I.e. You own both a Razer Atrox XBO *and* a Madcatz TE2 XBO), return to step 3 and - repeat the WinUSB driver installation proccess for the other Fight Stick. If you have multiple Razer Atrox XBO *or* Madcatz TE2 XBO Fight + repeat the WinUSB driver installation process for the other Fight Stick. If you have multiple Razer Atrox XBO *or* Madcatz TE2 XBO Fight Sticks you only need to install the WinUSB driver once per device manufacturer ![](images/first_run_guide/xbofs.win_first_run_06.png)