feat(wm): add stackbar for multi-window containers

This commit introduces the stackbar feature through careful extracting
and refactoring of code from the Komorebi-UI hard-fork.

Unfortunately on the fork, this feature was not implemented using atomic
commits, which resulted in the implementation here being more of a
"reinterpretation" than a lift-and-shit of the referenced code.

Nevertheless, this commit represents a working version of the stackbar
feature.

resolve #681

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,52 @@
+---
+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
+```
+
+**`komorebic check` Output**
+Provide the output of `komorebic check`
+
+For example:
+```
+No KOMOREBI_CONFIG_HOME detected, defaulting to C:\Users\LGUG2Z
+
+Looking for configuration files in C:\Users\LGUG2Z
+
+No komorebi configuration found in C:\Users\LGUG2Z
+
+If running 'komorebic start --await-configuration', you will manually have to call the following command to begin tiling: komorebic complete-configuration
+```
+
+**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 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 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 (Sponsors only)
-labels: [enhancement]
-title: "[FEAT]: "
-body:
-  - type: dropdown
-    id: Sponsors
-    attributes:
-      label: Sponsorship Information
-      description: >
-        Feature requests are considered from individuals who are $5+ monthly sponsors to the project.
-
-        Please specify the platform you use to sponsor the project.
-      options:
-        - GitHub Sponsors
-        - Ko-fi
-        - Discord
-        - YouTube
-      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/sponsor-check.yaml

@@ -1,125 +0,0 @@
-name: Feature Request Sponsor Check
-
-on:
-  issues:
-    types: [opened]
-  workflow_dispatch:
-    inputs:
-      test_username:
-        description: "Test username to check sponsorship for"
-        required: true
-        default: "octocat"
-      test_title:
-        description: "Test issue title"
-        required: true
-        default: "[FEAT] Test Feature Request"
-      test_sponsor_platform:
-        description: "Selected sponsor platform"
-        required: true
-        type: choice
-        options:
-          - "GitHub Sponsors"
-          - "Ko-fi"
-          - "Discord"
-          - "YouTube"
-
-jobs:
-  check-sponsor:
-    runs-on: ubuntu-latest
-    if: |
-      (github.event_name == 'workflow_dispatch') || (github.event_name == 'issues' &&
-       startsWith(github.event.issue.title, '[FEAT]') &&
-       github.event.issue.user.login != 'LGUG2Z' &&
-       fromJSON(github.event.issue.body).Sponsors == 'GitHub Sponsors')
-
-    steps:
-      - name: Get Issue Details
-        id: issue-details
-        run: |
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            echo "username=${{ github.event.inputs.test_username }}" >> $GITHUB_OUTPUT
-            echo "title=${{ github.event.inputs.test_title }}" >> $GITHUB_OUTPUT
-            echo "sponsor_platform=${{ github.event.inputs.test_sponsor_platform }}" >> $GITHUB_OUTPUT
-          else
-            echo "username=${{ github.event.issue.user.login }}" >> $GITHUB_OUTPUT
-            echo "title=${{ github.event.issue.title }}" >> $GITHUB_OUTPUT
-            echo "sponsor_platform=$(jq -r '.Sponsors' <<< '${{ github.event.issue.body }}')" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Get Sponsorship Status
-        id: sponsorship
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.PAT }}
-          script: |
-            const username = '${{ steps.issue-details.outputs.username }}';
-            const sponsorPlatform = '${{ steps.issue-details.outputs.sponsor_platform }}';
-
-            if (sponsorPlatform !== 'GitHub Sponsors') {
-              console.log('Sponsor platform is not GitHub Sponsors, skipping check');
-              return true;
-            }
-
-            const sponsorshipQuery = `query($user: String!) {
-              user(login: $user) {
-                ... on Sponsorable {
-                  sponsorshipForViewerAsSponsorable {
-                    tier {
-                      name
-                      monthlyPriceInDollars
-                    }
-                  }
-                }
-              }
-            }`;
-
-            try {
-              const result = await github.graphql(sponsorshipQuery, {
-                user: username
-              });
-
-              console.log(result);
-              const sponsorship = result.user.sponsorshipForViewerAsSponsorable;
-              console.log(sponsorship);
-              const amount = sponsorship?.tier?.monthlyPriceInDollars || 0;
-
-              console.log(`Sponsorship amount for ${username}: $${amount}/month`);
-              return amount >= 5;
-            } catch (error) {
-              console.log(`Error checking sponsorship: ${error.message}`);
-              return false;
-            }
-
-      - name: Print Test Results
-        if: github.event_name == 'workflow_dispatch'
-        run: |
-          echo "Test Results for ${{ steps.issue-details.outputs.username }}:"
-          echo "Title: ${{ steps.issue-details.outputs.title }}"
-          echo "Platform: ${{ steps.issue-details.outputs.sponsor_platform }}"
-          echo "Would close issue: ${{ steps.sponsorship.outputs.result == 'false' }}"
-
-      - name: Close Issue If Not Sponsor
-        if: |
-          github.event_name == 'issues' && 
-          steps.sponsorship.outputs.result == 'false'
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const issueNumber = context.issue.number;
-            const owner = context.repo.owner;
-            const repo = context.repo.repo;
-
-            await github.rest.issues.createComment({
-              owner,
-              repo,
-              issue_number: issueNumber,
-              body: 'Thank you for your feature request! This repository requires a GitHub sponsorship of at least $5/month to submit feature requests. Please consider becoming a sponsor at https://github.com/sponsors/LGUG2Z'
-            });
-
-            await github.rest.issues.update({
-              owner,
-              repo,
-              issue_number: issueNumber,
-              state: 'closed'
-            });

.github/workflows/windows.yaml

@@ -14,190 +14,124 @@ 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
         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@v4
         with:
-          cache-on-failure: "true"
-          cache-all-crates: "true"
-          key: ${{ matrix.platform.target }}
-      - run: cargo +nightly fmt --check
-      - run: cargo clippy
-      - uses: houseabsolute/actions-rust-cross@v0
-        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@v4
+        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 Cargo checks
+        run: |
+          cargo fmt --check
+          cargo check
+          cargo clippy
+      - 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@v4
+        with:
+          name: komorebi-${{ matrix.target }}
+          path: |
+            target/${{ matrix.target }}/release/komorebi.exe
+            target/${{ matrix.target }}/release/komorebic.exe
+            target/${{ matrix.target }}/release/komorebic-no-console.exe
+            target/${{ matrix.target }}/release/komorebi.pdb
+            target/${{ matrix.target }}/release/komorebic.pdb
+            target/${{ matrix.target }}/release/komorebic-no-console.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
+          retention-days: 7
+      - name: Check GoReleaser
+        uses: goreleaser/goreleaser-action@v3
         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
+          version: latest
+          args: build --skip=validate --clean
 
-          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
+      # Release
+      - name: Generate changelog
+        if: startsWith(github.ref, 'refs/tags/v')
+        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/v')
         with:
-          body_path: "CHANGELOG.md"
-          files: |
-            checksums.txt
-            *.zip
-            *.msi
+          version: latest
+          args: release --skip=validate --clean --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@v2
+        if: startsWith(github.ref, 'refs/tags/v')
+        with:
+          files: "target/wix/komorebi-*.msi"
 
   winget:
+    name: Publish to WinGet
     runs-on: ubuntu-latest
-    needs: release
+    needs: build
     if: startsWith(github.ref, 'refs/tags/v')
+
     steps:
       - uses: vedantmgoyal2009/winget-releaser@v2
         with:

.gitignore

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

.goreleaser.yml

@@ -0,0 +1,50 @@
+# 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"
+  - id: komorebic-no-console
+    main: dummy.go
+    goos: ["windows"]
+    goarch: ["amd64"]
+    binary: komorebic-no-console
+    hooks:
+      post:
+        - mkdir -p dist/windows_amd64
+        - cp ".\target\x86_64-pc-windows-msvc\release\komorebic-no-console.exe" ".\dist\komorebic-no-console_windows_amd64_v1\komorebic-no-console.exe"
+
+archives:
+  - name_template: "{{ .ProjectName }}-{{ .Version }}-x86_64-pc-windows-msvc"
+    format: zip
+    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

@@ -2,57 +2,31 @@
 
 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.29"
-egui_extras = "0.29"
-dirs = "5"
+windows-interface = { version = "0.53" }
+windows-implement = { version = "0.53" }
 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"
-tracing = "0.1"
-tracing-appender = "0.2"
-tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-paste = "1"
-sysinfo = "0.31"
-uds_windows = "1"
-win32-display-data = { git = "https://github.com/LGUG2Z/win32-display-data", rev = "dd65e3f22d0521b78fcddde11abc2a3e9dcc32a8" }
-windows-implement = { version = "0.58" }
-windows-interface = { version = "0.58" }
-windows-core = { version = "0.58" }
-shadow-rs = "0.35"
-which = "7"
+dirs = "5"
+color-eyre = "0.6"
+serde_json = { package = "serde_json_lenient", version = "0.1" }
 
 [workspace.dependencies.windows]
-version = "0.58"
+version = "0.54"
 features = [
     "implement",
-    "Foundation_Numerics",
     "Win32_System_Com",
     "Win32_UI_Shell_Common", # for IObjectArray
     "Win32_Foundation",
     "Win32_Graphics_Dwm",
     "Win32_Graphics_Gdi",
-    "Win32_Graphics_Direct2D",
-    "Win32_Graphics_Direct2D_Common",
-    "Win32_Graphics_Dxgi_Common",
     "Win32_System_LibraryLoader",
     "Win32_System_RemoteDesktop",
     "Win32_System_Threading",
@@ -62,8 +36,5 @@ features = [
     "Win32_UI_Shell",
     "Win32_UI_Shell_Common",
     "Win32_UI_WindowsAndMessaging",
-    "Win32_System_SystemServices",
-    "Win32_System_WindowsProgramming",
-    "Media",
-    "Media_Control"
+    "Win32_System_SystemServices"
 ]

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

@@ -60,17 +60,13 @@ channel](https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg) where I post
 _komorebi_ development videos. If you would like to be notified of upcoming
 videos please subscribe and turn on notifications.
 
-There is an [Awesome List](https://github.com/LGUG2Z/awesome-komorebi) which
-showcases the many awesome projects that exist in the _komorebi_ ecosystem.
-
-_komorebi_ is a free and source-available project, and one that encourages you to
+_komorebi_ 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 contributing
-to a [Gaza Funds campaign](https://gazafunds.com) before you consider sponsoring
-me on GitHub.
+Relief Fund](https://pcrf1.app.neoncrm.com/forms/gaza-recovery) before you
+consider sponsoring me on GitHub.
 
 [GitHub Sponsors is enabled for this
 project](https://github.com/sponsors/LGUG2Z). Unfortunately I don't have
@@ -86,28 +82,10 @@ 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)
+[![Watch the quickstart walkthrough video](https://img.youtube.com/vi/H9-_c1egQ4g/hqdefault.jpg)](https://www.youtube.com/watch?v=H9-_c1egQ4g)
 
 # 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
-
 [@haxibami](https://github.com/haxibami) showing _komorebi_ running on Windows
 11 with a terminal emulator, a web browser and a code editor. The original
 video can be viewed
@@ -191,27 +169,6 @@ ability for users to specify colours in `komorebi.json` in Hex format alongside
 There is also a process in place for graceful, non-breaking, deprecation of configuration options that are no longer
 required.
 
-## License
-
-`komorebi` is licensed under the [Komorebi 1.0.0 license](./LICENSE.md), 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 (ie.
-hard-forks) based on the software.
-
-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.
-
-The [Komorebi 1.0.0 License](./LICENSE.md) does not permit any kind of
-commercial use.
-
-A dedicated license and EULA will be introduced in 2025 for both commercial and
-noncommercial organizations.
-
-Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about how
-code contributions to `komorebi` are licensed.
-
 # Development
 
 If you use IntelliJ, you should enable the following settings to ensure that code generated by macros is recognised by
@@ -288,7 +245,7 @@ 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`.
 
@@ -367,7 +324,7 @@ every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a Rust c
 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.30"}
+// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.22"}
 
 use anyhow::Result;
 use komorebi_client::Notification;
@@ -423,7 +380,7 @@ A TCP listener can optionally be exposed on a port of your choosing with the `--
 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

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#"
+{}({}) {{
+    RunWait, 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#"
+{}({}) {{
+    RunWait, 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#"
+{}() {{
+    RunWait, 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/active-window-border-colour.md

@@ -0,0 +1,26 @@
+# active-window-border-colour
+
+```
+Set the colour for the active window border
+
+Usage: komorebic.exe active-window-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]
+
+  -h, --help
+          Print help
+
+```

docs/cli/active-window-border-offset.md

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

docs/cli/active-window-border-width.md

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

docs/cli/active-window-border.md

@@ -1,9 +1,9 @@
-# transparency
+# active-window-border
 
 ```
-Enable or disable transparency for unfocused windows
+Enable or disable the active window border
 
-Usage: komorebic.exe transparency <BOOLEAN_STATE>
+Usage: komorebic.exe active-window-border <BOOLEAN_STATE>
 
 Arguments:
   <BOOLEAN_STATE>

docs/cli/ahk-library.md

@@ -0,0 +1,12 @@
+# ahk-library
+
+```
+Generate a library of AutoHotKey helper functions
+
+Usage: komorebic.exe ahk-library
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/alt-focus-hack.md

@@ -1,9 +1,9 @@
-# border
+# alt-focus-hack
 
 ```
-Enable or disable borders
+DEPRECATED since v0.1.22
 
-Usage: komorebic.exe border <BOOLEAN_STATE>
+Usage: komorebic.exe alt-focus-hack <BOOLEAN_STATE>
 
 Arguments:
   <BOOLEAN_STATE>

docs/cli/animation-duration.md

@@ -1,16 +0,0 @@
-# animation-duration
-
-```
-Set the duration for movement animations in ms
-
-Usage: komorebic.exe animation-duration <DURATION>
-
-Arguments:
-  <DURATION>
-          Desired animation durations in ms
-
-Options:
-  -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,19 +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]
-
-  -h, --help
-          Print help
-
-```

docs/cli/animation.md

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

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

@@ -1,7 +1,7 @@
 # application-specific-configuration-schema
 
 ```
-Generate a JSON Schema for applications.json
+Generate a JSON Schema for applications.yaml
 
 Usage: komorebic.exe application-specific-configuration-schema
 

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/change-layout.md

@@ -7,7 +7,7 @@ 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]
+          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid]
 
 Options:
   -h, --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-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-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/complete-configuration.md

@@ -1,7 +1,7 @@
 # complete-configuration
 
 ```
-For legacy komorebi.ahk or komorebi.ps1 configurations, signal that the final configuration option has been sent
+Signal that the final configuration option has been sent
 
 Usage: komorebic.exe complete-configuration
 

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

@@ -10,7 +10,6 @@ Arguments:
           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

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/enable-autostart.md

@@ -9,15 +9,15 @@ Options:
   -c, --config <CONFIG>
           Path to a static configuration JSON file
 
+  -f, --ffm
+          Enable komorebi's custom focus-follows-mouse implementation
+
       --whkd
           Enable autostart of whkd
 
       --ahk
           Enable autostart of ahk
 
-      --bar
-          Enable autostart of komorebi-bar
-
   -h, --help
           Print help
 

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

@@ -1,7 +1,7 @@
 # fetch-app-specific-configuration
 
 ```
-Fetch the latest version of applications.json from komorebi-application-specific-configuration
+Fetch the latest version of applications.yaml from komorebi-application-specific-configuration
 
 Usage: komorebic.exe fetch-app-specific-configuration
 

docs/cli/float-rule.md

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

docs/cli/focus-follows-mouse.md

@@ -0,0 +1,23 @@
+# focus-follows-mouse
+
+```
+Enable or disable focus follows mouse for the operating system
+
+Usage: komorebic.exe focus-follows-mouse [OPTIONS] <BOOLEAN_STATE>
+
+Arguments:
+  <BOOLEAN_STATE>
+          [possible values: enable, disable]
+
+Options:
+  -i, --implementation <IMPLEMENTATION>
+          [default: windows]
+
+          Possible values:
+          - komorebi: A custom FFM implementation (slightly more CPU-intensive)
+          - windows:  The native (legacy) Windows FFM implementation
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+```

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/format-app-specific-configuration.md

@@ -0,0 +1,16 @@
+# format-app-specific-configuration
+
+```
+Format a YAML file for use with the 'ahk-app-specific-configuration' command
+
+Usage: komorebic.exe format-app-specific-configuration <PATH>
+
+Arguments:
+  <PATH>
+          YAML file from which the application-specific configurations should be loaded
+
+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/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-border-overflow-application.md

@@ -0,0 +1,19 @@
+# identify-border-overflow-application
+
+```
+Identify an application that has overflowing borders
+
+Usage: komorebic.exe identify-border-overflow-application <IDENTIFIER> <ID>
+
+Arguments:
+  <IDENTIFIER>
+          [possible values: exe, class, title]
+
+  <ID>
+          Identifier as a string
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/identify-layered-application.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

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

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/identify-tray-application.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

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

@@ -7,7 +7,7 @@ Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/initial-workspace-rule.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPA
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/load-custom-layout.md

@@ -0,0 +1,16 @@
+# load-custom-layout
+
+```
+Load a custom layout from file for the focused workspace
+
+Usage: komorebic.exe load-custom-layout <PATH>
+
+Arguments:
+  <PATH>
+          JSON or YAML file from which the custom layout definition should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/manage-rule.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/monitor-information.md

@@ -1,12 +0,0 @@
-# monitor-information
-
-```
-Show information about connected monitors
-
-Usage: komorebic.exe monitor-information
-
-Options:
-  -h, --help
-          Print help
-
-```

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

@@ -1,19 +0,0 @@
-# move-to-monitor-workspace
-
-```
-Move the focused window to the specified monitor workspace
-
-Usage: komorebic.exe move-to-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/named-workspace-custom-layout-rule.md

@@ -0,0 +1,22 @@
+# named-workspace-custom-layout-rule
+
+```
+Add a dynamic custom layout for the specified workspace
+
+Usage: komorebic.exe named-workspace-custom-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>
+
+Arguments:
+  <WORKSPACE>
+          Target workspace name
+
+  <AT_CONTAINER_COUNT>
+          The number of window containers on-screen required to trigger this layout rule
+
+  <PATH>
+          JSON or YAML file from which the custom layout definition should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/named-workspace-custom-layout.md

@@ -0,0 +1,19 @@
+# named-workspace-custom-layout
+
+```
+Set a custom layout for the specified workspace
+
+Usage: komorebic.exe named-workspace-custom-layout <WORKSPACE> <PATH>
+
+Arguments:
+  <WORKSPACE>
+          Target workspace name
+
+  <PATH>
+          JSON or YAML file from which the custom layout definition should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

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

@@ -13,7 +13,7 @@ Arguments:
           The number of window containers on-screen required to trigger this layout rule
 
   <LAYOUT>
-          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
+          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid]
 
 Options:
   -h, --help

docs/cli/named-workspace-layout.md

@@ -10,7 +10,7 @@ Arguments:
           Target workspace name
 
   <VALUE>
-          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
+          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid]
 
 Options:
   -h, --help

docs/cli/named-workspace-rule.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/promote-window.md

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

docs/cli/reload-configuration.md

@@ -1,7 +1,7 @@
 # reload-configuration
 
 ```
-Reload legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
+Reload ~/komorebi.ahk (if it exists)
 
 Usage: komorebic.exe reload-configuration
 

docs/cli/remove-title-bar.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/cli/replace-configuration.md

@@ -1,16 +0,0 @@
-# replace-configuration
-
-```
-Replace the configuration of a running instance of komorebi from a static configuration file
-
-Usage: komorebic.exe replace-configuration <PATH>
-
-Arguments:
-  <PATH>
-          Static configuration JSON file from which the configuration should be loaded
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/stack-all.md

@@ -1,12 +0,0 @@
-# stack-all
-
-```
-Stack all windows on the focused workspace
-
-Usage: komorebic.exe stack-all
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/start.md

@@ -6,6 +6,9 @@ Start komorebi.exe as a background process
 Usage: komorebic.exe start [OPTIONS]
 
 Options:
+  -f, --ffm
+          Allow the use of komorebi's custom focus-follows-mouse implementation
+
   -c, --config <CONFIG>
           Path to a static configuration JSON file
 
@@ -21,9 +24,6 @@ Options:
       --ahk
           Start autohotkey configuration file
 
-      --bar
-          Start komorebi-bar in a background process
-
   -h, --help
           Print help
 

docs/cli/stop.md

@@ -9,12 +9,6 @@ Options:
       --whkd
           Stop whkd if it is running as a background process
 
-      --ahk
-          Stop ahk if it is running as a background process
-
-      --bar
-          Stop komorebi-bar if it is running as a background process
-
   -h, --help
           Print help
 

docs/cli/toggle-float-override.md

@@ -1,12 +0,0 @@
-# toggle-float-override
-
-```
-Enable or disable float override, which makes it so every new window opens in floating mode
-
-Usage: komorebic.exe toggle-float-override
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/toggle-focus-follows-mouse.md

@@ -0,0 +1,19 @@
+# toggle-focus-follows-mouse
+
+```
+Toggle focus follows mouse for the operating system
+
+Usage: komorebic.exe toggle-focus-follows-mouse [OPTIONS]
+
+Options:
+  -i, --implementation <IMPLEMENTATION>
+          [default: windows]
+
+          Possible values:
+          - komorebi: A custom FFM implementation (slightly more CPU-intensive)
+          - windows:  The native (legacy) Windows FFM implementation
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+```

docs/cli/toggle-transparency.md

@@ -1,12 +0,0 @@
-# toggle-transparency
-
-```
-Toggle transparency for unfocused windows
-
-Usage: komorebic.exe toggle-transparency
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/toggle-workspace-float-override.md

@@ -1,12 +0,0 @@
-# toggle-workspace-float-override
-
-```
-Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the global value
-
-Usage: komorebic.exe toggle-workspace-float-override
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/toggle-workspace-window-container-behaviour.md

@@ -1,12 +0,0 @@
-# toggle-workspace-window-container-behaviour
-
-```
-Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value
-
-Usage: komorebic.exe toggle-workspace-window-container-behaviour
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/transparency-alpha.md

@@ -1,16 +0,0 @@
-# transparency-alpha
-
-```
-Set the alpha value for unfocused window transparency
-
-Usage: komorebic.exe transparency-alpha <ALPHA>
-
-Arguments:
-  <ALPHA>
-          Alpha
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/unstack-all.md

@@ -1,12 +0,0 @@
-# unstack-all
-
-```
-Unstack all windows in the focused container
-
-Usage: komorebic.exe unstack-all
-
-Options:
-  -h, --help
-          Print help
-
-```

docs/cli/watch-configuration.md

@@ -1,7 +1,7 @@
 # watch-configuration
 
 ```
-Enable or disable watching of legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
+Enable or disable watching of ~/komorebi.ahk (if it exists)
 
 Usage: komorebic.exe watch-configuration <BOOLEAN_STATE>
 

docs/cli/window-hiding-behaviour.md

@@ -10,7 +10,7 @@ Arguments:
           Possible values:
           - hide:     Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)
           - minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)
-          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces
+          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)
 
 Options:
   -h, --help

docs/cli/workspace-custom-layout-rule.md

@@ -0,0 +1,25 @@
+# workspace-custom-layout-rule
+
+```
+Add a dynamic custom layout for the specified workspace
+
+Usage: komorebic.exe workspace-custom-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>
+
+Arguments:
+  <MONITOR>
+          Monitor index (zero-indexed)
+
+  <WORKSPACE>
+          Workspace index on the specified monitor (zero-indexed)
+
+  <AT_CONTAINER_COUNT>
+          The number of window containers on-screen required to trigger this layout rule
+
+  <PATH>
+          JSON or YAML file from which the custom layout definition should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/workspace-custom-layout.md

@@ -0,0 +1,22 @@
+# workspace-custom-layout
+
+```
+Set a custom layout for the specified workspace
+
+Usage: komorebic.exe workspace-custom-layout <MONITOR> <WORKSPACE> <PATH>
+
+Arguments:
+  <MONITOR>
+          Monitor index (zero-indexed)
+
+  <WORKSPACE>
+          Workspace index on the specified monitor (zero-indexed)
+
+  <PATH>
+          JSON or YAML file from which the custom layout definition should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/workspace-layout-rule.md

@@ -16,7 +16,7 @@ Arguments:
           The number of window containers on-screen required to trigger this layout rule
 
   <LAYOUT>
-          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
+          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid]
 
 Options:
   -h, --help

docs/cli/workspace-layout.md

@@ -13,7 +13,7 @@ Arguments:
           Workspace index on the specified monitor (zero-indexed)
 
   <VALUE>
-          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
+          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid]
 
 Options:
   -h, --help

docs/cli/workspace-rule.md

@@ -7,7 +7,7 @@ Usage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
 
 Arguments:
   <IDENTIFIER>
-          [possible values: exe, class, title, path]
+          [possible values: exe, class, title]
 
   <ID>
           Identifier as a string

docs/common-workflows/active-window-border.md

@@ -0,0 +1,38 @@
+# Active Window Border
+
+If you would like to add a visual border around the currently focused window,
+ensure the following options are defined in the `komorebi.json` configuration
+file.
+
+```json
+{
+  "active_window_border": true,
+  "active_window_border_colours": {
+    "single": {
+      "r": 66,
+      "g": 165,
+      "b": 245
+    },
+    "stack": {
+      "r": 256,
+      "g": 165,
+      "b": 66
+    },
+    "monocle": {
+      "r": 255,
+      "g": 51,
+      "b": 153
+    }
+  }
+}
+
+```
+
+It is important to note that the active window border will only apply to
+windows managed by `komorebi`.
+
+This feature is not considered stable and you may encounter visual artifacts
+from time to time.
+
+[![Watch the tutorial
+video](https://img.youtube.com/vi/7_9D22t7KK4/hqdefault.jpg)](https://www.youtube.com/watch?v=7_9D22t7KK4)

docs/common-workflows/animations.md

@@ -1,25 +0,0 @@
-# Animations
-
-If you would like to add window movement animations, ensure the following options are
-defined in the `komorebi.json` configuration file.
-
-```json
-{
-  "animation": {
-    "enabled": true
-  }
-}
-```
-
-Window movement animations only apply to actions taking place within the same monitor
-workspace.
-
-You can optionally set a custom duration in ms with `animation.duration` (default: `250`),
-a custom style with `animation.style` (default: `Linear`), and a custom FPS value with
-`animation.fps` (default: `60`).
-
-It is important to note that higher `fps` and a longer `duration` settings will result
-in increased CPU usage.
-
-This feature is not considered stable, and you may encounter visual artifacts
-from time to time.

docs/common-workflows/autohotkey.md

@@ -1,4 +1,6 @@
-# AutoHotkey
+# AutoHotKey
+
+<!-- TODO: Update this completely -->
 
 If you would like to use Autohotkey, please make sure you have AutoHotKey v2
 installed.
@@ -7,16 +9,22 @@ Generally, users who opt for AHK will have specific needs that can only be
 addressed by the advanced functionality of AHK, and so they are assumed to be
 able to craft their own configuration files.
 
-If you would like to try out AHK, here is a simple sample configuration which
-largely matches the `whkdrc` sample configuration.
+If you would like to try out AHK, a simple sample configuration powered by
+`komorebic.lib.ahk` is provided as a starting point. This sample configuration
+does not take into account the use of a static configuration file; if you
+choose to use a static configuration file alongside AHK, you can remove all the
+configuration options from your `komorebi.ahk` and use it solely to handle
+hotkey bindings.
 
-```autohotkey
-{% include "./komorebi.ahk.txt" %}
+
+```powershell
+# save the latest generated komorebic library to ~/komorebic.lib.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
+
+# save the latest generated app-specific config tweaks and fixes to ~/komorebi.generated.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.generated.ahk -OutFile $Env:USERPROFILE\komorebi.generated.ahk
+
+# save the sample komorebi configuration file to ~/komorebi.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
 ```
 
-By default, the `komorebi.ahk` file should be located in the `$Env:USERPROFILE`
-directory, however, if `$Env:KOMOREBI_CONFIG_HOME` is set, it should be located
-there.
-
-Once the file is in place, you can stop komorebi and whkd by running `komorebic stop --whkd`,
-and then start komorebi with Autohotkey by running `komorebic start --ahk`.

docs/common-workflows/autostart.md

@@ -1,29 +0,0 @@
-# Autostart
-
-If you would like to autostart `komorebi`, you can use the `komorebic enable-autostart` command to generate a shortcut
-in the `shell:startup` folder.
-
-```
-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
-
-  -f, --ffm
-          Enable komorebi's custom focus-follows-mouse implementation
-
-      --whkd
-          Enable autostart of whkd
-
-      --ahk
-          Enable autostart of ahk
-
-      --bar
-          Enable autostart of komorebi-bar
-
-  -h, --help
-          Print help
-```

docs/common-workflows/borders.md

@@ -1,28 +0,0 @@
-# Borders
-
-If you would like to add a visual border around both the currently focused window
-and unfocused windows ensure the following options are defined in the `komorebi.json`
-configuration file.
-
-```json
-{
-  "border": true,
-  "border_width": 8,
-  "border_offset": -1,
-  "border_style": "System",
-  "border_colours": {
-    "single": "#42a5f5",
-    "stack": "#00a542",
-    "monocle": "#ff3399",
-    "unfocused": "#808080"
-  }
-}
-```
-
-It is important to note that borders will only apply to windows managed by `komorebi`.
-
-This feature is not considered stable, and you may encounter visual artifacts
-from time to time.
-
-[![Watch the tutorial
-video](https://img.youtube.com/vi/7_9D22t7KK4/hqdefault.jpg)](https://www.youtube.com/watch?v=7_9D22t7KK4)

docs/common-workflows/custom-layouts.md

@@ -0,0 +1,70 @@
+# 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 in the `komorebi.json` configuration file.
+
+```json
+{
+  "monitors": [
+    {
+      "workspaces": [
+        {
+          "name": "personal",
+          "custom_layout": "C:/Users/LGUG2Z/my-custom-layout.json"
+        },
+      ]
+    }
+  ]
+}
+```
+
+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
+- column: Secondary
+  configuration: !Horizontal 2 # max number of rows
+- column: Primary
+  configuration: !WidthPercentage 50 # percentage of screen
+- column: Tertiary
+  configuration: Horizontal
+```
+
+<!-- TODO: Record a new video -->
+
+[![Watch the tutorial video](https://img.youtube.com/vi/SgmBHKEOcQ4/hqdefault.jpg)](https://www.youtube.com/watch?v=SgmBHKEOcQ4)

docs/common-workflows/dynamic-layout-switching.md

@@ -1,4 +1,4 @@
-# Dynamic Layout Switching
+# Dynamically Layout Switching
 
 With `komorebi` it is possible to define rules to automatically change the
 layout on a specified workspace when a threshold of window containers is met.

docs/common-workflows/floating-applications.md

@@ -1,16 +0,0 @@
-# Floating Windows
-
-Sometimes you will want a specific application to be managed as a floating window.
-You can add rules to enforce this behaviour in the `komorebi.json` configuration file.
-
-```json
-{
-  "floating_applications": [
-    {
-      "kind": "Title",
-      "id": "Media Player",
-      "matching_strategy": "Equals"
-    }
-  ]
-}
-```

docs/common-workflows/focus-follows-mouse.md

@@ -0,0 +1,34 @@
+# 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.
+
+If the `komorebi` process has been started with the `--ffm` flag, you can
+enable focus follows mouse behaviour in the `komorebi.json` configuration file.
+
+```json
+{
+  "focus_follows_mouse": "Komorebi"
+}
+```
+
+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
+```
+
+

docs/common-workflows/force-manage-windows.md

@@ -2,7 +2,7 @@
 
 ❗️**NOTE**: A significant number of force-manage window rules for the most
 common applications are [already generated for
-you](https://github.com/LGUG2Z/komorebi-application-specific-configuration)
+you](https://github.com/LGUG2Z/komorebi/#generating-common-application-specific-configurations)
 
 In some rare cases, a window may not automatically be registered to be managed
 by `komorebi`. You can add rules to enforce this behaviour in the

docs/common-workflows/ignore-windows.md

@@ -2,15 +2,15 @@
 
 ❗️**NOTE**: A significant number of ignored window rules for the most common
 applications are [already generated for
-you](https://github.com/LGUG2Z/komorebi-application-specific-configuration)
+you](https://github.com/LGUG2Z/komorebi/#generating-common-application-specific-configurations)
 
 Sometimes you will want a specific application to never be tiled, and instead
-be completely ignored. You can add rules to enforce this behaviour in the
+float all the time. You can add rules to enforce this behaviour in the
 `komorebi.json` configuration file.
 
 ```json
 {
-  "ignore_rules": [
+  "float_rules": [
     {
       "kind": "Title",
       "id": "Media Player",