Deployed 1accbf6 with MkDocs version: 1.5.2

This commit is contained in:
LGUG2Z committed 2024-05-10 14:48:42 -07:00
1 parent 8ca13170f7
commit e3f962df55
2 files changed
+53 -27

No files matched your search

+1 -1
View File
@@ -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> <p>With the example configurations downloaded, you can now start <code>komorebi</code> and `whkd.</p> <pre><code>komorebic start --whkd\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.25/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\"border_width\": 8,\n\"border_offset\": -1,\n\"active_window_border\": false,\n\"active_window_border_colours\": {\n\"single\": \"#42a5f5\",\n\"stack\": \"#00a542\",\n\"monocle\": \"#ff3399\"\n},\n\"stackbar\": {\n\"height\": 40,\n\"mode\": \"Never\",\n\"tabs\": {\n\"width\": 300,\n\"focused_text\": \"#00a542\",\n\"unfocused_text\": \"#b3b3b3\",\n\"background\": \"#141414\"\n}\n},\n\"monitors\": [\n{\n\"workspaces\": [\n{\n\"name\": \"I\",\n\"layout\": \"BSP\"\n},\n{\n\"name\": \"II\",\n\"layout\": \"VerticalStack\"\n},\n{\n\"name\": \"III\",\n\"layout\": \"HorizontalStack\"\n},\n{\n\"name\": \"IV\",\n\"layout\": \"UltrawideVerticalStack\"\n},\n{\n\"name\": \"V\",\n\"layout\": \"Rows\"\n},\n{\n\"name\": \"VI\",\n\"layouLine 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> <p>With the example configurations downloaded, you can now start <code>komorebi</code> and `whkd.</p> <pre><code>komorebic start --whkd\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.25/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\"border_width\": 8,\n\"border_offset\": -1,\n\"active_window_border\": false,\n\"active_window_border_colours\": {\n\"single\": \"#42a5f5\",\n\"stack\": \"#00a542\",\n\"monocle\": \"#ff3399\"\n},\n\"stackbar\": {\n\"height\": 40,\n\"mode\": \"Never\",\n\"tabs\": {\n\"width\": 300,\n\"focused_text\": \"#00a542\",\n\"unfocused_text\": \"#b3b3b3\",\n\"background\": \"#141414\"\n}\n},\n\"monitors\": [\n{\n\"workspaces\": [\n{\n\"name\": \"I\",\n\"layout\": \"BSP\"\n},\n{\n\"name\": \"II\",\n\"layout\": \"VerticalStack\"\n},\n{\n\"name\": \"III\",\n\"layout\": \"HorizontalStack\"\n},\n{\n\"name\": \"IV\",\n\"layout\": \"UltrawideVerticalStack\"\n},\n{\n\"name\": \"V\",\n\"layout\": \"Rows\"\n},\n{\n\"name\": \"VI\",\n\"layouLine truncated
+52 -26
View File
@@ -595,6 +595,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#autohotkey-executable-not-found" class="md-nav__link">
AutoHotKey executable not found
</a>
</li>
<li class="md-nav__item">
<a href="#komorebi-is-unresponsive-when-the-display-wakes-from-sleep" class="md-nav__link">
Komorebi is unresponsive when the display wakes from sleep
@@ -4097,6 +4104,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#autohotkey-executable-not-found" class="md-nav__link">
AutoHotKey executable not found
</a>
</li>
<li class="md-nav__item">
<a href="#komorebi-is-unresponsive-when-the-display-wakes-from-sleep" class="md-nav__link">
Komorebi is unresponsive when the display wakes from sleep
@@ -4163,6 +4177,18 @@
<h1 id="troubleshooting">Troubleshooting</h1>
<h2 id="autohotkey-executable-not-found">AutoHotKey executable not found</h2>
<p>If you try to start komorebi with AHK using <code>komorebic start --ahk</code>, and you have
not installed AHK using <code>scoop</code>, you'll probably receive an error:</p>
<div class="highlight"><pre><span></span><code>Error: could not find autohotkey, please make sure it is installed before using the --ahk flag
</code></pre></div>
<p>Depending on how AHK is installed the executable on your system may have a
different name. In order to account for this, you may set the <code>KOMOREBI_AHK_EXE</code>
environment variable in your
<a href="https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-7.4">PowerShell profile</a>
to match the name of the executable as it is found on your system.</p>
<p>After setting <code>KOMOREBI_AHK_EXE</code> make sure to either reload your PowerShell
profile or open a new terminal tab.</p>
<h2 id="komorebi-is-unresponsive-when-the-display-wakes-from-sleep">Komorebi is unresponsive when the display wakes from sleep</h2>
<p>This can happen in rare cases when your monitor state is not preserved after it
wakes from sleep.</p>
@@ -4178,8 +4204,8 @@ disrupt how the device is persisted in the <em>komorebi</em> state following sus
alias by referring to the manufacturer's documentation.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Disabling VRR within Windows (e.g. <em>Nvidia Control Panel</em>) may work and can indeed
change the configuration you see within your monitor's OSD, but some monitors
<p>Disabling VRR within Windows (e.g. <em>Nvidia Control Panel</em>) may work and can indeed
change the configuration you see within your monitor's OSD, but some monitors
will re-enable the setting regardless following suspension.</p>
</div>
<h3 id="reproducing">Reproducing</h3>
@@ -4188,8 +4214,8 @@ normal.</p>
<p>If <em>komorebi</em> is already unresponsive, then please restart <em>komorebi</em> first by
running <code>komorebic stop</code> and <code>komorebic start</code>.</p>
<ol>
<li>
<p><strong><code>komorebic state</code></strong></p>
<li><strong><code>komorebic state</code></strong></li>
</ol>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;monitors&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;elements&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
@@ -4210,29 +4236,31 @@ running <code>komorebic stop</code> and <code>komorebic start</code>.</p>
<span class="p">}</span>
</code></pre></div>
<p>This appears to be fine -- <em>komorebi</em> is aware of the device and associated
window handles. </p>
</li>
<li>
<p><strong>Let your display go to sleep.</strong></p>
window handles.</p>
<ol>
<li><strong>Let your display go to sleep.</strong></li>
</ol>
<p>Simply turning the monitor off is not enough to reproduce the problem; you must
let Windows turn off the display itself.</p>
let Windows turn off the display itself.</p>
<p>To avoid waiting an eternity:</p>
<ul>
<li><em>Control Panel</em> -&gt; <em>Hardware and Sound</em> -&gt; <em>Power Options</em> -&gt; <em>Edit Plan
Settings</em></li>
</ul>
<li>
<p><em>Control Panel</em> -&gt; <em>Hardware and Sound</em> -&gt; <em>Power Options</em> -&gt; <em>Edit Plan
Settings</em></p>
<p><em>Turn off the display: 1 minute</em></p>
</li>
</ul>
<p>Allow a minute for the display to reset, then once it actually shuts off
allow for any additional time as prompted by your monitor for the cycle to
complete.</p>
</li>
<li>
<p><strong>Wake your display again</strong> by pressing any key.</p>
allow for any additional time as prompted by your monitor for the cycle to
complete.</p>
<ol>
<li><strong>Wake your display again</strong> by pressing any key.</li>
</ol>
<p><em>komorebi</em> should now be unresponsive.</p>
</li>
<li>
<p><strong><code>komorebic state</code></strong></p>
<p>Don't stop <em>komorebi</em> just yet. </p>
<ol>
<li><strong><code>komorebic state</code></strong></li>
</ol>
<p>Don't stop <em>komorebi</em> just yet.</p>
<p>Since it's unresponsive, you can open another shell instead to execute the above command.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;monitors&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
@@ -4241,17 +4269,15 @@ complete.</p>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">65537</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;DISPLAY1&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;device&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;device_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;device_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>We can see the <em>komorebi</em> state is no longer associated with the previous
device: <code>null</code>, suggesting an issue when the display resumes from a suspended
state.</p>
</li>
</ol>
device: <code>null</code>, suggesting an issue when the display resumes from a suspended
state.</p>