Deployed 40947e3 with MkDocs version: 1.5.2

installation.html

@@ -545,6 +545,13 @@
     Long path support
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#local-data-directory" class="md-nav__link">
+    Local data directory
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -3919,6 +3926,13 @@
     Long path support
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#local-data-directory" class="md-nav__link">
+    Local data directory
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -4034,6 +4048,11 @@ running the following command in an Administrator Terminal before installing
 <code>komorebi</code>.</p>
 <pre><code class="language-powershell">Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1
 </code></pre>
+<h2 id="local-data-directory">Local data directory</h2>
+<p>If you are installing <code>komorebi</code> for the first time on a new machine, create a
+dedicated folder for <code>komorebi</code> in <code>$Env:LOCALAPPDATA</code>.</p>
+<pre><code class="language-powershell">mkdir &quot;$Env:LOCALAPPDATA\komorebi&quot; -ea 0
+</code></pre>
 <h2 id="scoop">Scoop</h2>
 <p>Make sure you have installed <a href="https://scoop.sh"><code>scoop</code></a> and verified that
 installed binaries are available in your <code>$PATH</code> before proceeding.</p>

search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Index","text":"<p><code>komorebi</code> is a tiling window manager that works as an extension to Microsoft's Desktop Window Manager in Windows 10 and above.</p> <p><code>komorebi</code> allows you to control application windows, virtual workspaces and display monitors with a CLI which can be used with third-party software such as AutoHotKey to set user-defined keyboard shortcuts.</p> <p><code>komorebi</code> 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 <code>komorebi</code>, but these will always remain opt-in and off-by-default.</p> <p>There is a Discord server available for <code>komorebi</code>-related discussion, help, troubleshooting etc. If you have any specific feature requests or bugs to report, please create an issue on GitHub.</p> <p>There is also a YouTube channel where I share <code>komorebi</code> live programming videos and tutorial videos.</p>"},{"location":"design.html","title":"Design","text":""},{"location":"design.html#description","title":"Description","text":"<p>komorebi only responds to WinEvents and the messages it receives on a dedicated socket.</p> <p>komorebic is a CLI that writes messages on komorebi's socket.</p> <p>komorebi doesn't handle any keyboard or mouse inputs; a third party program (e.g. whkd) is needed in order to translate keyboard and mouse events to komorebic commands.</p> <p>This architecture, popularised by bspwm on Linux and yabai on macOS, is outlined as follows:</p> <pre><code>          PROCESS                SOCKET\nwhkd/ahk  --------&gt;  komorebic  &lt;------&gt;  komorebi\n</code></pre>"},{"location":"design.html#data-model","title":"Data Model","text":"<p>komorebi holds a list of physical monitors.</p> <p>A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.</p> <p>A workspace holds a list of containers.</p> <p>A container is just a rectangle where one or more application windows can be displayed.</p> <p>This means that:</p> <ul> <li>Every monitor has its own collection of virtual workspaces</li> <li>Workspaces only know about containers and their dimensions, not about individual application windows</li> <li>Every application window must belong to a container, even if that container only contains one application window</li> <li>Many application windows can be stacked and cycled through in the same container within a workspace</li> </ul>"},{"location":"example-configurations.html","title":"Example configurations","text":"<p><code>komorebi</code>, and tiling window managers in general, are very complex pieces of software.</p> <p>In an attempt to reduce some of the initial configuration burden for users who are looking to try out the software for the first time, example configurations are provided and updated whenever appropriate.</p>"},{"location":"example-configurations.html#downloading-example-configurations","title":"Downloading example configurations","text":"<p>Run the following command to download example configuration files for <code>komorebi</code> and <code>whkd</code>. Pay attention to the output of the command to see where the example files have been downloaded. For most new users this will be in the <code>$Env:USERPROFILE</code> directory.</p> <pre><code>komorebic quickstart\n</code></pre>"},{"location":"example-configurations.html#komorebijson","title":"komorebi.json","text":"<p>The example window manager configuration sets some sane defaults and provides five preconfigured workspaces on the primary monitor each with a different layout.</p> <pre><code>{\n  \"$schema\": \"https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/schema.json\",\n  \"app_specific_configuration_path\": \"$Env:USERPROFILE/applications.yaml\",\n  \"window_hiding_behaviour\": \"Cloak\",\n  \"cross_monitor_move_behaviour\": \"Insert\",\n  \"default_workspace_padding\": 20,\n  \"default_container_padding\": 20,\n  \"active_window_border\": false,\n  \"active_window_border_colours\": {\n    \"single\": { \"r\": 66, \"g\": 165, \"b\": 245 },\n    \"stack\": { \"r\": 256, \"g\": 165, \"b\": 66 },\n    \"monocle\": { \"r\": 255, \"g\": 51, \"b\": 153 }\n  },\n  \"monitors\": [\n    {\n      \"workspaces\": [\n        { \"name\": \"I\", \"layout\": \"BSP\" },\n        { \"name\": \"II\", \"layout\": \"VerticalStack\" },\n        { \"name\": \"III\", \"layout\": \"HorizontalStack\" },\n        { \"name\": \"IV\", \"layout\": \"UltrawideVerticalStack\" },\n        { \"name\": \"V\", \"layout\": \"Rows\" }\n      ]\n    }\n  ]\n}\n</code></pre>"},{"location":"example-configurations.html#application-specific-configuration","title":"Application-specific configuration","text":"<p>There is a community-maintained repository of \"apps behaving badly\" that do not conform to WindLine truncated
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Index","text":"<p><code>komorebi</code> is a tiling window manager that works as an extension to Microsoft's Desktop Window Manager in Windows 10 and above.</p> <p><code>komorebi</code> allows you to control application windows, virtual workspaces and display monitors with a CLI which can be used with third-party software such as AutoHotKey to set user-defined keyboard shortcuts.</p> <p><code>komorebi</code> 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 <code>komorebi</code>, but these will always remain opt-in and off-by-default.</p> <p>There is a Discord server available for <code>komorebi</code>-related discussion, help, troubleshooting etc. If you have any specific feature requests or bugs to report, please create an issue on GitHub.</p> <p>There is also a YouTube channel where I share <code>komorebi</code> live programming videos and tutorial videos.</p>"},{"location":"design.html","title":"Design","text":""},{"location":"design.html#description","title":"Description","text":"<p>komorebi only responds to WinEvents and the messages it receives on a dedicated socket.</p> <p>komorebic is a CLI that writes messages on komorebi's socket.</p> <p>komorebi doesn't handle any keyboard or mouse inputs; a third party program (e.g. whkd) is needed in order to translate keyboard and mouse events to komorebic commands.</p> <p>This architecture, popularised by bspwm on Linux and yabai on macOS, is outlined as follows:</p> <pre><code>          PROCESS                SOCKET\nwhkd/ahk  --------&gt;  komorebic  &lt;------&gt;  komorebi\n</code></pre>"},{"location":"design.html#data-model","title":"Data Model","text":"<p>komorebi holds a list of physical monitors.</p> <p>A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.</p> <p>A workspace holds a list of containers.</p> <p>A container is just a rectangle where one or more application windows can be displayed.</p> <p>This means that:</p> <ul> <li>Every monitor has its own collection of virtual workspaces</li> <li>Workspaces only know about containers and their dimensions, not about individual application windows</li> <li>Every application window must belong to a container, even if that container only contains one application window</li> <li>Many application windows can be stacked and cycled through in the same container within a workspace</li> </ul>"},{"location":"example-configurations.html","title":"Example configurations","text":"<p><code>komorebi</code>, and tiling window managers in general, are very complex pieces of software.</p> <p>In an attempt to reduce some of the initial configuration burden for users who are looking to try out the software for the first time, example configurations are provided and updated whenever appropriate.</p>"},{"location":"example-configurations.html#downloading-example-configurations","title":"Downloading example configurations","text":"<p>Run the following command to download example configuration files for <code>komorebi</code> and <code>whkd</code>. Pay attention to the output of the command to see where the example files have been downloaded. For most new users this will be in the <code>$Env:USERPROFILE</code> directory.</p> <pre><code>komorebic quickstart\n</code></pre>"},{"location":"example-configurations.html#komorebijson","title":"komorebi.json","text":"<p>The example window manager configuration sets some sane defaults and provides five preconfigured workspaces on the primary monitor each with a different layout.</p> <pre><code>{\n  \"$schema\": \"https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/schema.json\",\n  \"app_specific_configuration_path\": \"$Env:USERPROFILE/applications.yaml\",\n  \"window_hiding_behaviour\": \"Cloak\",\n  \"cross_monitor_move_behaviour\": \"Insert\",\n  \"default_workspace_padding\": 20,\n  \"default_container_padding\": 20,\n  \"active_window_border\": false,\n  \"active_window_border_colours\": {\n    \"single\": { \"r\": 66, \"g\": 165, \"b\": 245 },\n    \"stack\": { \"r\": 256, \"g\": 165, \"b\": 66 },\n    \"monocle\": { \"r\": 255, \"g\": 51, \"b\": 153 }\n  },\n  \"monitors\": [\n    {\n      \"workspaces\": [\n        { \"name\": \"I\", \"layout\": \"BSP\" },\n        { \"name\": \"II\", \"layout\": \"VerticalStack\" },\n        { \"name\": \"III\", \"layout\": \"HorizontalStack\" },\n        { \"name\": \"IV\", \"layout\": \"UltrawideVerticalStack\" },\n        { \"name\": \"V\", \"layout\": \"Rows\" }\n      ]\n    }\n  ]\n}\n</code></pre>"},{"location":"example-configurations.html#application-specific-configuration","title":"Application-specific configuration","text":"<p>There is a community-maintained repository of \"apps behaving badly\" that do not conform to WindLine truncated