diff --git a/.gitignore b/.gitignore index 844c1f77..beac8af3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,4 @@ /target CHANGELOG.md dummy.go -komorebi.ahk -komorebic/applications.yaml \ No newline at end of file +komorebic/applications.yaml diff --git a/docs/common-workflows/autohotkey.md b/docs/common-workflows/autohotkey.md index 3559f959..509f4402 100644 --- a/docs/common-workflows/autohotkey.md +++ b/docs/common-workflows/autohotkey.md @@ -1,4 +1,4 @@ -# AutoHotKey +# AutoHotkey If you would like to use Autohotkey, please make sure you have AutoHotKey v2 installed. @@ -10,8 +10,8 @@ able to craft their own configuration files. If you would like to try out AHK, here is a simple sample configuration which largely matches the `whkdrc` sample configuration. -``` -{% include "../komorebi.ahk" %} +```autohotkey +{% include "./komorebi.ahk.txt" %} ``` By default, the `komorebi.ahk` file should be located in the `$Env:USERPROFILE` @@ -19,4 +19,4 @@ directory, however, if `$Env:KOMOREBI_CONFIG_HOME` is set, it should be located there. Once the file is in place, you can stop komorebi and whkd by running `komorebic stop --whkd`, -and then start komorebi with Autohotkey by running `komorebic start --ahk`. \ No newline at end of file +and then start komorebi with Autohotkey by running `komorebic start --ahk`. diff --git a/docs/common-workflows/dynamic-layout-switching.md b/docs/common-workflows/dynamic-layout-switching.md index dd901d67..09e82b34 100644 --- a/docs/common-workflows/dynamic-layout-switching.md +++ b/docs/common-workflows/dynamic-layout-switching.md @@ -1,4 +1,4 @@ -# Dynamically Layout Switching +# Dynamic Layout Switching With `komorebi` it is possible to define rules to automatically change the layout on a specified workspace when a threshold of window containers is met. diff --git a/docs/installation.md b/docs/installation.md index f6a00c51..11fa70c1 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -45,7 +45,7 @@ running the following command in an Administrator Terminal before installing Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1 ``` -## Disabling Unnecessary System Animations +## Disabling unnecessary system animations It is highly recommended that you enable the "Turn off all unnecessary animations (when possible)" option in "Control Panel > Ease of Access > Ease of Access Centre / Make the computer easier to see" for the best performance with @@ -128,3 +128,21 @@ an offline machine to install. Once installed, proceed to get the [example configurations](example-configurations.md) (none of the commands for first-time set up and running komorebi require an internet connection). + +## Uninstallation + +Before uninstalling, first run `komorebic stop --whkd` to make sure that both +the `komorebi` and `whkd` processes have been stopped. + +Then, depending on whether you installed with Scoop or WinGet, run `scoop +uninstall komorebi whkd` or `winget uninstall LGUG2Z.komorebi LGUG2Z.whkd`. + +Finally, you can run the following commands in a PowerShell prompt to clean up +files created by the `quickstart` command and any other runtime files: + +```powershell +rm $Env:USERPROFILE\komorebi.json +rm $Env:USERPROFILE\applications.yaml +rm $Env:USERPROFILE\.config\whkdrc +rm -r -Force $Env:LOCALAPPDATA\komorebi +``` diff --git a/docs/komorebi.ahk.txt b/docs/komorebi.ahk.txt new file mode 100644 index 00000000..c7de7d67 --- /dev/null +++ b/docs/komorebi.ahk.txt @@ -0,0 +1,71 @@ +#Requires AutoHotkey v2.0.2 +#SingleInstance Force + +Komorebic(cmd) { + RunWait(format("komorebic.exe {}", cmd), , "Hide") +} + +!q::Komorebic("close") +!m::Komorebic("minimize") + +; Focus windows +!h::Komorebic("focus left") +!j::Komorebic("focus down") +!k::Komorebic("focus up") +!l::Komorebic("focus right") + +!+[::Komorebic("cycle-focus previous") +!+]::Komorebic("cycle-focus next") + +; Move windows +!+h::Komorebic("move left") +!+j::Komorebic("move down") +!+k::Komorebic("move up") +!+l::Komorebic("move right") + +; Stack windows +!Left::Komorebic("stack left") +!Down::Komorebic("stack down") +!Up::Komorebic("stack up") +!Right::Komorebic("stack right") +!;::Komorebic("unstack") +![::Komorebic("cycle-stack previous") +!]::Komorebic("cycle-stack next") + +; Resize +!=::Komorebic("resize-axis horizontal increase") +!-::Komorebic("resize-axis horizontal decrease") +!+=::Komorebic("resize-axis vertical increase") +!+_::Komorebic("resize-axis vertical decrease") + +; Manipulate windows +!t::Komorebic("toggle-float") +!f::Komorebic("toggle-monocle") + +; Window manager options +!+r::Komorebic("retile") +!p::Komorebic("toggle-pause") + +; Layouts +!x::Komorebic("flip-layout horizontal") +!y::Komorebic("flip-layout vertical") + +; Workspaces +!1::Komorebic("focus-workspace 0") +!2::Komorebic("focus-workspace 1") +!3::Komorebic("focus-workspace 2") +!4::Komorebic("focus-workspace 3") +!5::Komorebic("focus-workspace 4") +!6::Komorebic("focus-workspace 5") +!7::Komorebic("focus-workspace 6") +!8::Komorebic("focus-workspace 7") + +; Move windows across workspaces +!+1::Komorebic("move-to-workspace 0") +!+2::Komorebic("move-to-workspace 1") +!+3::Komorebic("move-to-workspace 2") +!+4::Komorebic("move-to-workspace 3") +!+5::Komorebic("move-to-workspace 4") +!+6::Komorebic("move-to-workspace 5") +!+7::Komorebic("move-to-workspace 6") +!+8::Komorebic("move-to-workspace 7") diff --git a/docs/release/v0-1-22.md b/docs/release/v0-1-22.md index 1c494d47..44407fd1 100644 --- a/docs/release/v0-1-22.md +++ b/docs/release/v0-1-22.md @@ -1,3 +1,5 @@ +# v0.1.22 + In addition to the [changelog](https://github.com/LGUG2Z/komorebi/releases/tag/v0.1.22) of new features and fixes, please note the following changes from `v0.1.21` to adjust your configuration files accordingly. @@ -49,8 +51,8 @@ A 1px border is drawn around the window edge. Users may see a gap for a single p transparent edge - this is the windows themed edge, and is not present for all applications. ```json - { +{ "border_offset": 0, "border_width": 1 } -``` \ No newline at end of file +``` diff --git a/komorebi.sample.ahk b/komorebi.sample.ahk deleted file mode 100644 index 4f663079..00000000 --- a/komorebi.sample.ahk +++ /dev/null @@ -1,56 +0,0 @@ -#SingleInstance Force - -; Load library -#Include komorebic.lib.ahk - -; Focus windows -!h::Focus("left") -!j::Focus("down") -!k::Focus("up") -!l::Focus("right") -!+[::CycleFocus("previous") -!+]::CycleFocus("next") - -; Move windows -!+h::Move("left") -!+j::Move("down") -!+k::Move("up") -!+l::Move("right") -!+Enter::Promote() - -; Stack windows -!Left::Stack("left") -!Right::Stack("right") -!Up::Stack("up") -!Down::Stack("down") -!;::Unstack() -![::CycleStack("previous") -!]::CycleStack("next") - -; Resize -!=::ResizeAxis("horizontal", "increase") -!-::ResizeAxis("horizontal", "decrease") -!+=::ResizeAxis("vertical", "increase") -!+-::ResizeAxis("vertical", "decrease") - -; Manipulate windows -!t::ToggleFloat() -!+f::ToggleMonocle() - -; Window manager options -!+r::Retile() -!p::TogglePause() - -; Layouts -!x::FlipLayout("horizontal") -!y::FlipLayout("vertical") - -; Workspaces -!1::FocusWorkspace(0) -!2::FocusWorkspace(1) -!3::FocusWorkspace(2) - -; Move windows across workspaces -!+1::MoveToWorkspace(0) -!+2::MoveToWorkspace(1) -!+3::MoveToWorkspace(2) diff --git a/mkdocs.yml b/mkdocs.yml index 29312835..a8991ba3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,6 +57,7 @@ nav: - Troubleshooting: troubleshooting.md - Common workflows: - common-workflows/komorebi-config-home.md + - common-workflows/autohotkey.md - common-workflows/borders.md - common-workflows/stackbar.md - common-workflows/remove-gaps.md @@ -67,7 +68,6 @@ nav: - common-workflows/mouse-follows-focus.md - common-workflows/custom-layouts.md - common-workflows/dynamic-layout-switching.md - - common-workflows/autohotkey.md - Release notes: - release/v0-1-22.md - Configuration reference: https://komorebi.lgug2z.com/schema