From 9431bac4ad20f26c1c63bebc9b6aa880187220af Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sun, 30 Apr 2023 12:33:55 -0700 Subject: [PATCH] docs(readme): add section on using ahk --- README.md | 28 +++++++++++++++++++++++++--- komorebi.generated.ahk | 19 +++++++++++++++---- komorebi.generated.ps1 | 17 +++++++++++++++-- komorebic/src/main.rs | 6 ------ 4 files changed, 55 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d566c4f7..42cbf1f8 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,27 @@ You can watch a walkthrough video of this quickstart below on YouTube. [![Watch the quickstart walkthrough video](https://img.youtube.com/vi/cBnLIwMtv8g/hqdefault.jpg)](https://www.youtube.com/watch?v=cBnLIwMtv8g) +#### Using Autohotkey + +If you would like to use Autohotkey, please make sure you have AutoHotKey v2 installed. + +Generally, users who opt for AHK will have specific needs that can only be addressed by the advanced functionality of AHK, +and so they are assumed to be able to craft their own configuration files. + +If you would like to try out AHK, a simple sample configuration powered by `komorebic.lib.ahk` is provided as a starting +point. + +```powershell +# save the latest generated komorebic library to ~/komorebic.lib.ahk +iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk + +# save the latest generated app-specific config tweaks and fixes to ~/komorebi.generated.ahk +iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.generated.ahk -OutFile $Env:USERPROFILE\komorebi.generated.ahk + +# save the sample komorebi configuration file to ~/komorebi.ahk +iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk +``` + ### GitHub Releases Prebuilt binaries are available on the [releases page](https://github.com/LGUG2Z/komorebi/releases) in a `zip` archive. @@ -259,6 +280,9 @@ key combinations in the `whkdrc` file. Additionally, you may run `komorebic.exe ahk-library` to generate a helper library for AutoHotKey which wraps every `komorebic` command in a native AHK function. +The output of this command is in AHKv1 syntax. It must be manually converted to AHKv2 syntax +using [this tool](https://github.com/mmikeww/AHK-v2-script-converter) or something similar. + If you include the generated library at the top of your `~/komorebi.ahk` configuration file, you will be able to call any of the functions that it contains. @@ -266,13 +290,11 @@ any of the functions that it contains. ❗️**NOTE**: This section is only relevant for people who wish to use AutoHotKey instead of [`whkd`](https://github.com/LGUG2Z/whkd). -The generated helper library for AutoHotKey currently only supports AutoHotKey v1.1. - The preferred way to install AutoHotKey for use with `komorebi` is to install it via `scoop`: ```powershell scoop bucket add versions -scoop install autohotkey1.1 +scoop install autohotkey ``` If you install AutoHotKey using a different method, the name of the executable file may differ from the name given by diff --git a/komorebi.generated.ahk b/komorebi.generated.ahk index c2bd5709..01a427e0 100644 --- a/komorebi.generated.ahk +++ b/komorebi.generated.ahk @@ -1,6 +1,4 @@ ; Generated by komorebic.exe -; To use this file, add the line below to the top of your komorebi.ahk configuration file -; #Include %A_ScriptDir%\komorebi.generated.ahk ; 1Password RunWait('komorebic.exe float-rule exe "1Password.exe"', , "Hide") @@ -135,8 +133,7 @@ RunWait('komorebic.exe identify-object-name-change-application exe "GodotManager RunWait('komorebic.exe identify-tray-application exe "chrome.exe"', , "Hide") ; Google Drive -; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line -RunWait('komorebic.exe identify-tray-application exe "GoogleDriveFS.exe"', , "Hide") +RunWait('komorebic.exe float-rule exe "GoogleDriveFS.exe"', , "Hide") ; Houdoku RunWait('komorebic.exe identify-border-overflow-application exe "Houdoku.exe"', , "Hide") @@ -240,6 +237,10 @@ RunWait('komorebic.exe float-rule class "MozillaTaskbarPreviewClass"', , "Hide") ; NVIDIA GeForce Experience RunWait('komorebic.exe identify-border-overflow-application exe "NVIDIA GeForce Experience.exe"', , "Hide") +; NZXT CAM +; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +RunWait('komorebic.exe identify-tray-application exe "NZXT CAM.exe"', , "Hide") + ; NiceHash Miner RunWait('komorebic.exe identify-border-overflow-application exe "nhm_app.exe"', , "Hide") RunWait('komorebic.exe manage-rule exe "nhm_app.exe"', , "Hide") @@ -373,6 +374,11 @@ RunWait('komorebic.exe identify-tray-application exe "Spotify.exe"', , "Hide") ; Steam RunWait('komorebic.exe identify-border-overflow-application class "vguiPopupWindow"', , "Hide") +; Steam Beta +RunWait('komorebic.exe identify-border-overflow-application class "SDL_app"', , "Hide") +; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +RunWait('komorebic.exe identify-tray-application class "SDL_app"', , "Hide") + ; Stremio ; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line RunWait('komorebic.exe identify-tray-application exe "stremio.exe"', , "Hide") @@ -393,6 +399,11 @@ RunWait('komorebic.exe identify-border-overflow-application exe "Telegram.exe"', ; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line RunWait('komorebic.exe identify-tray-application exe "Telegram.exe"', , "Hide") +; TickTick +RunWait('komorebic.exe identify-border-overflow-application exe "TickTick.exe"', , "Hide") +; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +RunWait('komorebic.exe identify-tray-application exe "TickTick.exe"', , "Hide") + ; TouchCursor ; If you have disabled minimize/close to tray for this application, you can delete/comment out the next line RunWait('komorebic.exe identify-tray-application exe "tcconfig.exe"', , "Hide") diff --git a/komorebi.generated.ps1 b/komorebi.generated.ps1 index 5afd0b88..2603eb0f 100644 --- a/komorebi.generated.ps1 +++ b/komorebi.generated.ps1 @@ -133,8 +133,7 @@ komorebic.exe identify-object-name-change-application exe "GodotManager.exe" komorebic.exe identify-tray-application exe "chrome.exe" # Google Drive -# If you have disabled minimize/close to tray for this application, you can delete/comment out the next line -komorebic.exe identify-tray-application exe "GoogleDriveFS.exe" +komorebic.exe float-rule exe "GoogleDriveFS.exe" # Houdoku komorebic.exe identify-border-overflow-application exe "Houdoku.exe" @@ -238,6 +237,10 @@ komorebic.exe float-rule class "MozillaTaskbarPreviewClass" # NVIDIA GeForce Experience komorebic.exe identify-border-overflow-application exe "NVIDIA GeForce Experience.exe" +# NZXT CAM +# If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +komorebic.exe identify-tray-application exe "NZXT CAM.exe" + # NiceHash Miner komorebic.exe identify-border-overflow-application exe "nhm_app.exe" komorebic.exe manage-rule exe "nhm_app.exe" @@ -371,6 +374,11 @@ komorebic.exe identify-tray-application exe "Spotify.exe" # Steam komorebic.exe identify-border-overflow-application class "vguiPopupWindow" +# Steam Beta +komorebic.exe identify-border-overflow-application class "SDL_app" +# If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +komorebic.exe identify-tray-application class "SDL_app" + # Stremio # If you have disabled minimize/close to tray for this application, you can delete/comment out the next line komorebic.exe identify-tray-application exe "stremio.exe" @@ -391,6 +399,11 @@ komorebic.exe identify-border-overflow-application exe "Telegram.exe" # If you have disabled minimize/close to tray for this application, you can delete/comment out the next line komorebic.exe identify-tray-application exe "Telegram.exe" +# TickTick +komorebic.exe identify-border-overflow-application exe "TickTick.exe" +# If you have disabled minimize/close to tray for this application, you can delete/comment out the next line +komorebic.exe identify-tray-application exe "TickTick.exe" + # TouchCursor # If you have disabled minimize/close to tray for this application, you can delete/comment out the next line komorebic.exe identify-tray-application exe "tcconfig.exe" diff --git a/komorebic/src/main.rs b/komorebic/src/main.rs index 7d6b6ad1..9a1ae5a2 100644 --- a/komorebic/src/main.rs +++ b/komorebic/src/main.rs @@ -1808,12 +1808,6 @@ fn main() -> Result<()> { "could not find the path to the generated configuration file" ))? ); - - println!( - "\nYou can include the generated configuration at the top of your komorebi.ahk config with this line:" - ); - - println!("\n#Include %A_ScriptDir%\\komorebi.generated.ahk"); } SubCommand::PwshAppSpecificConfiguration(arg) => { let content = std::fs::read_to_string(resolve_windows_path(&arg.path)?)?;