Skip to content
This repository was archived by the owner on Jan 1, 2024. It is now read-only.

Commit 563a7e8

Browse files
committed
add user-guide.md and contributing.md
1 parent 36f799f commit 563a7e8

File tree

3 files changed

+122
-124
lines changed

3 files changed

+122
-124
lines changed

README.md

Lines changed: 0 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -40,121 +40,6 @@ Note: The Website Is No Longer Working
4040

4141
The Installation and Setup Guide can be found here: https://docs.ds4windows.app/guides/install-setup/
4242

43-
## User Guide
44-
After completing the initial setup of the required drivers and dependencies, you are greeted with the main DS4Windows tab, controllers.
45-
46-
### Controllers
47-
![Controller Tab](https://user-images.githubusercontent.com/32114370/189562818-8e2d5e0a-3c61-4eb0-a53c-caa731b120e4.png)
48-
49-
Here all of the conected controllers are shown. Hovering your mouse over the Controller's ID will display the input delay of the specificed controller.
50-
51-
![Input Delay Screenshot](https://user-images.githubusercontent.com/32114370/189563985-e18c074e-3caf-49a7-af36-ed12d77f88c6.png)
52-
53-
The Link Profile/ID checkbox allows you to link a specified profile to a certain Controller ID so that when you plug in the controller next time the Selected Profile will always be applied to it. This is helpful if you use more than one controller. The edit button will take you to the Profiles tab to edit the Selected Profile. You can also use the dropdown to create a new profile.
54-
55-
### Profiles
56-
57-
![Profile Tab Screenshot](https://user-images.githubusercontent.com/32114370/189564567-f73805f8-e16a-4a0a-a7ca-619509b10b56.png)
58-
59-
The **Profiles** tab displays all the profiles created. Profiles can be used to assign different settings for your controller for different circumstances. Along with creating new profiles, editing, renaming, deleting, and renaming, you can also import other profiles, and export your's for sharing with friends. When creating a new profile, it is recommended to use a preset option. For the output method, it must be chosen accordingly to what you want Windows to recognize the controller as.
60-
61-
For Example:
62-
63-
- You have a Pro Controller and want to use PS Remote Play with gyro? You need to choose DualShock 4 Output and adjust the profile for Gyro passthrough
64-
- You have any of the supported controllers and want to play Celest, which only supports XInput devices? Set the Output to Xbox 360
65-
- You have a fake DS4 controller that is not recognized as an official one, but want to play Witcher 3 with lightbar support and PS glyphs/icons? Then choose DualShock 4 Output and adjust for lightbar passthrough
66-
67-
![Output Controller Prompt Screenshot](https://user-images.githubusercontent.com/32114370/189565494-3bd6b11f-7298-4180-824e-7cde49daebb7.png)
68-
69-
On the resulting screen is where you can fully customize the new profile.
70-
71-
<img src="https://user-images.githubusercontent.com/32114370/189565801-485819c1-cfdc-4aca-8b28-1a91b925c5d9.png" width=75% height=75%>
72-
73-
The **Controls** tab is for remapping the controller button outputs. To open the page below, click on the desired button to remap on the image of the controller. Then select the desired new output for that input.
74-
75-
<img src="https://user-images.githubusercontent.com/32114370/189566012-a734210b-05e6-45f7-a1f8-8a1d5f71514f.png" width=75% height=75%>
76-
77-
The **Special Actions** tab allows you to create actions that are triggered when a button or combination of button presses occur.
78-
79-
The **Controller Readings** tab gives a live readout of the data from the joysticks being transmitted to DS4Windows
80-
81-
The **Axis Config** tab allows you to adjust the settings of the joysticks and adjust parameters such as deadzone and sensativity.
82-
83-
The **Lightbar** tab allows you to change the color of the lighbar on DualShock 4 controllers.
84-
85-
The **Touchpad** tab allows configuration of the touchpad on DualShock 4 controllers to be output as mouse or controller movement.
86-
87-
The **Gyro** tab contains the gyro settings and allows you to assign specfic commands to certain tiling actions.
88-
89-
The **Other** tab contains the settings for which controller is being emulated, rumble percentage, and the polling rate.
90-
91-
### Auto Profiles
92-
![Auto Profiles Screenshot](https://user-images.githubusercontent.com/32114370/189568215-1fa93173-7982-4c5a-9b36-1deda15ce6a3.png)
93-
94-
**Auto Profiles** allows you to assign certain profiles to a specified application. This allows you to use different settings, controls, and mappings for different applications.
95-
96-
### Output Slots
97-
![Output Slots Screenshot](https://user-images.githubusercontent.com/32114370/189568564-b46a38b2-f492-43a4-bd20-f2171edc7b0c.png)
98-
99-
**Output Slots** shows which controllers that are connected are designated to the 8 slots that DS4Windows allows to be plugged in at one time. Here you can also select a controller and virtually plug and unplug it in.
100-
101-
### Settings
102-
![Settings Screenshot](https://user-images.githubusercontent.com/75176311/232901882-6e271499-cdff-4f93-bfa5-921205c7fb69.PNG)
103-
104-
The **Settings** tab is where the settings for the DS4Windows application are. Options such as *Run at Startup*, *Start Minimized*, or *Show Notifications* live here.
105-
106-
**Disconenct from BT when Stopping** - Stops the bluetooth connection to the controllers when DS4Windows is quit
107-
108-
**Flash Lightbar at High Latency** - Flashes the DualShock 4's lightbar red when DS4Windows detects high input latency
109-
110-
**Quick Change** - Auto disables bluetooth when connecting a controller via USB
111-
112-
**Icon Choice** - Changes the Icon of the DS4Windows application
113-
114-
**App Theme** - Switch DS4Windows to Light or Dark mode
115-
116-
**External OSC Control & Monitoring** - Use Open Sound Control messages to remotely control and monitor buttons, sticks, triggers, and battery levels
117-
118-
**UDP Server** - Setting for connecting the motion controls of a compatible controller to another program
119-
120-
### Log
121-
122-
The **Log** tab is where you can look at all of the events that the DS4Windows application has encountered. There is also a button to export the log for debugging purposes.
123-
124-
## Device Detection Issue
125-
126-
If your DS4 is not detected by DS4Windows and the lightbar continues to
127-
flash yellow, there is a chance that Exclusive Mode has permanently
128-
disabled your DS4 in Windows. The easiest way to test if this has happened is
129-
for you to plug in the controller into a different USB port and see if it
130-
works then. Although this problem mainly affected older versions of
131-
DS4Windows (text written after version 1.5.15) for various reasons,
132-
other mapping programs can cause the same problem to occur.
133-
134-
If you suspect that your DS4 has been disabled, open the Device Manager
135-
(Control Panel\Hardware and Sound\Device Manager) and look for devices listed
136-
under the path "Human Interface Devices\HID-compliant game controller".
137-
138-
![Disabled Device Example](https://i.imgur.com/KI3QX2i.png)
139-
140-
If the icon shown for a device has a down arrow icon then you should
141-
check the device's instance path and see if the device is a DualShock 4 device.
142-
Right click the device item and select "Enable device" from the menu.
143-
That will re-enable the device so it can be seen by applications again.
144-
145-
## Disable Steam Controller Mapping Support
146-
147-
With recent updates to the Steam client at the time writing this (2018-12-13),
148-
Steam has enabled Xbox Configuration Support in the Steam client by default.
149-
What this means is that Steam will automatically map a detected Xbox 360
150-
controller to KB+M bindings initially (Desktop Mode) before launching Steam
151-
Big Picture Mode or launching a game. This presents a problem for DS4Windows
152-
since the created virtual Xbox 360 controller will be mapped to KB+M actions
153-
for desktop mode and games launched outside of the Steam client. In order to
154-
use DS4Windows properly, you have to open Steam Big Picture Mode, navigate to
155-
Settings > Controller> Controller Settings and uncheck **Xbox Configuration
156-
Support** along with **PlayStation Configuration Support**.
157-
15843
## Personal Game Testing
15944

16045
My PC game library is not that expansive so there are likely games
@@ -165,15 +50,6 @@ games or games that include a playable demo should be fine for testing.
16550
For other games, it might be better if people could test against any game
16651
that I have in my library and try to reproduce a problem.
16752

168-
## Pull Requests
169-
170-
Pull requests for DS4Windows are welcome. Before making a pull request, please
171-
test your changes to ensure that the changes made do not negatively affect
172-
the performance of other parts of the application. Some consideration will
173-
be made during code review to try to tweak the changes in order to improve
174-
application performance. However, there is a chance that a pull request will be
175-
rejected if no reasonable solution can be found to incorporate code changes.
176-
17753
## Tip Jar
17854

17955
If you would like to send some coin my way, here are some means by

contributing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Pull Requests
2+
3+
Pull requests for DS4Windows are welcome. Before making a pull request, please
4+
test your changes to ensure that the changes made do not negatively affect
5+
the performance of other parts of the application. Some consideration will
6+
be made during code review to try to tweak the changes in order to improve
7+
application performance. However, there is a chance that a pull request will be
8+
rejected if no reasonable solution can be found to incorporate code changes.

user_guide.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
## User Guide
2+
After completing the initial setup of the required drivers and dependencies, you are greeted with the main DS4Windows tab, controllers.
3+
4+
### Controllers
5+
![Controller Tab](https://user-images.githubusercontent.com/32114370/189562818-8e2d5e0a-3c61-4eb0-a53c-caa731b120e4.png)
6+
7+
Here all of the conected controllers are shown. Hovering your mouse over the Controller's ID will display the input delay of the specificed controller.
8+
9+
![Input Delay Screenshot](https://user-images.githubusercontent.com/32114370/189563985-e18c074e-3caf-49a7-af36-ed12d77f88c6.png)
10+
11+
The Link Profile/ID checkbox allows you to link a specified profile to a certain Controller ID so that when you plug in the controller next time the Selected Profile will always be applied to it. This is helpful if you use more than one controller. The edit button will take you to the Profiles tab to edit the Selected Profile. You can also use the dropdown to create a new profile.
12+
13+
### Profiles
14+
15+
![Profile Tab Screenshot](https://user-images.githubusercontent.com/32114370/189564567-f73805f8-e16a-4a0a-a7ca-619509b10b56.png)
16+
17+
The **Profiles** tab displays all the profiles created. Profiles can be used to assign different settings for your controller for different circumstances. Along with creating new profiles, editing, renaming, deleting, and renaming, you can also import other profiles, and export your's for sharing with friends. When creating a new profile, it is recommended to use a preset option. For the output method, it must be chosen accordingly to what you want Windows to recognize the controller as.
18+
19+
For Example:
20+
21+
- You have a Pro Controller and want to use PS Remote Play with gyro? You need to choose DualShock 4 Output and adjust the profile for Gyro passthrough
22+
- You have any of the supported controllers and want to play Celest, which only supports XInput devices? Set the Output to Xbox 360
23+
- You have a fake DS4 controller that is not recognized as an official one, but want to play Witcher 3 with lightbar support and PS glyphs/icons? Then choose DualShock 4 Output and adjust for lightbar passthrough
24+
25+
![Output Controller Prompt Screenshot](https://user-images.githubusercontent.com/32114370/189565494-3bd6b11f-7298-4180-824e-7cde49daebb7.png)
26+
27+
On the resulting screen is where you can fully customize the new profile.
28+
29+
<img src="https://user-images.githubusercontent.com/32114370/189565801-485819c1-cfdc-4aca-8b28-1a91b925c5d9.png" width=75% height=75%>
30+
31+
The **Controls** tab is for remapping the controller button outputs. To open the page below, click on the desired button to remap on the image of the controller. Then select the desired new output for that input.
32+
33+
<img src="https://user-images.githubusercontent.com/32114370/189566012-a734210b-05e6-45f7-a1f8-8a1d5f71514f.png" width=75% height=75%>
34+
35+
The **Special Actions** tab allows you to create actions that are triggered when a button or combination of button presses occur.
36+
37+
The **Controller Readings** tab gives a live readout of the data from the joysticks being transmitted to DS4Windows
38+
39+
The **Axis Config** tab allows you to adjust the settings of the joysticks and adjust parameters such as deadzone and sensativity.
40+
41+
The **Lightbar** tab allows you to change the color of the lighbar on DualShock 4 controllers.
42+
43+
The **Touchpad** tab allows configuration of the touchpad on DualShock 4 controllers to be output as mouse or controller movement.
44+
45+
The **Gyro** tab contains the gyro settings and allows you to assign specfic commands to certain tiling actions.
46+
47+
The **Other** tab contains the settings for which controller is being emulated, rumble percentage, and the polling rate.
48+
49+
### Auto Profiles
50+
![Auto Profiles Screenshot](https://user-images.githubusercontent.com/32114370/189568215-1fa93173-7982-4c5a-9b36-1deda15ce6a3.png)
51+
52+
**Auto Profiles** allows you to assign certain profiles to a specified application. This allows you to use different settings, controls, and mappings for different applications.
53+
54+
### Output Slots
55+
![Output Slots Screenshot](https://user-images.githubusercontent.com/32114370/189568564-b46a38b2-f492-43a4-bd20-f2171edc7b0c.png)
56+
57+
**Output Slots** shows which controllers that are connected are designated to the 8 slots that DS4Windows allows to be plugged in at one time. Here you can also select a controller and virtually plug and unplug it in.
58+
59+
### Settings
60+
![Settings Screenshot](https://user-images.githubusercontent.com/75176311/232901882-6e271499-cdff-4f93-bfa5-921205c7fb69.PNG)
61+
62+
The **Settings** tab is where the settings for the DS4Windows application are. Options such as *Run at Startup*, *Start Minimized*, or *Show Notifications* live here.
63+
64+
**Disconenct from BT when Stopping** - Stops the bluetooth connection to the controllers when DS4Windows is quit
65+
66+
**Flash Lightbar at High Latency** - Flashes the DualShock 4's lightbar red when DS4Windows detects high input latency
67+
68+
**Quick Change** - Auto disables bluetooth when connecting a controller via USB
69+
70+
**Icon Choice** - Changes the Icon of the DS4Windows application
71+
72+
**App Theme** - Switch DS4Windows to Light or Dark mode
73+
74+
**External OSC Control & Monitoring** - Use Open Sound Control messages to remotely control and monitor buttons, sticks, triggers, and battery levels
75+
76+
**UDP Server** - Setting for connecting the motion controls of a compatible controller to another program
77+
78+
### Log
79+
80+
The **Log** tab is where you can look at all of the events that the DS4Windows application has encountered. There is also a button to export the log for debugging purposes.
81+
82+
## Device Detection Issue
83+
84+
If your DS4 is not detected by DS4Windows and the lightbar continues to
85+
flash yellow, there is a chance that Exclusive Mode has permanently
86+
disabled your DS4 in Windows. The easiest way to test if this has happened is
87+
for you to plug in the controller into a different USB port and see if it
88+
works then. Although this problem mainly affected older versions of
89+
DS4Windows (text written after version 1.5.15) for various reasons,
90+
other mapping programs can cause the same problem to occur.
91+
92+
If you suspect that your DS4 has been disabled, open the Device Manager
93+
(Control Panel\Hardware and Sound\Device Manager) and look for devices listed
94+
under the path "Human Interface Devices\HID-compliant game controller".
95+
96+
![Disabled Device Example](https://i.imgur.com/KI3QX2i.png)
97+
98+
If the icon shown for a device has a down arrow icon then you should
99+
check the device's instance path and see if the device is a DualShock 4 device.
100+
Right click the device item and select "Enable device" from the menu.
101+
That will re-enable the device so it can be seen by applications again.
102+
103+
## Disable Steam Controller Mapping Support
104+
105+
With recent updates to the Steam client at the time writing this (2018-12-13),
106+
Steam has enabled Xbox Configuration Support in the Steam client by default.
107+
What this means is that Steam will automatically map a detected Xbox 360
108+
controller to KB+M bindings initially (Desktop Mode) before launching Steam
109+
Big Picture Mode or launching a game. This presents a problem for DS4Windows
110+
since the created virtual Xbox 360 controller will be mapped to KB+M actions
111+
for desktop mode and games launched outside of the Steam client. In order to
112+
use DS4Windows properly, you have to open Steam Big Picture Mode, navigate to
113+
Settings > Controller> Controller Settings and uncheck **Xbox Configuration
114+
Support** along with **PlayStation Configuration Support**.

0 commit comments

Comments
 (0)