docs(mkdocs): add ahk exe troubleshooting section

This commit is contained in:
LGUG2Z
2024-05-10 14:50:41 -07:00
parent 1accbf65ca
commit c47cf4718b

View File

@@ -1,5 +1,23 @@
# Troubleshooting
## AutoHotKey executable not found
If you try to start komorebi with AHK using `komorebic start --ahk`, and you have
not installed AHK using `scoop`, you'll probably receive an error:
```text
Error: could not find autohotkey, please make sure it is installed before using the --ahk flag
```
Depending on how AHK is installed the executable on your system may have a
different name. In order to account for this, you may set the `KOMOREBI_AHK_EXE`
environment variable in your
[PowerShell profile](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-7.4)
to match the name of the executable as it is found on your system.
After setting `KOMOREBI_AHK_EXE` make sure to either reload your PowerShell
profile or open a new terminal tab.
## Komorebi is unresponsive when the display wakes from sleep
This can happen in rare cases when your monitor state is not preserved after it
@@ -94,7 +112,7 @@ running `komorebic stop` and `komorebic start`.
"id": 65537,
"name": "DISPLAY1",
"device": null,
"device_id": null,
"device_id": null
}
]
}