Skip to content

Commit

Permalink
#21: Finished documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
OOPMan committed Jul 19, 2021
1 parent 9113337 commit 2f99b00
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 28 deletions.
3 changes: 3 additions & 0 deletions XBOFS.win.sln
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "first_run_guide", "first_ru
docs\images\first_run_guide\xbofs.win_first_run_10.png = docs\images\first_run_guide\xbofs.win_first_run_10.png
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NewFolder1", "NewFolder1", "{8BA096C6-9C97-4F6A-9992-B86389957D59}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug_DLL|Win32 = Debug_DLL|Win32
Expand Down Expand Up @@ -625,6 +627,7 @@ Global
{7640D5E7-A64B-4111-BD77-67D06CB2F1E9} = {ADD10A5F-41E1-4F1C-869D-FBBDECA4574A}
{4105BE91-8ADE-431F-BB64-A71048CF301C} = {ADD10A5F-41E1-4F1C-869D-FBBDECA4574A}
{22E13D1D-2BBC-4588-98FF-8A4B62DB5922} = {ADD10A5F-41E1-4F1C-869D-FBBDECA4574A}
{8BA096C6-9C97-4F6A-9992-B86389957D59} = {B758C57A-D285-4991-96CF-8B166A4FE290}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {B5964061-63A6-4D2B-9142-462BCF9B6748}
Expand Down
2 changes: 1 addition & 1 deletion docs/application_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Let's start with the Main tab...

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 logon to Windows
3. This checkbox controls whether the application is started automatically when you login 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
Expand Down
11 changes: 9 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ through a lot of hoops. The problemn ended up being solvable and here we are. Mo
## 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...

## How do I uninstall the WinUSB Device Driver(s)
## How do I uninstall the WinUSB Device Driver(s)?
01. Hit *Win* \+ *R*
02. Enter *devmgmt.msc* in the Run box and press enter
03. Click *View* and then click *Show hidden devices*
04. Locate the item in the tree labelled *Universal Serial Bus devices*
05. Right-click the item associated with your **XBO Fight Stick** and click *Uninstall device*
06. In the dialog box, mark the checkbox labelled *Delete the driver software for this device*
07. Click *Uninstall*
08. Replug your supported controller. It will now use whichever driver was previously configured for it
09. If prompted by Windows to restart, do so
08. Replug your **XBO Fight Stick**. It will now use whichever driver was previously configured for it

## How do I uninstall **XBOFS.win**?
01. Open *Windows Settings*
02. Click the *Apps* item
03. Locate the **XBOFS.win** item in the *Apps & Features* list
04. Click the **XBOFS.win** item
05. Click the *Uninstall* button
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 21 additions & 7 deletions docs/installation_guide.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,39 @@
# Installation and First-Run Guide

## Installation
#### Note for existing users
If you are an existing user running a version of the application that predates the installer the following process
is recommended before proceeding:

01. Open **XBOFS.win** and disable the autostart feature, if it is enabled
02. Exit **XBOFS.win**
03. Delete the existing installation
04. Proceed to step 4 of the [Installation](#installation) instructions

You **do not** need to remove the existing **VigEmBus** or **WinUSB Driver** installations

## Installation
This guide will lead you through the process of installaing VigEmBus and XBOFS.win

01. Browse to [https://github.com/ViGEm/ViGEmBus/releases/latest](https://github.com/ViGEm/ViGEmBus/releases/latest) and download the
01. Download and install the Visual C++ 2015-2019 runtimes:

* [https://aka.ms/vs/16/release/vc_redist.x86.exe](https://aka.ms/vs/16/release/vc_redist.x86.exe)
* [https://aka.ms/vs/16/release/vc_redist.x64.exe](https://aka.ms/vs/16/release/vc_redist.x64.exe)

02. Browse to [https://github.com/ViGEm/ViGEmBus/releases/latest](https://github.com/ViGEm/ViGEmBus/releases/latest) and download the
latest **VigEmBus** installer
![](images/installation_guide/vigembus_download_01.png)
![](images/installation_guide/vigembus_download_02.png)

02. Run the **VigEmBus** installer application. The installer will request Administrative permissions in order to install the
03. Run the **VigEmBus** installer application. The installer will request Administrative permissions in order to install the
**VigEmBus** framework that is used by **XBOFS.win**
![](images/installation_guide/vigembus_install_01.png)
![](images/installation_guide/vigembus_install_02.png)

03. Browse to [https://github.com/OOPMan/XBOFS.win/releases/latest](https://github.com/OOPMan/XBOFS.win/releases/latest) and download
04. Browse to [https://github.com/OOPMan/XBOFS.win/releases/latest](https://github.com/OOPMan/XBOFS.win/releases/latest) and download
latest **XBOFS.win** installer
![](images/installation_guide/xbofs.win_download_01.png)

04. Run the **XBOFS.win** installer application to install the **XBOFS.win** application
05. Run the **XBOFS.win** installer application to install the **XBOFS.win** application
![](images/installation_guide/xbofs.win_install_01.png)
![](images/installation_guide/xbofs.win_install_02.png)
![](images/installation_guide/xbofs.win_install_03.png)
Expand All @@ -28,7 +43,6 @@ This guide will lead you through the process of installaing VigEmBus and XBOFS.w
![](images/installation_guide/xbofs.win_install_07.png)

## First Run

01. Run the **XBOFS.win** application and launch the **Driver Manager** using the highlighted link
![](images/first_run_guide/xbofs.win_first_run_01.png)

Expand All @@ -49,7 +63,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 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
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
Sticks you only need to install the WinUSB driver once per device manufacturer
![](images/first_run_guide/xbofs.win_first_run_06.png)
Expand Down
62 changes: 44 additions & 18 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,69 @@
# Troubleshooting

##### I extracted **XBOFS.win.zip** but can't find **XBOFS.win.qt5.exe**
You may have accidentally download the source code. If the contents of the zip file look like this:
## When I run the **XBOFS.win** installer I get an error about missing DLLs!
![](images/troubleshooting/missing_msvcp140.dll.png)
![](images/troubleshooting/missing_vcruntime140.dll.png)
Before running the **XBOFS.win** installer you need to install both the 32-bit *and* 64-bit Visual C++ 2015-2019 runtimes. These runtimes
can be downloaded from [https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0).

![Source Code](images/wrong_zip.jpg)
then you have downloaded the source code by mistake. Head back to step 3 of the [installation guide](#installation) and make sure the download the file **XBOFS.win.zip**.
Do not download **Source Code (zip)** or **Source Code (tar.gz)**, these do not contain the application.
Direct links to the installers are below:
* [https://aka.ms/vs/16/release/vc_redist.x86.exe](https://aka.ms/vs/16/release/vc_redist.x86.exe)
* [https://aka.ms/vs/16/release/vc_redist.x64.exe](https://aka.ms/vs/16/release/vc_redist.x64.exe)

##### XBOFS.win doesn't seem to be able to detect my controller
This usually indicates an issue with the **WinUSB** driver installation. Please check the [ZaDig WinUSB driver installation guide](/zadig.md) and confirm
that when you plug in your controller, **Device Manager** updates to a state as displayed (controller name may differ):
You may be wondering why both the 32-bit and 64-bit versions are required. While **XBOFS.win** is a 64-bit application, the installer
generated by the **Qt Installer Framework** is a 32-bit application.

![Device Manager](images/winusb_device_manager.jpg)
If this does not happen then you should follow the guide from step 1 to see if it fixes the problem. If your problem is still not fixed then please [submit an issue](https://github.com/OOPMan/XBOFS.win/issues)
## When I run **XBOFS.win** I get an error about missing DLLs!
The solution to this error is described above.

##### XBOFS.win doesn't seem to be able to create a virtual XB360 Controller
## XBOFS.win doesn't detect XBO Fight Stick
This usually indicates an issue with the **WinUSB** driver installation. Check the [installation guide](/installation_guide.md)
and follow the instructions with regards to the **Driver Manager**.

If for some reason the **Driver Manager** is unable to install the **WinUSB** driver then you can try the [ZaDig WinUSB driver installation guide](/zadig.md).

## XBOFS.win doesn't seem to be able to create a Virtual XBox 360 Controller
This usually indicates an issue with the **VigEmBus** driver installation. Please confirm that the **Virtual Gamepad Emulation Bus** item appears in **Device Manager**
under the **System Devices** node:

![Device Manager](images/vigembus_device_manager.jpg)
If this item is missing you have not installed **VigEmBus**. Check the [installation guide](#installation) for details on how to do so. If your problem is still not fixed then please [submit an issue](https://github.com/OOPMan/XBOFS.win/issues)
If this item is missing you have not installed **VigEmBus**. Check the [installation guide](/installation_guide.md) for details on how to do so.

##### When I press buttons on my controller Windows acts like I am hitting keyboard keys or clicking the mouses
## When I press buttons on my controller Windows acts like I am hitting keyboard keys or clicking the mouse buttons
This problem occurs when **XBox Configuration Support** is enabled in **Steam**:
1. Open **Steam**
2. Click *Steam* -> *Settings*
3. Click *Controller* -> *General Controller Settings*
4. Uncheck *Xbox Configuration Support*
5. Click *Back*
The controller should now work as expected. If not, please [submit an issue](https://github.com/OOPMan/XBOFS.win/issues)

##### I upgraded to a new version of XBOFS.win and now RetroArch isn't recognising my controllers
The controller should now work as expected.

## I upgraded to a new version of XBOFS.win and now RetroArch isn't recognising my controllers
This issue occurs if you were running the previous version, exited, upgraded to a new version, started the new version and then started **RetroArch**.
In order to solve this issue you should reboot after upgrading **XBOFS.win**. If this does not fix the issue, please [submit an issue](https://github.com/OOPMan/XBOFS.win/issues)
In order to solve this issue you should reboot after upgrading **XBOFS.win**.

## Windows Security flags **XBOFS.win** as *Behavior:Win32/Persistence* and deletes parts of the application!
This error has been observed when configuring **XBOFS.win** to start automatically when logging in to Windows, usually when you have it installed
to a location outside our user directory. This seems to result from **Windows Security** being overly cautious with regards to the behaviour of
the application. In order to solve this problem you will need to do the following:
1. Open the *Windows Settings* screen
2. Click the *Update & Security* item
3. Click the *Windows Security* item
4. Click the *Open Windows Security* button
5. Click the *Virus & threat protection* item
6. Click the *Protection History* item
7. Locate the *Threat Quarantined* item(s) in the *Protection History* list that correspond to **XBOFS.win**. This can be done by checking the
timestamp listed and correlating it with your enabling of the autostart feature. Confirm the item(s) by clicking on the item and then checking
the *Affected Items* list for files that related to **XBOFS.win**
8. For each item that has been created for **XBOFS.win** you will need to click the *Actions* drop-down button and select the *Restore* item
9. In the event that the above actions do not restore the **XBOFS.win** application, use the *Add or Remove programs* interface from
*Windows Settings* to uninstall **XBOFS.win** and then reinstall the application to the default suggested path

##### My problem isn't listed here
## My problem isn't listed here
Please do one of the following:
1. [Submit an issue](https://github.com/OOPMan/XBOFS.win/issues) on GitHub
2. [Message](https://www.reddit.com/message/compose/?to=OOPManZA) me on Reddit
3. Join the XBOFS.win [subreddit](https://www.reddit.com/r/XBOFS/) and post a question
3. Join the **XBOFS.win** [subreddit](https://www.reddit.com/r/XBOFS/) and post a question
4. Join the [Nefarius Software Solutions](https://discord.vigem.org/) Discord server and ping **@OOPMan**

0 comments on commit 2f99b00

Please sign in to comment.