Add Troubleshooting

This commit is contained in:
Kamil Trzciński 2022-12-12 12:09:03 +01:00
parent 5b5fd637f3
commit eb76a2e2f0
3 changed files with 21 additions and 0 deletions

View file

@ -48,6 +48,7 @@ It is strongly advised that following software is uninstalled or disabled:
- [Controller Shortcuts](shortcuts.md) - default shortcuts when using [Steam Controller](steam-controller.md).
- [Development](development.md) - how to compile this project.
- [Risks](risks.md) - this project uses kernel manipulation and might result in unstable system.
- [Troubleshooting](troubleshooting.md) - if you encounter any problems.
- The latest development version can be found in [GitHub Releases](https://github.com/ayufan/steam-deck-tools/releases).
- The variant with `SteamDeckTools-<version>-debug.zip` enables all experimental features enabled, but might be unstable and buggy.

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

20
docs/troubleshooting.md Normal file
View file

@ -0,0 +1,20 @@
# Troubleshooting
Any of the applications might crash. Those are following things that might help
find the problem:
1. Ensure that [project dependencies](README.md#install) are installed.
2. Find error in [Event Viewer](#event-viewer).
## Event Viewer
1. Open `Event Viewer` in Windows.
1. Under `Custom Events > Administrative Events` find recent `.NET Runtime`.
1. Errors registered for Steam Deck Tools will have **Application:** to be one of:
- `FanControl.exe`
- `PerformanceOverlay.exe`
- `PowerControl.exe`
- `SteamController.exe`
1. Open issue in [GitHub](https://github.com/ayufan-research/steam-deck-tools/)
with details what happened, when and included `exception`.
![](images/event_viewer.png)