fix(wm): hard code unreal engine ws handling

This commit introduces a temporary hard-coded fix for handling
minimizing and restoration for UnrealEditor.exe when switching
workspaces.

re #211

.czrc

@@ -1,3 +0,0 @@
-{
-  "path": "cz-conventional-changelog"
-}

.github/FUNDING.yml

@@ -1,2 +1 @@
 github: LGUG2Z
-ko_fi: lgug2z

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]: Short descriptive title"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See bug
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots and Videos**
+Add screenshots and videos to help explain your problem.
+
+**Operating System**
+Provide the output of `systeminfo | grep "^OS Name\|^OS Version"`
+
+For example:
+```
+OS Name:                   Microsoft Windows 11 Pro
+OS Version:                10.0.22000 N/A Build 22000
+```
+
+**Additional context**
+Add any other context about the problem here.
+
+In particular, if you have any other AHK scripts or software running that handle any aspect of window management or manipulation

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,64 +0,0 @@
-name: Bug report
-description: File a bug report
-labels: [bug]
-title: "[BUG]: "
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Please **do not** open an issue for applications with invisible windows leaving ghost tiles.
-
-        You can run `komorebic visible-windows` when the ghost tile is present on your workspace to retrieve the invisible window's exe, class name and title, and then use that information to [ignore the window](https://lgug2z.github.io/komorebi/common-workflows/ignore-windows.html) responsible for the ghost tile.
-
-        If it is not possible to uniquely identify the invisible window resulting in a ghost tile through a mixture of exe, title and class identifiers, then this is not a bug with komorebi but a bug with the application you are using, and you should open an issue with the developer(s) of that application.
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Summary
-      description: >
-        Please provide a short summary of the bug, along with any information
-        you feel is relevant to replicating the bug.
-
-        You may include screenshots and videos in this section.
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Version Information
-      description: >
-        Please provide information about the versions of Windows and komorebi
-        running on your machine.
-
-        Do not submit a bug if you are not using an official version of Windows
-        such as AtlasOS; only official versions of Windows are supported.
-
-        ```
-        systeminfo | findstr /B /C:"OS Name" /B /C:"OS Version"
-        ```
-
-        ```
-        komorebic --version
-        ```
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Komorebi Configuration
-      description: >
-        Please provide your configuration file (komorebi.json or komorebi.bar.json)
-      render: json
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Hotkey Configuration
-      description: >
-        Please provide your whkdrc or komorebi.ahk hotkey configuration file
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Output of komorebic check
-      description: >
-        Please provide the output of `komorebic check`

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Komorebi Documentation
-    url: https://lgug2z.github.io/komorebi/
-    about: Please search the documentation website before opening an issue
-  - name: Komorebi Quickstart Tutorial Video
-    url: https://www.youtube.com/watch?v=MMZUAtHbTYY
-    about: If you are new, please make sure you watch the quickstart tutorial video

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]: Short descriptive title"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,37 +0,0 @@
-name: Feature request
-description: Suggest a new feature (Limited to Sponsors, Commercial License Holders, and Collaborators)
-labels: [enhancement]
-title: "[FEAT]: "
-body:
-  - type: dropdown
-    id: Eligibility
-    attributes:
-      label: Eligibility
-      description: >
-        Feature requests are considered from individuals who are current $5+ monthly sponsors to the project, individual commercial use license holders, and approved collaborators.
-
-        Please specify the platform you use to sponsor the project.
-      options:
-        - Individual Commercial Use License
-        - GitHub Sponsor
-        - Ko-fi Sponsor
-        - Approved Collaborator
-      default: 0
-    validations:
-      required: true
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Suggestion
-      description: >
-        Please share your suggestion here. Be sure to include all necessary context.
-
-        If you sponsor on a platform where you use a different username, please specify the username here.
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Alternatives Considered
-      description: >
-        Please share share alternatives you have considered here.

.github/pull_request_template.md

@@ -1,7 +0,0 @@
-<!--
-  Please follow the Conventional Commits specification.
-
-  If you need to update your PR with changes from `master`, please run `git rebase master`.
-
-  By opening this PR, you confirm that you have read and understood this project's `CONTRIBUTING.md`.
--->

.github/workflows/feature-check.yaml

@@ -1,47 +0,0 @@
-name: Feature Issue Check
-
-on:
-  issues:
-    types: [ opened ]
-
-jobs:
-  auto-close:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-
-    steps:
-      - name: Check and close feature issues
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const issue = context.payload.issue;
-            
-            if (issue.title.startsWith('[FEAT]: ')) {
-              const message = `
-                Feature requests on this repository are only open to current [GitHub sponsors](https://github.com/sponsors/LGUG2Z) on the $5/month tier and above, people with a valid [individual commercial use license](https://lgug2z.com/software/komorebi), and approved contributors. 
-            
-                This issue has been automatically closed until one of those pre-requisites can be validated.
-              `.replace(/^\s+/gm, ''); 
-            
-              await github.rest.issues.createComment({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: issue.number,
-                body: message,
-              });
-
-              await github.rest.issues.update({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: issue.number,
-                state: 'closed'
-              });
-
-              await github.rest.issues.lock({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: issue.number,
-                state: 'resolved'
-              });
-            }

.github/workflows/windows.yaml

@@ -14,193 +14,100 @@ on:
     tags:
       - v*
   schedule:
-    - cron: "30 0 * * 0" # Every day at 00:30 UTC
-  workflow_dispatch:
+    - cron: "30 0 * * 1" # Every Monday at half past midnight UTC
 
 jobs:
   build:
+    name: Build
+    runs-on: windows-latest
+    env:
+      RUSTFLAGS: -Ctarget-feature=+crt-static
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
-        platform:
-          - os-name: Windows-x86_64
-            runs-on: windows-latest
-            target: x86_64-pc-windows-msvc
-          - os-name: Windows-aarch64
-            runs-on: windows-latest
-            target: aarch64-pc-windows-msvc
-    runs-on: ${{ matrix.platform.runs-on }}
-    permissions: write-all
-    env:
-      RUSTFLAGS: -Ctarget-feature=+crt-static -Dwarnings
-      GH_TOKEN: ${{ github.token }}
+        target:
+          - x86_64-pc-windows-msvc
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - run: rustup toolchain install stable --profile minimal
-      - run: rustup toolchain install nightly --allow-downgrade -c rustfmt
-      - uses: Swatinem/rust-cache@v2
+      - name: Prep cargo dirs
+        run: |
+          New-Item "${env:USERPROFILE}\.cargo\registry" -ItemType Directory -Force
+          New-Item "${env:USERPROFILE}\.cargo\git" -ItemType Directory -Force
+        shell: powershell
+      - name: Set environment variables appropriately for the build
+        run: |
+          echo "%USERPROFILE%\.cargo\bin" | Out-File -Append -FilePath $env:GITHUB_PATH -Encoding utf8
+          echo "TARGET=${{ matrix.target }}" | Out-File -Append -FilePath $env:GITHUB_ENV -Encoding utf8
+          echo "SKIP_TESTS=" | Out-File -Append -FilePath $env:GITHUB_ENV -Encoding utf8
+      - name: Cache cargo registry, git trees and binaries
+        uses: actions/cache@v3
         with:
-          cache-on-failure: "true"
-          cache-all-crates: "true"
-          key: ${{ matrix.platform.target }}
-      - run: cargo +nightly fmt --check
-      - run: cargo clippy
-      - run: cargo test --package komorebi --test compat
-      - uses: houseabsolute/actions-rust-cross@v1
-        with:
-          command: "build"
-          target: ${{ matrix.platform.target }}
-          args: "--locked --release"
-      - run: |
-          cargo install cargo-wix
-          cargo wix --no-build -p komorebi --nocapture -I .\wix\main.wxs --target ${{ matrix.platform.target }}
-      - uses: actions/upload-artifact@v4
-        with:
-          name: komorebi-${{ matrix.platform.target }}-${{ github.sha }}
           path: |
-            target/${{ matrix.platform.target }}/release/*.exe
-            target/${{ matrix.platform.target }}/release/*.pdb
+            ~/.cargo/registry
+            ~/.cargo/git
+            ~/.cargo/bin
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Get rustc commit hash
+        id: cargo-target-cache
+        run: |
+          echo "::set-output name=rust_hash::$(rustc -Vv | grep commit-hash | awk '{print $2}')"
+        shell: bash
+      - name: Cache cargo build
+        uses: actions/cache@v3
+        with:
+          path: target
+          key: ${{ github.base_ref }}-${{ github.head_ref }}-${{ matrix.target }}-cargo-target-dir-${{ steps.cargo-target-cache.outputs.rust_hash }}-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ github.base_ref }}-${{ matrix.target }}-cargo-target-dir-${{ steps.cargo-target-cache.outputs.rust_hash }}-${{ hashFiles('**/Cargo.lock') }}
+      - name: Install Rustup using win.rustup.rs
+        run: |
+          # Disable the download progress bar which can cause perf issues
+          $ProgressPreference = "SilentlyContinue"
+          Invoke-WebRequest https://win.rustup.rs/ -OutFile rustup-init.exe
+          .\rustup-init.exe -y --default-host=x86_64-pc-windows-msvc --profile=minimal
+        shell: powershell
+      - name: Ensure stable toolchain is up to date
+        run: rustup update stable
+        shell: bash
+      - name: Install the target
+        run: |
+          rustup target install ${{ matrix.target }}
+      - name: Run a full build
+        run: |
+          cargo build --locked --release --target ${{ matrix.target }}
+      - name: Create MSI installer
+        run: |
+          cargo install cargo-wix
+          cargo wix -p komorebi --nocapture -I .\wix\main.wxs --target x86_64-pc-windows-msvc
+      - name: Upload the built artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: komorebi-${{ matrix.target }}
+          path: |
+            target/${{ matrix.target }}/release/komorebi.exe
+            target/${{ matrix.target }}/release/komorebic.exe
+            target/${{ matrix.target }}/release/komorebi.pdb
+            target/${{ matrix.target }}/release/komorebic.pdb
             target/wix/komorebi-*.msi
-          retention-days: 14
-
-  nightly:
-    needs: build
-    runs-on: windows-latest
-    permissions: write-all
-    if: ${{ github.ref == 'refs/heads/master' && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' ) }}
-    env:
-      GH_TOKEN: ${{ github.token }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - shell: bash
-        run: echo "VERSION=nightly" >> $GITHUB_ENV
-      - uses: actions/download-artifact@v4
-      - run: |
-          Compress-Archive -Force ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/x86_64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/wix/*x86_64.msi -Destination ./komorebi-$Env:VERSION-x86_64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip" >checksums.txt
-
-          Compress-Archive -Force ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/aarch64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/wix/*aarch64.msi -Destination ./komorebi-$Env:VERSION-aarch64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip" >>checksums.txt
-      - uses: Swatinem/rust-cache@v2
-        with:
-          cache-on-failure: "true"
-          cache-all-crates: "true"
-      - shell: bash
+          retention-days: 7
+      - name: Generate changelog
+        if: startsWith(github.ref, 'refs/tags/')
+        shell: bash
         run: |
           if ! type kokai >/dev/null; then cargo install --locked kokai --force; fi
-          git tag -d nightly || true
-          git tag nightly
-          kokai release --no-emoji --add-links github:commits,issues --ref nightly >"CHANGELOG.md"
-      - shell: bash
-        run: |
-          gh release delete nightly --yes || true
-          git push origin :nightly || true
-          gh release create nightly \
-            --target $GITHUB_SHA \
-            --prerelease \
-            --title "komorebi nightly (${GITHUB_SHA})" \
-            --notes-file CHANGELOG.md \
-            komorebi-nightly-x86_64-pc-windows-msvc.zip \
-            komorebi-nightly-x86_64.msi \
-            komorebi-nightly-aarch64-pc-windows-msvc.zip \
-            komorebi-nightly-aarch64.msi \
-            checksums.txt
-
-  release-dry-run:
-    needs: build
-    runs-on: windows-latest
-    permissions: write-all
-    if: ${{ github.ref == 'refs/heads/master' }}
-    env:
-      GH_TOKEN: ${{ github.token }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - shell: bash
-        run: |
-          TAG=${{ github.event.release.tag_name }}
-          echo "VERSION=${TAG#v}" >> $GITHUB_ENV
-      - uses: actions/download-artifact@v4
-      - run: |
-          Compress-Archive -Force ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/x86_64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/wix/*x86_64.msi -Destination ./komorebi-$Env:VERSION-x86_64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip" >checksums.txt
-
-          Compress-Archive -Force ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/aarch64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/wix/*aarch64.msi -Destination ./komorebi-$Env:VERSION-aarch64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip" >>checksums.txt
-      - uses: Swatinem/rust-cache@v2
-        with:
-          cache-on-failure: "true"
-          cache-all-crates: "true"
-      - shell: bash
-        run: |
-          if ! type kokai >/dev/null; then cargo install --locked kokai --force; fi
-          git tag -d nightly || true
-          kokai release --no-emoji --add-links github:commits,issues --ref "${{ github.ref_name }}" >"CHANGELOG.md"
-      - uses: softprops/action-gh-release@v2
-        with:
-          draft: true
-          body_path: "CHANGELOG.md"
-          files: |
-            checksums.txt
-            *.zip
-            *.msi
-
-  release:
-    needs: build
-    runs-on: windows-latest
-    permissions: write-all
-    if: startsWith(github.ref, 'refs/tags/v')
-    env:
-      GH_TOKEN: ${{ github.token }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - shell: bash
-        run: |
-          TAG=${{ github.ref_name }}
-          echo "VERSION=${TAG#v}" >> $GITHUB_ENV
-      - uses: actions/download-artifact@v4
-      - run: |
-          Compress-Archive -Force ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/x86_64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-x86_64-pc-windows-msvc-${{ github.sha }}/wix/*x86_64.msi -Destination ./komorebi-$Env:VERSION-x86_64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-x86_64-pc-windows-msvc.zip" >checksums.txt
-
-          Compress-Archive -Force ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/aarch64-pc-windows-msvc/release/*.exe komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip
-          Copy-Item ./komorebi-aarch64-pc-windows-msvc-${{ github.sha }}/wix/*aarch64.msi -Destination ./komorebi-$Env:VERSION-aarch64.msi
-          echo "$((Get-FileHash komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip).Hash.ToLower())  komorebi-$Env:VERSION-aarch64-pc-windows-msvc.zip" >>checksums.txt
-      - uses: Swatinem/rust-cache@v2
-        with:
-          cache-on-failure: "true"
-          cache-all-crates: "true"
-      - shell: bash
-        run: |
-          if ! type kokai >/dev/null; then cargo install --locked kokai --force; fi
-          git tag -d nightly || true
           kokai release --no-emoji --add-links github:commits,issues --ref "$(git tag --points-at HEAD)" >"CHANGELOG.md"
-      - uses: softprops/action-gh-release@v2
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v3
+        if: startsWith(github.ref, 'refs/tags/')
         with:
-          body_path: "CHANGELOG.md"
-          files: |
-            checksums.txt
-            *.zip
-            *.msi
-
-  winget:
-    runs-on: ubuntu-latest
-    needs: release
-    if: startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - uses: vedantmgoyal2009/winget-releaser@main
+          version: latest
+          args: release --skip-validate --rm-dist --release-notes=CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SCOOP_TOKEN: ${{ secrets.SCOOP_TOKEN }}
+      - name: Add MSI to release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
         with:
-          identifier: LGUG2Z.komorebi
-          token: ${{ secrets.WINGET_TOKEN }}
+          files: "target/wix/komorebi-*.msi"

.gitignore

@@ -3,6 +3,4 @@
 /target
 CHANGELOG.md
 dummy.go
-komorebic/applications.yaml
-komorebic/applications.json
-/.vs
+komorebi.ahk

.goreleaser.yml

@@ -0,0 +1,44 @@
+# Adapted from https://jondot.medium.com/shipping-rust-binaries-with-goreleaser-d5aa42a46be0
+project_name: komorebi
+
+before:
+  hooks:
+    - powershell.exe -Command "New-Item -Path . -Name dummy.go -ItemType file -Force"
+    - powershell.exe -Command "Add-Content -Path .\dummy.go -Value 'package main'"
+    - powershell.exe -Command "Add-Content -Path .\dummy.go -Value 'func main() {}'"
+
+builds:
+  - id: komorebi
+    main: dummy.go
+    goos: ["windows"]
+    goarch: ["amd64"]
+    binary: komorebi
+    hooks:
+      post:
+        - mkdir -p dist/windows_amd64
+        - cp ".\target\x86_64-pc-windows-msvc\release\komorebi.exe" ".\dist\komorebi_windows_amd64_v1\komorebi.exe"
+  - id: komorebic
+    main: dummy.go
+    goos: ["windows"]
+    goarch: ["amd64"]
+    binary: komorebic
+    hooks:
+      post:
+        - mkdir -p dist/windows_amd64
+        - cp ".\target\x86_64-pc-windows-msvc\release\komorebic.exe" ".\dist\komorebic_windows_amd64_v1\komorebic.exe"
+
+archives:
+  - replacements:
+      windows: pc-windows-msvc
+      amd64: x86_64
+    format: zip
+    name_template: "{{ .ProjectName }}-{{ .Version }}-{{ .Arch }}-{{ .Os }}"
+    files:
+      - LICENSE
+      - CHANGELOG.md
+
+checksum:
+  name_template: checksums.txt
+
+changelog:
+  sort: asc

CONTRIBUTING.md

@@ -1,45 +0,0 @@
-# Contributing to the Project
-
-The project is a collection of contributions from both the project leaders and
-community members. There are many ways to contribute, this can include content
-in the project repositories, as well as contributing in public and private
-conversation, assisting users, writing blog posts, and many other ways.
-
-## How contributions are made
-
-Contributions to the project primarily happen in the project source
-repositories, but may also occur in other places, such as discussion forums and
-public and private discourse.
-
-## Contributing content to the Project
-
-In order for the project leaders to manage sustained progress toward the
-project goals and maintain project velocity, focus and quality, the project may
-adjust the license terms over time.
-
-Content contributed to the project must therefore be provided under
-sufficiently liberal terms to allow these operations to proceed unimpeded. As
-such contributions are accepted with the following understanding:
-
-* Contributed content is licensed under the terms of the 0-BSD license
-* Contributors accept the terms of the project license at the time of
-  contribution
-
-By making a contribution, you accept both the current project license terms,
-and that all contributions that you have made are provided under the terms of
-the 0-BSD license.
-
-## Zero-Clause BSD
-
-```
-Permission to use, copy, modify, and/or distribute this software for  
-any purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL  
-WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES  
-OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE  
-FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY  
-DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN  
-AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT  
-OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-```

Cargo.toml

@@ -1,87 +1,8 @@
 [workspace]
 
-resolver = "2"
 members = [
+    "derive-ahk",
     "komorebi",
-    "komorebi-client",
-    "komorebi-gui",
+    "komorebi-core",
     "komorebic",
-    "komorebic-no-console",
-    "komorebi-bar",
-    "komorebi-themes"
 ]
-
-[workspace.dependencies]
-clap = { version = "4", features = ["derive", "wrap_help"] }
-chrono = "0.4"
-crossbeam-channel = "0.5"
-crossbeam-utils = "0.8"
-color-eyre = "0.6"
-eframe = "0.31"
-egui_extras = "0.31"
-dirs = "6"
-dunce = "1"
-hotwatch = "0.5"
-schemars = "0.8"
-lazy_static = "1"
-serde = { version = "1", features = ["derive"] }
-serde_json = { package = "serde_json_lenient", version = "0.2" }
-serde_yaml = "0.9"
-strum = { version = "0.27", features = ["derive"] }
-tracing = "0.1"
-tracing-appender = "0.2"
-tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-paste = "1"
-sysinfo = "0.33"
-uds_windows = "1"
-win32-display-data = { git = "https://github.com/LGUG2Z/win32-display-data", rev = "55cebdebfbd68dbd14945a1ba90f6b05b7be2893" }
-windows-numerics = { version = "0.1" }
-windows-implement = { version = "0.59" }
-windows-interface = { version = "0.59" }
-windows-core = { version = "0.60" }
-shadow-rs = "1"
-which = "7"
-
-[workspace.dependencies.windows]
-version = "0.60"
-features = [
-    "Foundation_Numerics",
-    "Win32_Devices",
-    "Win32_Devices_Display",
-    "Win32_System_Com",
-    "Win32_UI_Shell_Common", # for IObjectArray
-    "Win32_Foundation",
-    "Win32_Globalization",
-    "Win32_Graphics_Dwm",
-    "Win32_Graphics_Gdi",
-    "Win32_Graphics_Direct2D",
-    "Win32_Graphics_Direct2D_Common",
-    "Win32_Graphics_Dxgi_Common",
-    "Win32_System_LibraryLoader",
-    "Win32_System_Power",
-    "Win32_System_RemoteDesktop",
-    "Win32_System_Threading",
-    "Win32_UI_Accessibility",
-    "Win32_UI_HiDpi",
-    "Win32_UI_Input_KeyboardAndMouse",
-    "Win32_UI_Shell",
-    "Win32_UI_Shell_Common",
-    "Win32_UI_WindowsAndMessaging",
-    "Win32_System_SystemServices",
-    "Win32_System_WindowsProgramming",
-    "Media",
-    "Media_Control"
-]
-
-[profile.dev-jeezy]
-inherits = "dev"
-debug = false
-opt-level = 1
-
-[profile.dev-jeezy.package."*"]
-opt-level = 3
-
-[profile.release-jeezy]
-inherits = "release"
-incremental = true
-codegen-units = 256

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jade Iqbal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -1,98 +0,0 @@
-# Komorebi License
-
-Version 1.0.0
-
-## Acceptance
-
-In order to get any license under these terms, you must agree
-to them as both strict obligations and conditions to all
-your licenses.
-
-## Copyright License
-
-The licensor grants you a copyright license for the software
-to do everything you might do with the software that would
-otherwise infringe the licensor's copyright in it for any
-permitted purpose. However, you may only make changes according
-to the [Changes License](#changes-license), and you may not
-distribute the software or new works based on the software.
-
-## Changes License
-
-The licensor grants you an additional copyright license to
-make changes for any permitted purpose.
-
-## Patent License
-
-The licensor grants you a patent license for the software that
-covers patent claims the licensor can license, or becomes able
-to license, that you would infringe by using the software.
-
-## Personal Uses
-
-Personal use for research, experiment, and testing for
-the benefit of public knowledge, personal study, private
-entertainment, hobby projects, amateur pursuits, or religious
-observance, without any anticipated commercial application,
-is use for a permitted purpose.
-
-## Fair Use
-
-You may have "fair use" rights for the software under the
-law. These terms do not limit them.
-
-## No Other Rights
-
-These terms do not allow you to sublicense or transfer any of
-your licenses to anyone else, or prevent the licensor from
-granting licenses to anyone else.  These terms do not imply
-any other licenses.
-
-## Patent Defense
-
-If you make any written claim that the software infringes or
-contributes to infringement of any patent, your patent license
-for the software granted under these terms ends immediately. If
-your company makes such a claim, your patent license ends
-immediately for work on behalf of your company.
-
-## Violations
-
-The first time you are notified in writing that you have
-violated any of these terms, or done anything with the software
-not covered by your licenses, your licenses can nonetheless
-continue if you come into full compliance with these terms,
-and take practical steps to correct past violations, within
-32 days of receiving notice.  Otherwise, all your licenses
-end immediately.
-
-## No Liability
-
-***As far as the law allows, the software comes as is, without
-any warranty or condition, and the licensor will not be liable
-to you for any damages arising out of these terms or the use
-or nature of the software, under any kind of legal claim.***
-
-## Definitions
-
-The **licensor** is the individual or entity offering these
-terms, and the **software** is the software the licensor makes
-available under these terms.
-
-**You** refers to the individual or entity agreeing to these
-terms.
-
-**Your company** is any legal entity, sole proprietorship,
-or other kind of organization that you work for, plus all
-organizations that have control over, are under the control of,
-or are under common control with that organization.  **Control**
-means ownership of substantially all the assets of an entity,
-or the power to direct its management and policies by vote,
-contract, or otherwise.  Control can be direct or indirect.
-
-**Your licenses** are all the licenses granted to you for the
-software under these terms.
-
-**Use** means anything you do with the software requiring one
-of your licenses.
-

PRIVACY.md

@@ -1,8 +0,0 @@
-# Privacy Policy for Komorebi
-
-No data about your device(s) or _komorebi_ usage leave your device.
-
-## Data Maintained by Komorebi
-
-_komorebi_ writes log files to and keeps a list of temporary window handles (HWNDs) currently managed by the process in
-the `$Env:LOCALAPPDATA\komorebi\` directory. This directory is owned by the user running the process.

README.md

@@ -2,149 +2,60 @@
 
 Tiling Window Management for Windows.
 
-<p>
-  <a href="https://techforpalestine.org/learn-more">
-    <img alt="Tech for Palestine" src="https://badge.techforpalestine.org/default">
-  </a>
-  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/LGUG2Z/komorebi/.github/workflows/windows.yaml">
-  <img alt="GitHub" src="https://img.shields.io/github/license/LGUG2Z/komorebi">
-  <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/LGUG2Z/komorebi/total">
-  <img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/LGUG2Z/komorebi/latest">
-  <a href="https://discord.gg/mGkn66PHkx">
-    <img alt="Discord" src="https://img.shields.io/discord/898554690126630914">
-  </a>
-  <a href="https://github.com/sponsors/LGUG2Z">
-    <img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/LGUG2Z">
-  </a>
-  <a href="https://ko-fi.com/lgug2z">
-    <img alt="Ko-fi" src="https://img.shields.io/badge/kofi-tip-green">
-  </a>
-  <a href="https://notado.app/feeds/jado/software-development">
-    <img alt="Notado Feed" src="https://img.shields.io/badge/Notado-Subscribe-informational">
-  </a>
-  <a href="https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg?sub_confirmation=1">
-    <img alt="YouTube" src="https://img.shields.io/youtube/channel/subscribers/UCeai3-do-9O4MNy9_xjO6mg">
-  </a>
-</p>
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/LGUG2Z/komorebi/Windows/master)
+![GitHub](https://img.shields.io/github/license/LGUG2Z/komorebi)
+![GitHub all releases](https://img.shields.io/github/downloads/LGUG2Z/komorebi/total)
+![GitHub commits since latest release (by date) for a branch](https://img.shields.io/github/commits-since/LGUG2Z/komorebi/latest/master)
+![Discord](https://img.shields.io/discord/898554690126630914?label=discord)
+![GitHub Sponsors](https://img.shields.io/github/sponsors/LGUG2Z)
 
 ![screenshot](https://user-images.githubusercontent.com/13164844/184027064-f5a6cec2-2865-4d65-a549-a1f1da589abf.png)
 
-## Overview
+## About
 
-_komorebi_ is a tiling window manager that works as an extension to Microsoft's
-[Desktop Window
-Manager](https://docs.microsoft.com/en-us/windows/win32/dwm/dwm-overview) in
-Windows 10 and above.
+_komorebi_ is a tiling window manager that works as an extension to
+Microsoft's [Desktop Window Manager](https://docs.microsoft.com/en-us/windows/win32/dwm/dwm-overview) in Windows 10 and
+above.
 
 _komorebi_ allows you to control application windows, virtual workspaces and display monitors with a CLI which can be
-used with third-party software such as [`whkd`](https://github.com/LGUG2Z/whkd)
-and [AutoHotKey](https://github.com/Lexikos/AutoHotkey_L) to set user-defined keyboard shortcuts.
+used with third-party software such as [AutoHotKey](https://github.com/Lexikos/AutoHotkey_L) to set user-defined
+keyboard shortcuts.
 
-_komorebi_ aims to make _as few modifications as possible_ to the operating
-system and desktop environment by default. Users are free to make such
-modifications in their own configuration files for _komorebi_, but these will
-remain opt-in and off-by-default for the foreseeable future.
+Translations of this document can be found in the project wiki:
 
-Please refer to the [documentation](https://lgug2z.github.io/komorebi) for instructions on how
-to [install](https://lgug2z.github.io/komorebi/installation.html) and
-[configure](https://lgug2z.github.io/komorebi/example-configurations.html)
-_komorebi_, [common workflows](https://lgug2z.github.io/komorebi/common-workflows/komorebi-config-home.html), a complete
-[configuration schema reference](https://komorebi.lgug2z.com/schema) and a
-complete [CLI reference](https://lgug2z.github.io/komorebi/cli/quickstart.html).
+- [komorebi 中文用户指南](https://github.com/LGUG2Z/komorebi/wiki/README-zh) (by [@crosstyan](https://github.com/crosstyan))
 
-## Community
-
-There is a [Discord server](https://discord.gg/mGkn66PHkx) available for
-_komorebi_-related discussion, help, troubleshooting etc. If you have any
-specific feature requests or bugs to report, please create an issue in this
+There is a [Discord server](https://discord.gg/mGkn66PHkx) available for _komorebi_-related discussion, help,
+troubleshooting etc. If you have any specific feature requests or bugs to report, please create an issue in this
 repository.
 
-There is a [YouTube
-channel](https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg) where I post
-_komorebi_ development videos, feature previews and release overviews. Subscribing
-to the channel (which is monetized as part of the YouTube Partner Program) and
-watching videos is a really simple and passive way to contribute financially to
-the development and maintenance of _komorebi_.
+Articles, blog posts, demos, and videos about _komorebi_ can be added to this list by PR:
 
-There is an [Awesome List](https://github.com/LGUG2Z/awesome-komorebi) which
-showcases the many awesome projects that exist in the _komorebi_ ecosystem.
+- [Moving to Windows from Linux Pt 1](https://kvwu.io/posts/moving-to-windows/)
+- [Windows 下的现代化平铺窗口管理器 komorebi](https://zhuanlan.zhihu.com/p/455064481)
 
-## Licensing for Personal Use
+## GitHub Sponsors Early Access
 
-`komorebi` is licensed under the [Komorebi 1.0.0
-license](https://github.com/LGUG2Z/komorebi-license), which is a fork of the
-[PolyForm Strict 1.0.0
-license](https://polyformproject.org/licenses/strict/1.0.0). On a high level
-this means that you are free to do whatever you want with `komorebi` for
-personal use other than redistribution, or distribution of new works (i.e.
-hard-forks) based on the software.
+[GitHub Sponsors is enabled for this project](https://github.com/sponsors/LGUG2Z). Users who sponsor my work
+on `komorebi` at any of the predefined monthly tiers will be given access to a private fork of this repository where I
+push features-in-progress that are not yet quite ready to be pushed on the main repository.
 
-Anyone is free to make their own fork of `komorebi` with changes intended either
-for personal use or for integration back upstream via pull requests.
+There will never be any feature of `komorebi` that is gated behind sponsorship; every new feature will always be
+available for free in the public repository once it meets the requisite level of code quality and completion.
 
-The [Komorebi 1.0.0 License](https://github.com/LGUG2Z/komorebi-license) does
-not permit any kind of commercial use (i.e. using `komorebi` at work).
+Features-in-progress that are available in early access will be tagged in the issues with
+an ["early access" label](https://github.com/LGUG2Z/komorebi/issues?q=is%3Aopen+is%3Aissue+label%3A%22early+access%22).
 
-## Sponsorship for Personal Use
+## Charitable Donations
 
-_komorebi_ is a free and educational source project, and one that encourages you
-to make charitable donations if you find the software to be useful and have the
-financial means.
+`komorebi`, like `vim`, is a free and open-source project, and one that encourages you to make charitable donations if
+you find the software to be useful and have the financial means.
 
-I encourage you to make a charitable donation to the [Palestine Children's
-Relief Fund](https://pcrf1.app.neoncrm.com/forms/gaza-recovery) or to contribute
-to a [Gaza Funds campaign](https://gazafunds.com) before you consider sponsoring
-me on GitHub.
+I encourage you to make a charitable donation
+to [Fresh Start Refugee](https://www.freshstartrefugee.org/donate) before
+you consider sponsoring me on GitHub.
 
-[GitHub Sponsors is enabled for this
-project](https://github.com/sponsors/LGUG2Z). Sponsors can claim custom roles on
-the Discord server, get shout outs at the end of _komorebi_-related videos on
-YouTube, and gain the ability to submit feature requests on the issue tracker.
-
-If you would like to tip or sponsor the project but are unable to use GitHub
-Sponsors, you may also sponsor through [Ko-fi](https://ko-fi.com/lgug2z), or
-make an anonymous Bitcoin donation to `bc1qv73wzspc77k46uty4vp85x8sdp24mphvm58f6q`.
-
-## Licensing for Commercial Use
-
-A dedicated Individual Commercial Use License is available for those who want to
-use `komorebi` at work.
-
-The Individual Commerical Use License adds “Commercial Use” as a “Permitted Use”
-for the licensed individual only, for the duration of a valid paid license
-subscription only. All provisions and restrictions enumerated in the [Komorebi
-License](https://github.com/LGUG2Z/komorebi-license) continue to apply.
-
-More information, pricing and purchase links for Individual Commercial Use
-Licenses [can be found here](https://lgug2z.com/software/komorebi).
-
-# Installation
-
-A [detailed installation and quickstart
-guide](https://lgug2z.github.io/komorebi/installation.html) is available which shows how to get started
-using `scoop`, `winget` or building from source.
-
-[![Watch the quickstart walkthrough video](https://img.youtube.com/vi/MMZUAtHbTYY/hqdefault.jpg)](https://www.youtube.com/watch?v=MMZUAtHbTYY)
-
-# Comparison With Fancy Zones
-
-Community member [Olge](https://www.youtube.com/@polle5555) has created an
-excellent video which compares the default window management features of
-Windows 11, Fancy Zones and komorebi.
-
-If you are not familiar with tiling window managers or if you are looking at
-komorebi and wondering "how is this different from Fancy Zones? 🤔", this short
-video will answer the majority of your questions.
-
-[![Watch the comparison video](https://img.youtube.com/vi/0LCbS_gm0RA/hqdefault.jpg)](https://www.youtube.com/watch?v=0LCbS_gm0RA)
-
-# Demonstrations
-
-[@amnweb](https://github.com/amnweb) showing _komorebi_ `v0.1.28` running on Windows 11 with window borders,
-unfocused window transparency and animations enabled, using a custom status bar integrated using
-_komorebi_'s [Window Manager Event Subscriptions](https://github.com/LGUG2Z/komorebi?tab=readme-ov-file#window-manager-event-subscriptions).
-
-https://github.com/LGUG2Z/komorebi/assets/13164844/21be8dc4-fa76-4f70-9b37-1d316f4b40c2
+## Demonstrations
 
 [@haxibami](https://github.com/haxibami) showing _komorebi_ running on Windows
 11 with a terminal emulator, a web browser and a code editor. The original
@@ -161,80 +72,510 @@ widget enabled. The original video can be viewed
 
 https://user-images.githubusercontent.com/13164844/163496414-a9cde3d1-b8a7-4a7a-96fb-a8985380bc70.mp4
 
-# Contribution Guidelines
+## Description
 
-If you would like to contribute to `komorebi` please take the time to carefully
-read the guidelines below.
+_komorebi_ only responds to [WinEvents](https://docs.microsoft.com/en-us/windows/win32/winauto/event-constants) and the
+messages it receives on a dedicated socket.
 
-Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about how
-code contributions to `komorebi` are licensed.
+_komorebic_ is a CLI that writes messages on _komorebi_'s socket.
 
-## Commit hygiene
+_komorebi_ doesn't handle any keyboard or mouse inputs; a third party program (e.g. AutoHotKey) is needed in order to
+translate keyboard and mouse events to _komorebic_ commands.
+
+This architecture, popularised by [_bspwm_](https://github.com/baskerville/bspwm) on Linux and
+[_yabai_](https://github.com/koekeishiya/yabai) on macOS, is outlined as follows:
+
+```
+     PROCESS                SOCKET
+ahk  -------->  komorebic  <------>  komorebi
+```
+
+## Design
+
+_komorebi_ is the successor to [_yatta_](https://github.com/LGUG2Z/yatta) and as such aims to build on the learnings
+from that project.
+
+While _yatta_ was primary an attempt to learn how to work with and call Windows APIs from Rust, while secondarily
+implementing a minimal viable tiling window manager for my own needs (largely single monitor, single workspace),
+_komorebi_ has been redesigned from the ground-up to support more complex features that have become standard in tiling
+window managers on other platforms.
+
+_komorebi_ holds a list of physical monitors.
+
+A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.
+
+A workspace holds a list of containers.
+
+A container is just a rectangle where one or more application windows can be displayed.
+
+This means that:
+
+- Every monitor has its own collection of virtual workspaces
+- Workspaces only know about containers and their dimensions, not about individual application windows
+- Every application window must belong to a container, even if that container only contains one application window
+- Many application windows can be stacked and cycled through in the same container within a workspace
+
+## Getting Started
+
+### GitHub Releases
+
+Prebuilt binaries are available on the [releases page](https://github.com/LGUG2Z/komorebi/releases) in a `zip` archive.
+Once downloaded, you will need to move the `komorebi.exe` and `komorebic.exe` binaries to a directory in your `Path` (
+you can see these directories by running `$Env:Path.split(";")` at a PowerShell prompt).
+
+Alternatively, you may add a new directory to your `Path`
+using [`setx`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx) or the Environment
+Variables pop up in System Properties Advanced (which can be launched with `SystemPropertiesAdvanced.exe` at a
+PowerShell prompt), and then move the binaries to that directory.
+
+### Scoop
+
+If you use the [Scoop](https://scoop.sh/) command line installer, you can run the following commands to install the
+binaries from the latest GitHub Release:
+
+```powershell
+scoop bucket add extras
+scoop install komorebi
+
+# To download the example configuration
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.generated.ahk -OutFile $Env:USERPROFILE\komorebi.generated.ahk
+```
+
+If you install _komorebi_ using Scoop, the binaries will automatically be added to your `Path`.
+
+Thanks to [@sitiom](https://github.com/sitiom) for getting _komorebi_ added to the popular Scoop Extras bucket.
+
+### Building from Source
+
+If you prefer to compile _komorebi_ from source, you will need
+a [working Rust development environment on Windows 10](https://rustup.rs/). The `x86_64-pc-windows-msvc` toolchain is
+required, so make sure you have also installed
+the [Build Tools for Visual Studio 2019](https://stackoverflow.com/a/55603112).
+
+You can then clone this repo and compile the source code to install the binaries for `komorebi` and `komorebic`:
+
+```powershell
+cargo install --path komorebi --locked
+cargo install --path komorebic --locked
+```
+
+### Running
+
+Once you have either the prebuilt binaries in your `Path`, or have compiled the binaries from source (these will already
+be in your `Path` if you installed Rust with [rustup](https://rustup.rs), which you absolutely should), you can
+run `komorebic start --await-configuration` at a Powershell prompt, and you will see the following output:
+
+```
+Start-Process komorebi -WindowStyle hidden
+```
+
+This means that `komorebi` is now running in the background, tiling all your windows, and listening for commands sent to
+it by `komorebic`. You can similarly stop the process by running `komorebic stop`.
+
+### Configuring
+
+Once `komorebi` is running, you can execute the `komorebi.sample.ahk` script to set up the default keybindings via AHK
+(the file includes comments to help you start building your own configuration).
+
+If you have AutoHotKey installed and a `komorebi.ahk` file in your home directory (run `$Env:UserProfile` at a
+PowerShell prompt to find your home directory), `komorebi` will automatically try to load it when starting.
+
+There is also tentative support for loading a AutoHotKey v2 files, if the file is named `komorebi.ahk2` and
+the `AutoHotKey64.exe` executable for AutoHotKey v2 is in your `Path`. If both `komorebi.ahk` and `komorebi.ahk2` files
+exist in your home directory, only `komorebi.ahk` will be loaded. An example of an AutoHotKey v2 configuration file
+for _komorebi_ can be found [here](https://gist.github.com/crosstyan/dafacc0778dabf693ce9236c57b201cd).
+
+#### Using Different AHK Executables
+
+The preferred way to install AutoHotKey for use with `komorebi` is to install it via `scoop`:
+
+```powershell
+scoop install autohotkey
+```
+
+If you install AutoHotKey using a different method, the name of the executable file may differ from the name given by
+`scoop`, and thus what is expected by default in `komorebi`.
+
+You may override the executables that `komorebi` looks for to launch and reload `komorebi.ahk` configuration files using
+by setting one of the following two environment variables depending on which version of AutoHotKey you wish to use:
+
+- `$Env:KOMOREBI_AHK_V1_EXE`
+- `$Env:KOMOREBI_AHK_V2_EXE`
+
+Please keep in mind that even when setting a custom executable name using these environment variables, the executables
+are still required to be in your `Path`.
+
+### Common First-Time Tips
+
+#### Generating Common Application-Specific Configurations
+
+A curated selection of application-specific configurations can be generated to
+help ease the setup for first-time users.
+[`komorebi-application-specific-configuration`](https://github.com/LGUG2Z/komorebi-application-specific-configuration)
+contains YAML definitions of settings that are known to make tricky
+applications behave as expected. These YAML definitions can be used to generate
+an AHK file which you can import at the start of your own `komorebi.ahk` file,
+leaving you to focus primarily on your desired keybindings and workspace
+configurations.
+
+If you have settings for an application that you think should be part of this
+curated selection, please open a PR on the configuration repository.
+
+In the event that your PR is not accepted, or if you find there are any
+settings that you wish to override, this can easily be done using an override
+file.
+
+```powershell
+# Clone and enter the repository
+git clone https://github.com/LGUG2Z/komorebi-application-specific-configuration.git
+cd komorebi-application-specific-configuration
+
+# Use komorebic to generate an AHK file
+komorebic.exe ahk-app-specific-configuration applications.yaml
+
+# Application-specific generated configuration written to C:\Users\LGUG2Z\.config\komorebi\komorebi.generated.ahk
+#
+# You can include the generated configuration at the top of your komorebi.ahk config with this line:
+#
+# #Include %A_ScriptDir%\komorebi.generated.ahk
+
+# Optionally, provide an override file that follows the same schema as the second argument
+komorebic.exe ahk-app-specific-configuration applications.yaml overrides.yaml
+```
+
+#### Setting a Custom KOMOREBI_CONFIG_HOME Directory
+
+If you do not want to keep _komorebi_-related files in your `$Env:UserProfile` directory, you can specify a custom directory
+by setting the `$Env:KOMOREBI_CONFIG_HOME` environment variable.
+
+For example, to use the `~/.config/komorebi` directory:
+
+```powershell
+# Run this command to make sure that the directory has been created
+mkdir -p ~/.config/komorebi
+
+# Run this command to open up your PowerShell profile configuration in Notepad
+notepad $PROFILE
+
+# Add this line (with your login user!) to the bottom of your PowerShell profile configuration
+$Env:KOMOREBI_CONFIG_HOME = 'C:\Users\LGUG2Z\.config\komorebi'
+
+# Save the changes and then reload the PowerShell profile
+. $PROFILE
+```
+
+If you already have configuration files that you wish to keep, move them to the `~/.config/komorebi` directory.
+
+The next time you run `komorebic start`, any files created by or loaded by _komorebi_ will be placed or expected to
+exist in this folder.
+
+#### Adding an Active Window Border
+
+If you would like to add a visual border around the currently focused window, two commands are available:
+
+```powershell
+komorebic.exe active-window-border [enable|disable]
+komorebic.exe active-window-border-colour [R G B] --window-kind single
+
+# optionally, if you want a different colour for stacks of windows
+komorebic.exe active-window-border-colour [R G B] --window-kind stack
+```
+
+It is important to note that the active window border will only apply to windows managed by `komorebi`.
+
+#### Removing Gaps
+
+If you would like to remove all gaps from a given workspace, both between windows themselves, and between the monitor edges and the windows, you can set the following two configuration options to `0` for the desired monitors and workspaces:
+
+```powershell
+komorebic.exe container-padding <MONITOR_INDEX> <WORKSPACE_INDEX> 0
+komorebic.exe workspace padding <MONITOR_INDEX> <WORKSPACE_INDEX> 0
+```
+
+#### Multiple Layout Changes on Startup
+
+Depending on what is in your configuration, when `komorebi` is started, you may experience the layout rapidly being adjusted
+with many retile events.
+
+If you would like to avoid this, you can start `komorebi` with a flag which tells `komorebi` to wait until all configuration
+has been loaded before listening to and responding to window manager events: `komorebic start --await-configuration`.
+
+If you start `komorebi` with the `--await-configuration` flag, you _must_ send the `komorebic complete-configuration`
+command at the end of the configuration section of your `komorebi.ahk` config (before you start defining the key
+bindings). The layout will not be updated and `komorebi` will not respond to `komorebic` commands until this command has
+been received.
+
+#### Floating Windows
+
+Sometimes you will want a specific application to never be tiled, and instead float all the time. You add add rules to
+enforce this behaviour:
+
+```powershell
+komorebic.exe float-rule title "Control Panel"
+# komorebic.exe float-rule exe [EXE NAME]
+# komorebic.exe float-rule class [CLASS NAME]
+```
+
+#### Windows Not Getting Managed
+
+In some rare cases, a window may not automatically be registered to be managed by `komorebi`. When this happens, you can
+manually add a rule to force `komorebi` to manage it:
+
+```powershell
+komorebic.exe manage-rule exe TIM.exe
+# komorebic.exe manage-rule class [CLASS NAME]
+# komorebic.exe manage-rule title [TITLE]
+```
+
+#### Tray Applications
+
+If you are experiencing behaviour where
+[closing a window leaves a blank tile, but minimizing the same window does not](https://github.com/LGUG2Z/komorebi/issues/6)
+, you have probably enabled a 'close/minimize to tray' option for that application. You can tell _komorebi_ to handle
+this application appropriately by identifying it via the executable name or the window class:
+
+```powershell
+komorebic.exe identify-tray-application exe Discord.exe
+# komorebic.exe identify-tray-application class [CLASS NAME]
+# komorebic.exe identify-tray-application title [TITLE]
+```
+
+#### Microsoft Office Applications
+
+Microsoft Office applications such as Word and Excel require certain configuration options to be set in order to be
+managed correctly. Below is an example of configuring Microsoft Word to be managed correctly by _komorebi_.
+
+```powershell
+# This only needs to be added once
+komorebic.exe float-rule class _WwB
+
+# Repeat these for other office applications such as EXCEL.EXE etc
+# Note that the capitalised EXE is important here- double check the
+# exact case for the name and the file extension in Task Manager or
+# the AHK Window Spy
+
+komorebic.exe identify-layered-application exe WINWORD.EXE
+komorebic.exe identify-border-overflow-application exe WINWORD.EXE
+```
+
+#### Focus Follows Mouse
+
+`komorebi` supports two focus-follows-mouse implementations; the native Windows Xmouse implementation, which treats the
+desktop, the task bar, and the system tray as windows and switches focus to them eagerly, and a custom `komorebi`
+implementation, which only considers windows managed by `komorebi` as valid targets to switch focus to when moving the
+mouse.
+
+To enable the `komorebi` implementation you must start the process with the `--ffm` flag to explicitly enable the feature.
+This is because the mouse tracking required for this feature significantly increases the CPU usage of the process (on my
+machine, it jumps from <1% to ~4~), and this CPU increase persists regardless of whether focus-follows-mouse is enabled
+or disabled at any given time via `komorebic`'s configuration commands.
+
+When calling any of the `komorebic` commands related to focus-follows-mouse functionality, the `windows`
+implementation will be chosen as the default implementation. You can optionally specify the `komorebi` implementation by
+passing it as an argument to the `--implementation` flag:
+
+```powershell
+komorebic.exe toggle-focus-follows-mouse --implementation komorebi
+```
+
+#### Mouse Follows Focus
+
+By default, the mouse will move to the center of the window when the focus is changed in a given direction. This
+behaviour is know is 'mouse follows focus'. To disable this behaviour across all workspaces, add the following command
+to your configuration file:
+
+```ahk
+Run, komorebic.exe toggle-mouse-follows-focus, , Hide
+```
+
+#### Saving and Loading Resized Layouts
+
+If you create a BSP layout through various resize adjustments that you want to be able to restore easily in the future,
+it is possible to "quicksave" that layout to the system's temporary folder and load it later in the same session, or
+alternatively, you may save it to a specific file to be loaded again at any point in the future.
+
+```powershell
+komorebic.exe quick-save # saves the focused workspace to $Env:TEMP\komorebi.quicksave.json
+komorebic.exe quick-load # loads $Env:TEMP\komorebi.quicksave.json on the focused workspace
+
+komorebic.exe save ~/layouts/primary.json # saves the focused workspace to $Env:USERPROFILE\layouts\primary.json
+komorebic.exe load ~/layouts/secondary.json # loads $Env:USERPROFILE\layouts\secondary.json on the focused workspace
+```
+
+These layouts can be applied to arbitrary collections of windows on any workspace, as they only track the layout
+dimensions and are not coupled to the applications that were running at the time of saving.
+
+When layouts that expect more or less windows than the number currently on the focused workspace are loaded, `komorebi`
+will automatically reconcile the difference.
+
+#### Creating and Loading Custom Layouts
+
+Particularly for users of ultrawide monitors, traditional tiling layouts may not seem like the most efficient use of
+screen space. If you feel this is the case with any of the default layouts, you are also welcome to create your own
+custom layouts and save them as JSON or YAML.
+
+If you're not comfortable writing the layouts directly in JSON or YAML, you can use
+the [komorebi Custom Layout Generator](https://lgug2z.github.io/komorebi-custom-layout-generator/) to interactively
+define a custom layout, and then copy the generated JSON content.
+
+Custom layouts can be loaded on the current workspace or configured for a specific workspace with the following
+commands:
+
+```powershell
+komorebic.exe load-custom-layout ~/custom.yaml
+komorebic.exe workspace-custom-layout 0 0 ~/custom.yaml
+```
+
+The fundamental building block of a custom _komorebi_ layout is the Column.
+
+Columns come in three variants:
+
+- **Primary**: This is where your primary focus will be on the screen most of the time. There must be exactly one Primary
+  Column in any custom layout. Optionally, you can specify the percentage of the screen width that you want the Primary
+  Column to occupy.
+- **Secondary**: This is an optional column that can either be full height of split horizontally into a fixed number of
+  maximum rows. There can be any number of Secondary Columns in a custom layout.
+- **Tertiary**: This is the final column where any remaining windows will be split horizontally into rows as they get added.
+
+If there is only one window on the screen when a custom layout is selected, that window will take up the full work area
+of the screen.
+
+If the number of windows is equal to or less than the total number of columns defined in a custom layout, the windows
+will be arranged in an equal-width columns.
+
+When the number of windows is greater than the number of columns defined in the custom layout, the windows will begin to
+be arranged according to the constraints set on the Primary and Secondary columns of the layout.
+
+Here is an example custom layout that can be used as a starting point for your own:
+
+YAML
+
+```yaml
+- column: Secondary
+  configuration: !Horizontal 2 # max number of rows
+- column: Primary
+  configuration: !WidthPercentage 50 # percentage of screen
+- column: Tertiary
+  configuration: Horizontal
+```
+
+#### Dynamically Changing Layouts Based on Number of Visible Window Containers
+
+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.
+
+```powershell
+# On the first workspace of the first monitor (0 0)
+# When there are one or more window containers visible on the screen (1)
+# Use the bsp layout (bsp)
+komorebic workspace-layout-rule 0 0 1 bsp
+
+# On the first workspace of the first monitor (0 0)
+# When there are five or more window containers visible on the screen (five)
+# Use the custom layout stored in the home directory (~/custom.yaml)
+komorebic workspace-custom-layout-rule 0 0 5 ~/custom.yaml
+```
+
+However, if you add workspace layout rules, you will not be able to manually change the layout of a workspace until all
+layout rules for that workspace have been cleared.
+
+```powershell
+# If you decide that workspace layout rules are not for you, you can remove them from that same workspace like this
+komorebic clear-workspace-layout-rules 0 0
+```
+
+## Configuration with `komorebic`
+
+As previously mentioned, this project does not handle anything related to keybindings and shortcuts directly. I
+personally use AutoHotKey to manage my window management shortcuts, and have provided a
+sample [komorebi.ahk](komorebi.sample.ahk) AHK script that you can use as a starting point for your own.
+
+You can run `komorebic.exe` to get a full list of the commands that you can use to customise `komorebi` and create
+keybindings with. You can run `komorebic.exe <COMMAND> --help` to get a full explanation of the arguments required for
+each command.
+
+### AutoHotKey Helper Library for `komorebic`
+
+Additionally, you may run `komorebic.exe ahk-library` to
+generate [a helper library for AutoHotKey](komorebic.lib.sample.ahk) which wraps every `komorebic` command in a native
+AHK function.
+
+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. A sample AHK script that shows how this library can be
+used [is available here](komorebi.sample.with.lib.ahk).
+
+## Features
+
+- [x] Multi-monitor
+- [x] Virtual workspaces
+- [x] Window stacks
+- [x] Cycle through stacked windows
+- [x] Change focused window by direction
+- [x] Change focused window by direction across monitor boundary
+- [x] Move focused window container in direction
+- [x] Move focused window container in direction across monitor boundary
+- [x] Move focused window container to monitor and follow
+- [x] Move focused window container to workspace follow
+- [x] Send focused window container to monitor
+- [x] Send focused window container to workspace
+- [x] Move focused workspace to monitor
+- [x] Mouse follows focused container
+- [x] Resize window container in direction
+- [x] Resize window container on axis
+- [x] Set custom resize delta
+- [x] Active window border
+- [x] Quicksave and quickload layouts with resize dimensions
+- [x] Save and load layouts with resize dimensions to/from specific files
+- [x] Mouse drag to swap window container position
+- [x] Mouse drag to resize window container
+- [x] Configurable workspace and container gaps
+- [x] BSP tree layout (`bsp`)
+- [x] Flip BSP tree layout horizontally or vertically
+- [x] Equal-width, max-height column layout (`columns`)
+- [x] Equal-height, max-width row layout (`rows`)
+- [x] Main half-height window with vertical stack layout (`horizontal-stack`)
+- [x] Main half-width window with horizontal stack layout (`vertical-stack`)
+- [x] 2x Main window (half and quarter-width) with horizontal stack layout (`ultrawide-vertical-stack`)
+- [x] Load custom layouts from JSON and YAML representations
+- [x] Dynamically select layout based on the number of open windows
+- [x] Floating rules based on exe name, window title and class
+- [x] Workspace rules based on exe name and window class
+- [x] Additional manage rules based on exe name and window class
+- [x] Identify applications which overflow their borders by exe name and class
+- [x] Identify 'close/minimize to tray' applications by exe name and class
+- [x] Configure work area offsets to preserve space for custom taskbars
+- [x] Configure and compensate for the size of Windows invisible borders
+- [x] Toggle floating windows
+- [x] Toggle monocle window
+- [x] Toggle native maximization
+- [x] Toggle mouse follows focus
+- [x] Toggle Xmouse/Windows focus follows mouse implementation
+- [x] Toggle Komorebi focus follows mouse implementation (desktop and system tray-aware)
+- [x] Toggle automatic tiling
+- [x] Pause all window management
+- [x] Load configuration on startup
+- [x] Manually reload configuration
+- [x] Watch configuration for changes
+- [x] Helper library for AutoHotKey
+- [x] View window manager state
+- [x] Query window manager state
+- [x] Subscribe to event and message notifications
+
+## Development
+
+If you would like to contribute code to this repository, there are a few requests that I have to ensure a foundation of
+code quality, consistency and commit hygiene:
 
 - Flatten all `use` statements
-- Run `cargo +stable clippy` and ensure that all lints and suggestions have been addressed before committing
+- Run `cargo +nightly clippy` and ensure that all lints and suggestions have been addressed before committing
 - Run `cargo +nightly fmt --all` to ensure consistent formatting before committing
 - Use `git cz` with
   the [Commitizen CLI](https://github.com/commitizen/cz-cli#conventional-commit-messages-as-a-global-utility) to prepare
   commit messages
-- Provide **at least** one short sentence or paragraph in your commit message body to describe your thought process for
-  the changes being committed
-
-## PRs should contain only a single feature or bug fix
-
-It is very difficult to review pull requests which touch multiple unrelated features and parts of the codebase.
-
-Please do not submit pull requests like this; you will be asked to separate them into smaller PRs that deal only with
-one feature or bug fix at a time.
-
-If you are working on multiple features and bug fixes, I suggest that you cut a branch called `local-trunk`
-from `master` which you keep up to date, and rebase the various independent branches you are working on onto that branch
-if you want to test them together or create a build with everything integrated.
-
-## Refactors to the codebase must have prior approval
-
-`komorebi` is a mature codebase with an internal consistency and structure that has developed organically over close to
-half a decade.
-
-There are [countless hours of live coding videos](https://youtube.com/@LGUG2Z) demonstrating work on this project and
-showing new contributors how to do everything from basic tasks like implementing new `komorebic` commands to
-distinguishing monitors by manufacturer hardware identifiers and video card ports.
-
-Refactors to the structure of the codebase are not taken lightly and require prior discussion and approval.
-
-Please do not start refactoring the codebase with the expectation of having your changes integrated until you receive an
-explicit approval or a request to do so.
-
-Similarly, when implementing features and bug fixes, please stick to the structure of the codebase as much as possible
-and do not take this as an opportunity to do some "refactoring along the way".
-
-It is extremely difficult to review PRs for features and bug fixes if they are lost in sweeping changes to the structure
-of the codebase.
-
-## Breaking changes to user-facing interfaces are unacceptable
-
-This includes but is not limited to:
-
-- All `komorebic` commands
-- The `komorebi.json` schema
-- The [
-  `komorebi-application-specific-configuration`](https://github.com/LGUG2Z/komorebi-application-specific-configuration)
-  schema
-
-No user should ever find that their configuration file has stopped working after upgrading to a new version
-of `komorebi`.
-
-More often than not there are ways to reformulate changes that may initially seem like they require breaking user-facing
-interfaces into additive changes.
-
-For some inspiration please take a look
-at [this commit](https://github.com/LGUG2Z/komorebi/commit/e7d928a065eb63bb4ea1fb864c69c1cae8cc763b) which added the
-ability for users to specify colours in `komorebi.json` in Hex format alongside RGB.
-
-There is also a process in place for graceful, non-breaking, deprecation of configuration options that are no longer
-required.
-
-# Development
+- Provide at least one short sentence or paragraph in your commit message body to describe your thought process for the
+  changes being committed
 
 If you use IntelliJ, you should enable the following settings to ensure that code generated by macros is recognised by
 the IDE for completions and navigation:
@@ -242,13 +583,13 @@ the IDE for completions and navigation:
 - Set `Expand declarative macros`
   to `Use new engine` under "Settings > Langauges & Frameworks > Rust"
 - Enable the following experimental features:
-    - `org.rust.cargo.evaluate.build.scripts`
-    - `org.rust.macros.proc`
+  - `org.rust.cargo.evaluate.build.scripts`
+  - `org.rust.macros.proc`
 
-# Logs and Debugging
+## Logs and Debugging
 
-Logs from `komorebi` will be appended to `%LOCALAPPDATA%/komorebi/komorebi.log`; this file is never rotated or
-overwritten, so it will keep growing until it is deleted by the user.
+Logs from `komorebi` will be appended to `%LOCALAPPDATA%/komorebi/komorebi.log`; this file is never rotated or overwritten, so it will keep
+growing until it is deleted by the user.
 
 Whenever running the `komorebic stop` command or sending a Ctrl-C signal to `komorebi` directly, the `komorebi` process
 ensures that all hidden windows are restored before termination.
@@ -256,12 +597,12 @@ ensures that all hidden windows are restored before termination.
 If however, you ever end up with windows that are hidden and cannot be restored, a list of window handles known
 to `komorebi` are stored and continuously updated in `%LOCALAPPDATA%/komorebi//komorebi.hwnd.json`.
 
-## Restoring Windows
+### Restoring Windows
 
 Running `komorebic restore-windows` will read the list of window handles and forcibly restore them, regardless of
 whether the main `komorebi` process is running.
 
-## Panics and Deadlocks
+### Panics and Deadlocks
 
 If `komorebi` ever stops responding, it is most likely either due to either a panic or a deadlock. In the case of a
 panic, this will be reported in the log. In the case of a deadlock, there will not be any errors in the log, but the
@@ -271,24 +612,23 @@ If you believe you have encountered a deadlock, you can compile `komorebi` with
 reproducing the deadlock again. This will check for deadlocks every 5 seconds in the background, and if a deadlock is
 found, information about it will appear in the log which can be shared when opening an issue.
 
-# Window Manager State and Integrations
+## Window Manager State and Integrations
 
 The current state of the window manager can be queried using the `komorebic state` command, which returns a JSON
-representation of the `State` struct.
+representation of the `State` struct, which includes the current state of `WindowManager`.
 
-This may also be polled to build further integrations and widgets on top of.
+This may also be polled to build further integrations and widgets on top of (if you ever wanted to build something
+like [Stackline](https://github.com/AdamWagner/stackline) for Windows, you could do it by polling this command).
 
-# Window Manager Event Subscriptions
+## Window Manager Event Subscriptions
 
-## Named Pipes
-
-It is possible to subscribe to notifications of every `WindowManagerEvent` and `SocketMessage` handled
+It is also possible to subscribe to notifications of every `WindowManagerEvent` and `SocketMessage` handled
 by `komorebi` using [Named Pipes](https://docs.microsoft.com/en-us/windows/win32/ipc/named-pipes).
 
 First, your application must create a named pipe. Once the named pipe has been created, run the following command:
 
 ```powershell
-komorebic.exe subscribe-pipe <your pipe name>
+komorebic.exe subscribe <your pipe name>
 ```
 
 Note that you do not have to include the full path of the named pipe, just the name.
@@ -310,142 +650,29 @@ If the named pipe exists, `komorebi` will start pushing JSON data of successfull
 
 You may then filter on the `type` key to listen to the events that you are interested in. For a full list of possible
 notification types, refer to the enum variants of `WindowManagerEvent` in `komorebi` and `SocketMessage`
-in `komorebi::core`.
+in `komorebi-core`.
 
-Below is an example of how you can subscribe to and filter on events using a named pipe in `nodejs`.
+An example of how to create a named pipe and a subscription to `komorebi`'s handled events in Python
+by [@denBot](https://github.com/denBot) can be
+found [here](https://gist.github.com/denBot/4136279812f87819f86d99eba77c1ee0).
 
-```javascript
-const { exec } = require("child_process");
-const net = require("net");
+An example of how to create a named pipe and a subscription to `komorebi`'s handled events in Rust can also be found
+in the [`komokana`](https://github.com/LGUG2Z/komokana) repository.
 
-const pipeName = "\\\\.\\pipe\\komorebi-js";
-const server = net.createServer((stream) => {
-  console.log("Client connected");
-
-  // Every time there is a workspace-related event, let's log the names of all
-  // workspaces on the currently focused monitor, and then log the name of the
-  // currently focused workspace on that monitor
-
-  stream.on("data", (data) => {
-    let json = JSON.parse(data.toString());
-    let event = json.event;
-
-    if (event.type.includes("Workspace")) {
-      let monitors = json.state.monitors;
-      let current_monitor = monitors.elements[monitors.focused];
-      let workspaces = monitors.elements[monitors.focused].workspaces;
-      let current_workspace = workspaces.elements[workspaces.focused];
-
-      console.log(
-        workspaces.elements
-          .map((workspace) => workspace.name)
-          .filter((name) => name !== null)
-      );
-      console.log(current_workspace.name);
-    }
-  });
-
-  stream.on("end", () => {
-    console.log("Client disconnected");
-  });
-});
-
-server.listen(pipeName, () => {
-  console.log("Named pipe server listening");
-});
-
-const command = "komorebic subscribe-pipe komorebi-js";
-
-exec(command, (error, stdout, stderr) => {
-  if (error) {
-    console.error(`Error executing command: ${error}`);
-    return;
-  }
-});
-```
-
-## Unix Domain Sockets
-
-It is possible to subscribe to notifications of every `WindowManagerEvent` and `SocketMessage` handled
-by `komorebi` using [Unix Domain Sockets](https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/).
-
-UDS are also the only mode of communication between `komorebi` and `komorebic`.
-
-First, your application must create a socket in `$ENV:LocalAppData\komorebi`. Once the socket has been created, run the
-following command:
-
-```powershell
-komorebic.exe subscribe-socket <your socket name>
-```
-
-If the socket exists, komorebi will start pushing JSON data of successfully handled events and messages as in the
-example above in the Named Pipes section.
-
-## Rust Client
-
-As of `v0.1.22` it is possible to use the `komorebi-client` crate to subscribe to notifications of
-every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a Rust codebase.
-
-Below is a simple example of how to use `komorebi-client` in a basic Rust application.
-
-```rust
-// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.34"}
-
-use anyhow::Result;
-use komorebi_client::Notification;
-use komorebi_client::NotificationEvent;
-use komorebi_client::UnixListener;
-use komorebi_client::WindowManagerEvent;
-use std::io::BufRead;
-use std::io::BufReader;
-use std::io::Read;
-
-pub fn main() -> anyhow::Result<()> {
-  let socket = komorebi_client::subscribe(NAME)?;
-
-  for incoming in socket.incoming() {
-    match incoming {
-      Ok(data) => {
-        let reader = BufReader::new(data.try_clone()?);
-
-        for line in reader.lines().flatten() {
-          let notification: Notification = match serde_json::from_str(&line) {
-            Ok(notification) => notification,
-            Err(error) => {
-              log::debug!("discarding malformed komorebi notification: {error}");
-              continue;
-            }
-          };
-
-          // match and filter on desired notifications
-        }
-      }
-      Err(error) => {
-        log::debug!("{error}");
-      }
-    }
-  }
-
-}
-```
-
-A read-world example can be found
-in [komokana](https://github.com/LGUG2Z/komokana/blob/feature/komorebi-uds/src/main.rs).
-
-## Subscription Event Notification Schema
+### Subscription Event Notification Schema
 
 A [JSON Schema](https://json-schema.org/) of the event notifications emitted to subscribers can be generated with
 the `komorebic notification-schema` command. The output of this command can be redirected to the clipboard or a file,
 which can be used with services such as [Quicktype](https://app.quicktype.io/) to generate type definitions in different
 programming languages.
 
-## Communication over TCP
+### Communication over TCP
 
 A TCP listener can optionally be exposed on a port of your choosing with the `--tcp-port=N` flag. If this flag is not
 provided to `komorebi` or `komorebic start`, no TCP listener will be created.
 
 Once created, your client may send
-any [SocketMessage](https://github.com/LGUG2Z/komorebi/blob/master/komorebi/src/core/mod.rs#L37) to `komorebi` in the
+any [SocketMessage](https://github.com/LGUG2Z/komorebi/blob/master/komorebi-core/src/lib.rs#L37) to `komorebi` in the
 same way that `komorebic` would.
 
 This can be used if you would like to create your own alternative to `komorebic` which incorporates scripting and
@@ -455,26 +682,9 @@ a [custom input handler](https://github.com/LGUG2Z/komorebi/issues/176#issue-130
 If a client sends an unrecognized message, it will be disconnected and have to reconnect before trying to communicate
 again.
 
-## Socket Message Schema
+### Socket Message Schema
 
 A [JSON Schema](https://json-schema.org/) of socket messages used to send instructions to `komorebi` can be generated
 with the `komorebic socket-schema` command. The output of this command can be redirected to the clipboard or a file,
 which can be used with services such as [Quicktype](https://app.quicktype.io/) to generate type definitions in different
 programming languages.
-
-# Appreciations
-
-- First and foremost, thank you to my wife, both for naming this project and for her patience throughout its
-  never-ending development
-
-- Thank you to [@sitiom](https://github.com/sitiom) for
-  being [an exemplary open source community leader](https://jeezy.substack.com/p/the-open-source-contributions-i-appreciate)
-
-- Thank you to the developers of [nog](https://github.com/TimUntersberger/nog) who came before me and whose work taught
-  me more than I can ever hope to repay
-
-- Thank you to the developers of [GlazeWM](https://github.com/lars-berger/GlazeWM) for pushing the boundaries of tiling
-  window management on Windows with me and having an excellent spirit of collaboration
-
-- Thank you to [@Ciantic](https://github.com/Ciantic) for helping me bring
-  the [hidden Virtual Desktops cloaking function](https://github.com/Ciantic/AltTabAccessor/issues/1) to `komorebi`

derive-ahk/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "derive-ahk"
+version = "0.1.1"
+edition = "2021"
+
+[lib]
+proc-macro = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+proc-macro2 = "1.0"
+syn = "1.0"
+quote = "1.0"

derive-ahk/src/lib.rs

@@ -0,0 +1,225 @@
+#![warn(clippy::all, clippy::nursery, clippy::pedantic)]
+#![allow(clippy::missing_errors_doc)]
+#![no_implicit_prelude]
+
+use ::std::clone::Clone;
+use ::std::convert::From;
+use ::std::convert::Into;
+use ::std::format;
+use ::std::iter::Extend;
+use ::std::iter::Iterator;
+use ::std::matches;
+use ::std::option::Option::Some;
+use ::std::string::String;
+use ::std::string::ToString;
+use ::std::unreachable;
+use ::std::vec::Vec;
+
+use ::quote::quote;
+use ::syn::parse_macro_input;
+use ::syn::Data;
+use ::syn::DataEnum;
+use ::syn::DeriveInput;
+use ::syn::Fields;
+use ::syn::FieldsNamed;
+use ::syn::FieldsUnnamed;
+use ::syn::Meta;
+use ::syn::NestedMeta;
+
+#[allow(clippy::too_many_lines)]
+#[proc_macro_derive(AhkFunction)]
+pub fn ahk_function(input: ::proc_macro::TokenStream) -> ::proc_macro::TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    let name = input.ident;
+
+    match input.data {
+        Data::Struct(s) => match s.fields {
+            Fields::Named(FieldsNamed { named, .. }) => {
+                let argument_idents = named
+                    .iter()
+                    // Filter out the flags
+                    .filter(|&f| {
+                        let mut include = true;
+                        for attribute in &f.attrs {
+                            if let ::std::result::Result::Ok(Meta::List(list)) =
+                                attribute.parse_meta()
+                            {
+                                for nested in list.nested {
+                                    if let NestedMeta::Meta(Meta::Path(path)) = nested {
+                                        if path.is_ident("long") {
+                                            include = false;
+                                        }
+                                    }
+                                }
+                            }
+                        }
+
+                        include
+                    })
+                    .map(|f| &f.ident);
+
+                let argument_idents_clone = argument_idents.clone();
+
+                let called_arguments = quote! {#(%#argument_idents_clone%) *}
+                    .to_string()
+                    .replace(" %", "%")
+                    .replace("% ", "%")
+                    .replace("%%", "% %");
+
+                let flag_idents = named
+                    .iter()
+                    // Filter only the flags
+                    .filter(|f| {
+                        let mut include = false;
+
+                        for attribute in &f.attrs {
+                            if let ::std::result::Result::Ok(Meta::List(list)) =
+                                attribute.parse_meta()
+                            {
+                                for nested in list.nested {
+                                    if let NestedMeta::Meta(Meta::Path(path)) = nested {
+                                        // Identify them using the --long flag name
+                                        if path.is_ident("long") {
+                                            include = true;
+                                        }
+                                    }
+                                }
+                            }
+                        }
+
+                        include
+                    })
+                    .map(|f| &f.ident);
+
+                let has_flags = flag_idents.clone().count() != 0;
+
+                if has_flags {
+                    let flag_idents_concat = flag_idents.clone();
+                    let argument_idents_concat = argument_idents.clone();
+
+                    // Concat the args and flag args if there are flags
+                    let all_arguments =
+                        quote! {#(#argument_idents_concat,) * #(#flag_idents_concat), *}
+                            .to_string();
+
+                    let flag_idents_clone = flag_idents.clone();
+                    let flags = quote! {#(--#flag_idents_clone) *}
+                        .to_string()
+                        .replace("- - ", "--")
+                        .replace('_', "-");
+
+                    let called_flag_arguments = quote! {#(%#flag_idents%) *}
+                        .to_string()
+                        .replace(" %", "%")
+                        .replace("% ", "%")
+                        .replace("%%", "% %");
+
+                    let flags_split: Vec<_> = flags.split(' ').collect();
+                    let flag_args_split: Vec<_> = called_flag_arguments.split(' ').collect();
+                    let mut consolidated_flags: Vec<String> = Vec::new();
+
+                    for (idx, flag) in flags_split.iter().enumerate() {
+                        consolidated_flags.push(format!("{} {}", flag, flag_args_split[idx]));
+                    }
+
+                    let all_flags = consolidated_flags.join(" ");
+
+                    quote! {
+                        impl AhkFunction for #name {
+                            fn generate_ahk_function() -> String {
+                                ::std::format!(r#"
+{}({}) {{
+    Run, komorebic.exe {} {} {}, , Hide
+}}"#,
+                                    ::std::stringify!(#name),
+                                    #all_arguments,
+                                    ::std::stringify!(#name).to_kebab_case(),
+                                    #called_arguments,
+                                    #all_flags,
+                                )
+                           }
+                        }
+                    }
+                } else {
+                    let arguments = quote! {#(#argument_idents), *}.to_string();
+
+                    quote! {
+                        impl AhkFunction for #name {
+                            fn generate_ahk_function() -> String {
+                                ::std::format!(r#"
+{}({}) {{
+    Run, komorebic.exe {} {}, , Hide
+}}"#, 
+                                    ::std::stringify!(#name),
+                                    #arguments,
+                                    ::std::stringify!(#name).to_kebab_case(),
+                                    #called_arguments
+                                )
+                           }
+                        }
+                    }
+                }
+            }
+            _ => unreachable!("only to be used on structs with named fields"),
+        },
+        _ => unreachable!("only to be used on structs"),
+    }
+    .into()
+}
+
+#[proc_macro_derive(AhkLibrary)]
+pub fn ahk_library(input: ::proc_macro::TokenStream) -> ::proc_macro::TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    let name = input.ident;
+
+    match input.data {
+        Data::Enum(DataEnum { variants, .. }) => {
+            let enums = variants.iter().filter(|&v| {
+                matches!(v.fields, Fields::Unit) || matches!(v.fields, Fields::Unnamed(..))
+            });
+
+            let mut stream = ::proc_macro2::TokenStream::new();
+
+            for variant in enums.clone() {
+                match &variant.fields {
+                    Fields::Unnamed(FieldsUnnamed { unnamed, .. }) => {
+                        for field in unnamed {
+                            stream.extend(quote! {
+                                v.push(#field::generate_ahk_function());
+                            });
+                        }
+                    }
+                    Fields::Unit => {
+                        let name = &variant.ident;
+                        stream.extend(quote! {
+                            v.push(::std::format!(r#"
+{}() {{
+    Run, komorebic.exe {}, , Hide
+}}"#, 
+                                ::std::stringify!(#name),
+                                ::std::stringify!(#name).to_kebab_case()
+                            ));
+                        });
+                    }
+                    Fields::Named(_) => {
+                        unreachable!("only to be used with unnamed and unit fields");
+                    }
+                }
+            }
+
+            quote! {
+                impl #name {
+                    fn generate_ahk_library() -> String {
+                        let mut v: Vec<String> = vec![String::from("; Generated by komorebic.exe")];
+
+                        #stream
+
+                        v.join("\n")
+                    }
+               }
+            }
+        }
+        _ => unreachable!("only to be used on enums"),
+    }
+    .into()
+}

docs/cli/adjust-container-padding.md

@@ -1,19 +0,0 @@
-# adjust-container-padding
-
-```
-Adjust container padding on the focused workspace
-
-Usage: komorebic.exe adjust-container-padding <SIZING> <ADJUSTMENT>
-
-Arguments:
-  <SIZING>
-          [possible values: increase, decrease]
-
-  <ADJUSTMENT>
-          Pixels to adjust by as an integer
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/adjust-workspace-padding.md

@@ -1,19 +0,0 @@
-# adjust-workspace-padding
-
-```
-Adjust workspace padding on the focused workspace
-
-Usage: komorebic.exe adjust-workspace-padding <SIZING> <ADJUSTMENT>
-
-Arguments:
-  <SIZING>
-          [possible values: increase, decrease]
-
-  <ADJUSTMENT>
-          Pixels to adjust by as an integer
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/ahk-app-specific-configuration.md

@@ -1,19 +0,0 @@
-# ahk-app-specific-configuration
-
-```
-Generate common app-specific configurations and fixes to use in komorebi.ahk
-
-Usage: komorebic.exe ahk-app-specific-configuration <PATH> [OVERRIDE_PATH]
-
-Arguments:
-  <PATH>
-          YAML file from which the application-specific configurations should be loaded
-
-  [OVERRIDE_PATH]
-          Optional YAML file of overrides to apply over the first file
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/animation-duration.md

@@ -1,21 +0,0 @@
-# animation-duration
-
-```
-Set the duration for movement animations in ms
-
-Usage: komorebic.exe animation-duration [OPTIONS] <DURATION>
-
-Arguments:
-  <DURATION>
-          Desired animation durations in ms
-
-Options:
-  -a, --animation-type <ANIMATION_TYPE>
-          Animation type to apply the duration to. If not specified, sets global duration
-          
-          [possible values: movement, transparency]
-
-  -h, --help
-          Print help
-
-```

docs/cli/animation-fps.md

@@ -1,16 +0,0 @@
-# animation-fps
-
-```
-Set the frames per second for movement animations
-
-Usage: komorebic.exe animation-fps <FPS>
-
-Arguments:
-  <FPS>
-          Desired animation frames per second
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/animation-style.md

@@ -1,25 +0,0 @@
-# animation-style
-
-```
-Set the ease function for movement animations
-
-Usage: komorebic.exe animation-style [OPTIONS]
-
-Options:
-  -s, --style <STYLE>
-          Desired ease function for animation
-          
-          [default: linear]
-          [possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart,
-          ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ,
-          ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce]
-
-  -a, --animation-type <ANIMATION_TYPE>
-          Animation type to apply the style to. If not specified, sets global style
-          
-          [possible values: movement, transparency]
-
-  -h, --help
-          Print help
-
-```

docs/cli/animation.md

@@ -1,21 +0,0 @@
-# animation
-
-```
-Enable or disable movement animations
-
-Usage: komorebic.exe animation [OPTIONS] <BOOLEAN_STATE>
-
-Arguments:
-  <BOOLEAN_STATE>
-          [possible values: enable, disable]
-
-Options:
-  -a, --animation-type <ANIMATION_TYPE>
-          Animation type to apply the state to. If not specified, sets global state
-          
-          [possible values: movement, transparency]
-
-  -h, --help
-          Print help
-
-```

docs/cli/application-specific-configuration-schema.md

@@ -1,12 +0,0 @@
-# application-specific-configuration-schema
-
-```
-Generate a JSON Schema for applications.json
-
-Usage: komorebic.exe application-specific-configuration-schema
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/bar-configuration.md

@@ -1,12 +0,0 @@
-# bar-configuration
-
-```
-Show the path to komorebi.bar.json
-
-Usage: komorebic.exe bar-configuration
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/border-colour.md

@@ -1,26 +0,0 @@
-# border-colour
-
-```
-Set the colour for a window border kind
-
-Usage: komorebic.exe border-colour [OPTIONS] <R> <G> <B>
-
-Arguments:
-  <R>
-          Red
-
-  <G>
-          Green
-
-  <B>
-          Blue
-
-Options:
-  -w, --window-kind <WINDOW_KIND>
-          [default: single]
-          [possible values: single, stack, monocle, unfocused, floating]
-
-  -h, --help
-          Print help
-
-```

docs/cli/border-implementation.md

@@ -1,20 +0,0 @@
-# border-implementation
-
-```
-Set the border implementation
-
-Usage: komorebic.exe border-implementation <STYLE>
-
-Arguments:
-  <STYLE>
-          Desired border implementation
-
-          Possible values:
-          - komorebi: Use the adjustable komorebi border implementation
-          - windows:  Use the thin Windows accent border implementation
-
-Options:
-  -h, --help
-          Print help (see a summary with '-h')
-
-```

docs/cli/border-offset.md

@@ -1,16 +0,0 @@
-# border-offset
-
-```
-Set the border offset
-
-Usage: komorebic.exe border-offset <OFFSET>
-
-Arguments:
-  <OFFSET>
-          Desired offset of the window border
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/border-style.md

@@ -1,21 +0,0 @@
-# border-style
-
-```
-Set the border style
-
-Usage: komorebic.exe border-style <STYLE>
-
-Arguments:
-  <STYLE>
-          Desired border style
-
-          Possible values:
-          - system:  Use the system border style
-          - rounded: Use the Windows 11-style rounded borders
-          - square:  Use the Windows 10-style square borders
-
-Options:
-  -h, --help
-          Print help (see a summary with '-h')
-
-```

docs/cli/border-width.md

@@ -1,16 +0,0 @@
-# border-width
-
-```
-Set the border width
-
-Usage: komorebic.exe border-width <WIDTH>
-
-Arguments:
-  <WIDTH>
-          Desired width of the window border
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/border.md

@@ -1,16 +0,0 @@
-# border
-
-```
-Enable or disable borders
-
-Usage: komorebic.exe border <BOOLEAN_STATE>
-
-Arguments:
-  <BOOLEAN_STATE>
-          [possible values: enable, disable]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/change-layout.md

@@ -1,16 +0,0 @@
-# change-layout
-
-```
-Set the layout on the focused workspace
-
-Usage: komorebic.exe change-layout <DEFAULT_LAYOUT>
-
-Arguments:
-  <DEFAULT_LAYOUT>
-          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/check.md

@@ -1,15 +0,0 @@
-# check
-
-```
-Check komorebi configuration and related files for common errors
-
-Usage: komorebic.exe check [OPTIONS]
-
-Options:
-  -k, --komorebi-config <KOMOREBI_CONFIG>
-          Path to a static configuration JSON file
-
-  -h, --help
-          Print help
-
-```

docs/cli/clear-all-workspace-rules.md

@@ -1,12 +0,0 @@
-# clear-all-workspace-rules
-
-```
-Remove all application association rules for all workspaces
-
-Usage: komorebic.exe clear-all-workspace-rules
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/clear-named-workspace-layout-rules.md

@@ -1,16 +0,0 @@
-# clear-named-workspace-layout-rules
-
-```
-Clear all dynamic layout rules for the specified workspace
-
-Usage: komorebic.exe clear-named-workspace-layout-rules <WORKSPACE>
-
-Arguments:
-  <WORKSPACE>
-          Target workspace name
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/clear-named-workspace-rules.md

@@ -1,16 +0,0 @@
-# clear-named-workspace-rules
-
-```
-Remove all application association rules for a named workspace
-
-Usage: komorebic.exe clear-named-workspace-rules <WORKSPACE>
-
-Arguments:
-  <WORKSPACE>
-          Name of a workspace
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/clear-workspace-layout-rules.md

@@ -1,19 +0,0 @@
-# clear-workspace-layout-rules
-
-```
-Clear all dynamic layout rules for the specified workspace
-
-Usage: komorebic.exe clear-workspace-layout-rules <MONITOR> <WORKSPACE>
-
-Arguments:
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  <WORKSPACE>
-          Workspace index on the specified monitor (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/clear-workspace-rules.md

@@ -1,19 +0,0 @@
-# clear-workspace-rules
-
-```
-Remove all application association rules for a workspace by monitor and workspace index
-
-Usage: komorebic.exe clear-workspace-rules <MONITOR> <WORKSPACE>
-
-Arguments:
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  <WORKSPACE>
-          Workspace index on the specified monitor (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/close-workspace.md

@@ -1,12 +0,0 @@
-# close-workspace
-
-```
-Close the focused workspace (must be empty and unnamed)
-
-Usage: komorebic.exe close-workspace
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/close.md

@@ -1,12 +0,0 @@
-# close
-
-```
-Close the focused window
-
-Usage: komorebic.exe close
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/complete-configuration.md

@@ -1,12 +0,0 @@
-# complete-configuration
-
-```
-For legacy komorebi.ahk or komorebi.ps1 configurations, signal that the final configuration option has been sent
-
-Usage: komorebic.exe complete-configuration
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/configuration.md

@@ -1,12 +0,0 @@
-# configuration
-
-```
-Show the path to komorebi.json
-
-Usage: komorebic.exe configuration
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/container-padding.md

@@ -1,22 +0,0 @@
-# container-padding
-
-```
-Set the container padding for the specified workspace
-
-Usage: komorebic.exe container-padding <MONITOR> <WORKSPACE> <SIZE>
-
-Arguments:
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  <WORKSPACE>
-          Workspace index on the specified monitor (zero-indexed)
-
-  <SIZE>
-          Pixels to pad with as an integer
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/convert-app-specific-configuration.md

@@ -1,16 +0,0 @@
-# convert-app-specific-configuration
-
-```
-Convert a v1 ASC YAML file to a v2 ASC JSON file
-
-Usage: komorebic.exe convert-app-specific-configuration <PATH>
-
-Arguments:
-  <PATH>
-          YAML file from which the application-specific configurations should be loaded
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cross-monitor-move-behaviour.md

@@ -1,19 +0,0 @@
-# cross-monitor-move-behaviour
-
-```
-Set the behaviour when moving windows across monitor boundaries
-
-Usage: komorebic.exe cross-monitor-move-behaviour <MOVE_BEHAVIOUR>
-
-Arguments:
-  <MOVE_BEHAVIOUR>
-          Possible values:
-          - swap:   Swap the window container with the window container at the edge of the adjacent monitor
-          - insert: Insert the window container into the focused workspace on the adjacent monitor
-          - no-op:  Do nothing if trying to move a window container in the direction of an adjacent monitor
-
-Options:
-  -h, --help
-          Print help (see a summary with '-h')
-
-```

docs/cli/cycle-focus.md

@@ -1,16 +0,0 @@
-# cycle-focus
-
-```
-Change focus to the window in the specified cycle direction
-
-Usage: komorebic.exe cycle-focus <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-layout.md

@@ -1,16 +0,0 @@
-# cycle-layout
-
-```
-Cycle between available layouts
-
-Usage: komorebic.exe cycle-layout <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-monitor.md

@@ -1,16 +0,0 @@
-# cycle-monitor
-
-```
-Focus the monitor in the given cycle direction
-
-Usage: komorebic.exe cycle-monitor <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-move-to-monitor.md

@@ -1,16 +0,0 @@
-# cycle-move-to-monitor
-
-```
-Move the focused window to the monitor in the given cycle direction
-
-Usage: komorebic.exe cycle-move-to-monitor <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-move-to-workspace.md

@@ -1,16 +0,0 @@
-# cycle-move-to-workspace
-
-```
-Move the focused window to the workspace in the given cycle direction
-
-Usage: komorebic.exe cycle-move-to-workspace <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-move-workspace-to-monitor.md

@@ -1,16 +0,0 @@
-# cycle-move-workspace-to-monitor
-
-```
-Move the focused workspace monitor in the given cycle direction
-
-Usage: komorebic.exe cycle-move-workspace-to-monitor <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-move.md

@@ -1,16 +0,0 @@
-# cycle-move
-
-```
-Move the focused window in the specified cycle direction
-
-Usage: komorebic.exe cycle-move <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-send-to-monitor.md

@@ -1,16 +0,0 @@
-# cycle-send-to-monitor
-
-```
-Send the focused window to the monitor in the given cycle direction
-
-Usage: komorebic.exe cycle-send-to-monitor <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-send-to-workspace.md

@@ -1,16 +0,0 @@
-# cycle-send-to-workspace
-
-```
-Send the focused window to the workspace in the given cycle direction
-
-Usage: komorebic.exe cycle-send-to-workspace <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-stack-index.md

@@ -1,16 +0,0 @@
-# cycle-stack-index
-
-```
-Cycle the index of the focused window in the focused stack in the specified cycle direction
-
-Usage: komorebic.exe cycle-stack-index <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-stack.md

@@ -1,16 +0,0 @@
-# cycle-stack
-
-```
-Cycle the focused stack in the specified cycle direction
-
-Usage: komorebic.exe cycle-stack <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/cycle-workspace.md

@@ -1,16 +0,0 @@
-# cycle-workspace
-
-```
-Focus the workspace in the given cycle direction
-
-Usage: komorebic.exe cycle-workspace <CYCLE_DIRECTION>
-
-Arguments:
-  <CYCLE_DIRECTION>
-          [possible values: previous, next]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/disable-autostart.md

@@ -1,12 +0,0 @@
-# disable-autostart
-
-```
-Deletes the komorebi.lnk shortcut in shell:startup to disable autostart
-
-Usage: komorebic.exe disable-autostart
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/display-index-preference.md

@@ -1,19 +0,0 @@
-# display-index-preference
-
-```
-Set the display index preference for a monitor identified using its display name
-
-Usage: komorebic.exe display-index-preference <INDEX_PREFERENCE> <DISPLAY>
-
-Arguments:
-  <INDEX_PREFERENCE>
-          Preferred monitor index (zero-indexed)
-
-  <DISPLAY>
-          Display name as identified in komorebic state
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/eager-focus.md

@@ -1,16 +0,0 @@
-# eager-focus
-
-```
-Focus the first managed window matching the given exe
-
-Usage: komorebic.exe eager-focus <EXE>
-
-Arguments:
-  <EXE>
-          Case-sensitive exe identifier
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/enable-autostart.md

@@ -1,27 +0,0 @@
-# enable-autostart
-
-```
-Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi
-
-Usage: komorebic.exe enable-autostart [OPTIONS]
-
-Options:
-  -c, --config <CONFIG>
-          Path to a static configuration JSON file
-
-      --whkd
-          Enable autostart of whkd
-
-      --ahk
-          Enable autostart of ahk
-
-      --bar
-          Enable autostart of komorebi-bar
-
-      --masir
-          Enable autostart of masir
-
-  -h, --help
-          Print help
-
-```

docs/cli/enforce-workspace-rules.md

@@ -1,12 +0,0 @@
-# enforce-workspace-rules
-
-```
-Enforce all workspace rules, including initial workspace rules that have already been applied
-
-Usage: komorebic.exe enforce-workspace-rules
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/ensure-named-workspaces.md

@@ -1,19 +0,0 @@
-# ensure-named-workspaces
-
-```
-Create these many named workspaces for the specified monitor
-
-Usage: komorebic.exe ensure-named-workspaces <MONITOR> [NAMES]...
-
-Arguments:
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  [NAMES]...
-          Names of desired workspaces
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/ensure-workspaces.md

@@ -1,19 +0,0 @@
-# ensure-workspaces
-
-```
-Create at least this many workspaces for the specified monitor
-
-Usage: komorebic.exe ensure-workspaces <MONITOR> <WORKSPACE_COUNT>
-
-Arguments:
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  <WORKSPACE_COUNT>
-          Number of desired workspaces
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/fetch-app-specific-configuration.md

@@ -1,12 +0,0 @@
-# fetch-app-specific-configuration
-
-```
-Fetch the latest version of applications.json from komorebi-application-specific-configuration
-
-Usage: komorebic.exe fetch-app-specific-configuration
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/flip-layout.md

@@ -1,16 +0,0 @@
-# flip-layout
-
-```
-Flip the layout on the focused workspace
-
-Usage: komorebic.exe flip-layout <AXIS>
-
-Arguments:
-  <AXIS>
-          [possible values: horizontal, vertical, horizontal-and-vertical]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-last-workspace.md

@@ -1,12 +0,0 @@
-# focus-last-workspace
-
-```
-Focus the last focused workspace on the focused monitor
-
-Usage: komorebic.exe focus-last-workspace
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-monitor-at-cursor.md

@@ -1,12 +0,0 @@
-# focus-monitor-at-cursor
-
-```
-Focus the monitor at the current cursor location
-
-Usage: komorebic.exe focus-monitor-at-cursor
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-monitor-workspace.md

@@ -1,19 +0,0 @@
-# focus-monitor-workspace
-
-```
-Focus the specified workspace on the target monitor
-
-Usage: komorebic.exe focus-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
-
-Arguments:
-  <TARGET_MONITOR>
-          Target monitor index (zero-indexed)
-
-  <TARGET_WORKSPACE>
-          Workspace index on the target monitor (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-monitor.md

@@ -1,16 +0,0 @@
-# focus-monitor
-
-```
-Focus the specified monitor
-
-Usage: komorebic.exe focus-monitor <TARGET>
-
-Arguments:
-  <TARGET>
-          Target index (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-named-workspace.md

@@ -1,16 +0,0 @@
-# focus-named-workspace
-
-```
-Focus the specified workspace
-
-Usage: komorebic.exe focus-named-workspace <WORKSPACE>
-
-Arguments:
-  <WORKSPACE>
-          Target workspace name
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-stack-window.md

@@ -1,16 +0,0 @@
-# focus-stack-window
-
-```
-Focus the specified window index in the focused stack
-
-Usage: komorebic.exe focus-stack-window <TARGET>
-
-Arguments:
-  <TARGET>
-          Target index (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-workspace.md

@@ -1,16 +0,0 @@
-# focus-workspace
-
-```
-Focus the specified workspace on the focused monitor
-
-Usage: komorebic.exe focus-workspace <TARGET>
-
-Arguments:
-  <TARGET>
-          Target index (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus-workspaces.md

@@ -1,16 +0,0 @@
-# focus-workspaces
-
-```
-Focus the specified workspace on all monitors
-
-Usage: komorebic.exe focus-workspaces <TARGET>
-
-Arguments:
-  <TARGET>
-          Target index (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focus.md

@@ -1,16 +0,0 @@
-# focus
-
-```
-Change focus to the window in the specified direction
-
-Usage: komorebic.exe focus <OPERATION_DIRECTION>
-
-Arguments:
-  <OPERATION_DIRECTION>
-          [possible values: left, right, up, down]
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focused-workspace-container-padding.md

@@ -1,16 +0,0 @@
-# focused-workspace-container-padding
-
-```
-Set container padding on the focused workspace
-
-Usage: komorebic.exe focused-workspace-container-padding <SIZE>
-
-Arguments:
-  <SIZE>
-          Pixels size to set as an integer
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/focused-workspace-padding.md

@@ -1,16 +0,0 @@
-# focused-workspace-padding
-
-```
-Set workspace padding on the focused workspace
-
-Usage: komorebic.exe focused-workspace-padding <SIZE>
-
-Arguments:
-  <SIZE>
-          Pixels size to set as an integer
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/force-focus.md

@@ -1,12 +0,0 @@
-# force-focus
-
-```
-Forcibly focus the window at the cursor with a left mouse click
-
-Usage: komorebic.exe force-focus
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/generate-static-config.md

@@ -1,12 +0,0 @@
-# generate-static-config
-
-```
-Generates a static configuration JSON file based on the current window manager state
-
-Usage: komorebic.exe generate-static-config
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/global-state.md

@@ -1,12 +0,0 @@
-# global-state
-
-```
-Show a JSON representation of the current global state
-
-Usage: komorebic.exe global-state
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/global-work-area-offset.md

@@ -1,25 +0,0 @@
-# global-work-area-offset
-
-```
-Set offsets to exclude parts of the work area from tiling
-
-Usage: komorebic.exe global-work-area-offset <LEFT> <TOP> <RIGHT> <BOTTOM>
-
-Arguments:
-  <LEFT>
-          Size of the left work area offset (set right to left * 2 to maintain right padding)
-
-  <TOP>
-          Size of the top work area offset (set bottom to the same value to maintain bottom padding)
-
-  <RIGHT>
-          Size of the right work area offset
-
-  <BOTTOM>
-          Size of the bottom work area offset
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/gui.md

@@ -1,12 +0,0 @@
-# gui
-
-```
-Launch the komorebi-gui debugging tool
-
-Usage: komorebic.exe gui
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/identify-layered-application.md

@@ -1,19 +0,0 @@
-# identify-layered-application
-
-```
-Identify an application that has WS_EX_LAYERED, but should still be managed
-
-Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/identify-object-name-change-application.md

@@ -1,19 +0,0 @@
-# identify-object-name-change-application
-
-```
-Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch
-
-Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/identify-tray-application.md

@@ -1,19 +0,0 @@
-# identify-tray-application
-
-```
-Identify an application that closes to the system tray
-
-Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/ignore-rule.md

@@ -1,19 +0,0 @@
-# ignore-rule
-
-```
-Add a rule to ignore the specified application
-
-Usage: komorebic.exe ignore-rule <IDENTIFIER> <ID>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/initial-named-workspace-rule.md

@@ -1,22 +0,0 @@
-# initial-named-workspace-rule
-
-```
-Add a rule to associate an application with a named workspace on first show
-
-Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-  <WORKSPACE>
-          Name of a workspace
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/initial-workspace-rule.md

@@ -1,25 +0,0 @@
-# initial-workspace-rule
-
-```
-Add a rule to associate an application with a workspace on first show
-
-Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-  <MONITOR>
-          Monitor index (zero-indexed)
-
-  <WORKSPACE>
-          Workspace index on the specified monitor (zero-indexed)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/invisible-borders.md

@@ -1,25 +0,0 @@
-# invisible-borders
-
-```
-Set the invisible border dimensions around each window
-
-Usage: komorebic.exe invisible-borders <LEFT> <TOP> <RIGHT> <BOTTOM>
-
-Arguments:
-  <LEFT>
-          Size of the left invisible border
-
-  <TOP>
-          Size of the top invisible border (usually 0)
-
-  <RIGHT>
-          Size of the right invisible border (usually left * 2)
-
-  <BOTTOM>
-          Size of the bottom invisible border (usually the same as left)
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/kill.md

@@ -1,24 +0,0 @@
-# kill
-
-```
-Kill background processes started by komorebic
-
-Usage: komorebic.exe kill [OPTIONS]
-
-Options:
-      --whkd
-          Kill whkd if it is running as a background process
-
-      --ahk
-          Kill ahk if it is running as a background process
-
-      --bar
-          Kill komorebi-bar if it is running as a background process
-
-      --masir
-          Kill masir if it is running as a background process
-
-  -h, --help
-          Print help
-
-```

docs/cli/load-resize.md

@@ -1,16 +0,0 @@
-# load-resize
-
-```
-Load the resize layout dimensions from a file
-
-Usage: komorebic.exe load-resize <PATH>
-
-Arguments:
-  <PATH>
-          File from which the resize layout dimensions should be loaded
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/log.md

@@ -1,12 +0,0 @@
-# log
-
-```
-Tail komorebi.exe's process logs (cancel with Ctrl-C)
-
-Usage: komorebic.exe log
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/manage-rule.md

@@ -1,19 +0,0 @@
-# manage-rule
-
-```
-Add a rule to always manage the specified application
-
-Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
-
-Arguments:
-  <IDENTIFIER>
-          [possible values: exe, class, title, path]
-
-  <ID>
-          Identifier as a string
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/manage.md

@@ -1,12 +0,0 @@
-# manage
-
-```
-Force komorebi to manage the focused window
-
-Usage: komorebic.exe manage
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/minimize.md

@@ -1,12 +0,0 @@
-# minimize
-
-```
-Minimize the focused window
-
-Usage: komorebic.exe minimize
-
-Options:
-  -h, --help
-          Print help
-
-```