diff --git a/docs/README.md b/docs/README.md index 6c966b9..8612c04 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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--debug.zip` enables all experimental features enabled, but might be unstable and buggy. diff --git a/docs/images/event_viewer.png b/docs/images/event_viewer.png new file mode 100644 index 0000000..882682e Binary files /dev/null and b/docs/images/event_viewer.png differ diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..a4fa913 --- /dev/null +++ b/docs/troubleshooting.md @@ -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)