mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-05-17 01:07:02 +02:00
Deployed 1accbf6 with MkDocs version: 1.5.2
This commit is contained in:
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4038,29 +4060,28 @@
|
||||
<p>If you would like to add a visual border around the currently focused window,
|
||||
ensure the following options are defined in the <code>komorebi.json</code> configuration
|
||||
file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"active_window_border": true,
|
||||
"active_window_border_style": "Rounded",
|
||||
"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
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"active_window_border"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"active_window_border_style"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rounded"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"active_window_border_colours"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"single"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"r"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"g"</span><span class="p">:</span><span class="w"> </span><span class="mi">165</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"b"</span><span class="p">:</span><span class="w"> </span><span class="mi">245</span>
|
||||
<span class="w"> </span><span class="p">},</span>
|
||||
<span class="w"> </span><span class="nt">"stack"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"r"</span><span class="p">:</span><span class="w"> </span><span class="mi">256</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"g"</span><span class="p">:</span><span class="w"> </span><span class="mi">165</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"b"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span>
|
||||
<span class="w"> </span><span class="p">},</span>
|
||||
<span class="w"> </span><span class="nt">"monocle"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"r"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"g"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"b"</span><span class="p">:</span><span class="w"> </span><span class="mi">153</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>It is important to note that the active window border will only apply to
|
||||
windows managed by <code>komorebi</code>.</p>
|
||||
<p>This feature is not considered stable, and you may encounter visual artifacts
|
||||
|
||||
@@ -466,6 +466,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -534,6 +536,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4030,12 +4052,12 @@ 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 <code>komorebi.ahk</code> and use it solely to handle
|
||||
hotkey bindings.</p>
|
||||
<pre><code class="language-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
|
||||
<div class="highlight"><pre><span></span><code><span class="c"># save the latest generated komorebic library to ~/komorebic.lib.ahk</span>
|
||||
<span class="nb">iwr </span><span class="n">https</span><span class="p">://</span><span class="n">raw</span><span class="p">.</span><span class="n">githubusercontent</span><span class="p">.</span><span class="n">com</span><span class="p">/</span><span class="n">LGUG2Z</span><span class="p">/</span><span class="n">komorebi</span><span class="p">/</span><span class="n">v0</span><span class="p">.</span><span class="n">1</span><span class="p">.</span><span class="n">20</span><span class="p">/</span><span class="n">komorebic</span><span class="p">.</span><span class="n">lib</span><span class="p">.</span><span class="n">ahk</span> <span class="n">-OutFile</span> <span class="nv">$Env:USERPROFILE</span><span class="p">\</span><span class="n">komorebic</span><span class="p">.</span><span class="n">lib</span><span class="p">.</span><span class="n">ahk</span>
|
||||
|
||||
# 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
|
||||
</code></pre>
|
||||
<span class="c"># save the sample komorebi configuration file to ~/komorebi.ahk</span>
|
||||
<span class="nb">iwr </span><span class="n">https</span><span class="p">://</span><span class="n">raw</span><span class="p">.</span><span class="n">githubusercontent</span><span class="p">.</span><span class="n">com</span><span class="p">/</span><span class="n">LGUG2Z</span><span class="p">/</span><span class="n">komorebi</span><span class="p">/</span><span class="n">v0</span><span class="p">.</span><span class="n">1</span><span class="p">.</span><span class="n">20</span><span class="p">/</span><span class="n">komorebi</span><span class="p">.</span><span class="n">sample</span><span class="p">.</span><span class="n">ahk</span> <span class="n">-OutFile</span> <span class="nv">$Env:USERPROFILE</span><span class="p">\</span><span class="n">komorebi</span><span class="p">.</span><span class="n">ahk</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4045,19 +4067,19 @@ Generator</a> to
|
||||
interactively define a custom layout, and then copy the generated JSON content.</p>
|
||||
<p>Custom layouts can be loaded on the current workspace or configured for a
|
||||
specific workspace in the <code>komorebi.json</code> configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"monitors": [
|
||||
{
|
||||
"workspaces": [
|
||||
{
|
||||
"name": "personal",
|
||||
"custom_layout": "C:/Users/LGUG2Z/my-custom-layout.json"
|
||||
},
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"monitors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"workspaces"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"custom_layout"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C:/Users/LGUG2Z/my-custom-layout.json"</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="w"> </span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>The fundamental building block of a custom <em>komorebi</em> layout is the Column.</p>
|
||||
<p>Columns come in three variants:</p>
|
||||
<ul>
|
||||
@@ -4081,13 +4103,13 @@ custom layout, the windows will begin to be arranged according to the
|
||||
constraints set on the Primary and Secondary columns of the layout.</p>
|
||||
<p>Here is an example custom layout that can be used as a starting point for your
|
||||
own:</p>
|
||||
<pre><code class="language-yaml">- column: Secondary
|
||||
configuration: !Horizontal 2 # max number of rows
|
||||
- column: Primary
|
||||
configuration: !WidthPercentage 50 # percentage of screen
|
||||
- column: Tertiary
|
||||
configuration: Horizontal
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secondary</span>
|
||||
<span class="w"> </span><span class="nt">configuration</span><span class="p">:</span><span class="w"> </span><span class="kt">!Horizontal</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span><span class="w"> </span><span class="c1"># max number of rows</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Primary</span>
|
||||
<span class="w"> </span><span class="nt">configuration</span><span class="p">:</span><span class="w"> </span><span class="kt">!WidthPercentage</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">50</span><span class="w"> </span><span class="c1"># percentage of screen</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Tertiary</span>
|
||||
<span class="w"> </span><span class="nt">configuration</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Horizontal</span>
|
||||
</code></pre></div>
|
||||
<!-- TODO: Record a new video -->
|
||||
|
||||
<p><a href="https://www.youtube.com/watch?v=SgmBHKEOcQ4"><img alt="Watch the tutorial video" src="https://img.youtube.com/vi/SgmBHKEOcQ4/hqdefault.jpg" /></a></p>
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4037,33 +4059,33 @@
|
||||
<h1 id="dynamically-layout-switching">Dynamically Layout Switching</h1>
|
||||
<p>With <code>komorebi</code> it is possible to define rules to automatically change the
|
||||
layout on a specified workspace when a threshold of window containers is met.</p>
|
||||
<pre><code class="language-json">{
|
||||
"monitors": [
|
||||
{
|
||||
"workspaces": [
|
||||
{
|
||||
"name": "personal",
|
||||
"layout_rules": {
|
||||
"1": "BSP"
|
||||
}
|
||||
"custom_layout_rules": {
|
||||
"5": "C:/Users/LGUG2Z/my-custom-layout.json"
|
||||
}
|
||||
},
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"monitors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"workspaces"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"personal"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"layout_rules"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BSP"</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="w"> </span><span class="nt">"custom_layout_rules"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"5"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C:/Users/LGUG2Z/my-custom-layout.json"</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="w"> </span><span class="p">}</span>
|
||||
<span class="w"> </span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>In this example, when there are one or more window containers visible on the
|
||||
screen, the BSP layout is used, and when there are five or more window
|
||||
containers visible, a custom layout is used.</p>
|
||||
<p>However, if you add workspace layout rules, you will not be able to manually
|
||||
change the layout of a workspace until all layout rules for that workspace have
|
||||
been cleared.</p>
|
||||
<pre><code class="language-powershell"># for example, to clear rules from monitor 0, workspace 0
|
||||
komorebic clear-workspace-layout-rules 0 0
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="c"># for example, to clear rules from monitor 0, workspace 0</span>
|
||||
<span class="n">komorebic</span> <span class="nb">clear-workspace</span><span class="n">-layout-rules</span> <span class="n">0</span> <span class="n">0</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4048,16 +4070,16 @@ persists regardless of whether focus-follows-mouse is enabled or disabled at
|
||||
any given time via <code>komorebic</code>'s configuration commands.</p>
|
||||
<p>If the <code>komorebi</code> process has been started with the <code>--ffm</code> flag, you can
|
||||
enable focus follows mouse behaviour in the <code>komorebi.json</code> configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"focus_follows_mouse": "Komorebi"
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"focus_follows_mouse"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Komorebi"</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>When calling any of the <code>komorebic</code> commands related to focus-follows-mouse
|
||||
functionality, the <code>windows</code> implementation will be chosen as the default
|
||||
implementation. You can optionally specify the <code>komorebi</code> implementation by
|
||||
passing it as an argument to the <code>--implementation</code> flag:</p>
|
||||
<pre><code class="language-powershell">komorebic.exe toggle-focus-follows-mouse --implementation komorebi
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="n">komorebic</span><span class="p">.</span><span class="n">exe</span> <span class="n">toggle-focus-follows-mouse</span> <span class="p">-</span><span class="n">-implementation</span> <span class="n">komorebi</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4041,16 +4063,16 @@ you</a></p>
|
||||
<p>In some rare cases, a window may not automatically be registered to be managed
|
||||
by <code>komorebi</code>. You can add rules to enforce this behaviour in the
|
||||
<code>komorebi.json</code> configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"manage_rules": [
|
||||
{
|
||||
"kind": "Title",
|
||||
"id": "Media Player",
|
||||
"matching_strategy": "Equals"
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"manage_rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"kind"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Title"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Media Player"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"matching_strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equals"</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="w"> </span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4041,16 +4063,16 @@ you</a></p>
|
||||
<p>Sometimes you will want a specific application to never be tiled, and instead
|
||||
float all the time. You can add rules to enforce this behaviour in the
|
||||
<code>komorebi.json</code> configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"float_rules": [
|
||||
{
|
||||
"kind": "Title",
|
||||
"id": "Media Player",
|
||||
"matching_strategy": "Equals"
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"float_rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"kind"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Title"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Media Player"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"matching_strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equals"</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="w"> </span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="prev" href="../example-configurations.html">
|
||||
<link rel="prev" href="../troubleshooting.html">
|
||||
|
||||
|
||||
<link rel="next" href="active-window-border.html">
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4039,18 +4061,18 @@
|
||||
directory, you can specify a custom directory by setting the
|
||||
<code>$Env:KOMOREBI_CONFIG_HOME</code> environment variable.</p>
|
||||
<p>For example, to use the <code>~/.config/komorebi</code> directory:</p>
|
||||
<pre><code class="language-powershell"># Run this command to make sure that the directory has been created
|
||||
mkdir -p ~/.config/komorebi
|
||||
<div class="highlight"><pre><span></span><code><span class="c"># Run this command to make sure that the directory has been created</span>
|
||||
<span class="n">mkdir</span> <span class="n">-p</span> <span class="p">~/.</span><span class="n">config</span><span class="p">/</span><span class="n">komorebi</span>
|
||||
|
||||
# Run this command to open up your PowerShell profile configuration in Notepad
|
||||
notepad $PROFILE
|
||||
<span class="c"># Run this command to open up your PowerShell profile configuration in Notepad</span>
|
||||
<span class="n">notepad</span> <span class="nv">$PROFILE</span>
|
||||
|
||||
# Add this line (with your login user!) to the bottom of your PowerShell profile configuration
|
||||
$Env:KOMOREBI_CONFIG_HOME = 'C:\Users\LGUG2Z\.config\komorebi'
|
||||
<span class="c"># Add this line (with your login user!) to the bottom of your PowerShell profile configuration</span>
|
||||
<span class="nv">$Env:KOMOREBI_CONFIG_HOME</span> <span class="p">=</span> <span class="s1">'C:\Users\LGUG2Z\.config\komorebi'</span>
|
||||
|
||||
# Save the changes and then reload the PowerShell profile
|
||||
. $PROFILE
|
||||
</code></pre>
|
||||
<span class="c"># Save the changes and then reload the PowerShell profile</span>
|
||||
<span class="p">.</span> <span class="nv">$PROFILE</span>
|
||||
</code></pre></div>
|
||||
<p>If you already have configuration files that you wish to keep, move them to the
|
||||
<code>~/.config/komorebi</code> directory.</p>
|
||||
<p>The next time you run <code>komorebic start</code>, any files created by or loaded by
|
||||
@@ -4086,7 +4108,7 @@ video" src="https://img.youtube.com/vi/C_KWUqQ6kko/hqdefault.jpg" /></a></p>
|
||||
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
||||
|
||||
|
||||
<a href="../example-configurations.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Example configurations" rel="prev">
|
||||
<a href="../troubleshooting.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Troubleshooting" rel="prev">
|
||||
<div class="md-footer__button md-icon">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
||||
@@ -4096,7 +4118,7 @@ video" src="https://img.youtube.com/vi/C_KWUqQ6kko/hqdefault.jpg" /></a></p>
|
||||
Previous
|
||||
</span>
|
||||
<div class="md-ellipsis">
|
||||
Example configurations
|
||||
Troubleshooting
|
||||
</div>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4038,10 +4060,10 @@
|
||||
<p>By default, the mouse will move to the center of the window when the focus is
|
||||
changed in a given direction. This behaviour is know as 'mouse follows focus'.
|
||||
This behaviour can be disabled in the <code>komorebi.json</code> configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"mouse_follows_focus": false,
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"mouse_follows_focus"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<!-- TODO: Record a new video -->
|
||||
|
||||
<p><a href="https://www.youtube.com/watch?v=LBoyXQiNINc"><img alt="Watch the tutorial video" src="https://img.youtube.com/vi/LBoyXQiNINc/hqdefault.jpg" /></a></p>
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4039,13 +4061,13 @@
|
||||
themselves, and between the monitor edges and the windows, you can set the
|
||||
following configuration options to <code>0</code> and <code>-1</code> in the <code>komorebi.json</code>
|
||||
configuration file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"default_workspace_padding": 0,
|
||||
"default_container_padding": 0,
|
||||
"border_width": 0,
|
||||
"border_offset": -1
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"default_workspace_padding"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"default_container_padding"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"border_width"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"border_offset"</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>A restart of <code>komorebi</code> is required after changing these settings.</p>
|
||||
<p><a href="https://www.youtube.com/watch?v=6QYLao953XE"><img alt="Watch the tutorial video" src="https://img.youtube.com/vi/6QYLao953XE/hqdefault.jpg" /></a></p>
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4038,19 +4060,19 @@
|
||||
<p>If you would like to add a visual stackbar to show which windows are in a container
|
||||
stack ensure the following options are defined in the <code>komorebi.json</code> configuration
|
||||
file.</p>
|
||||
<pre><code class="language-json">{
|
||||
"stackbar": {
|
||||
"height": 40,
|
||||
"mode": "OnStack",
|
||||
"tabs": {
|
||||
"width": 300,
|
||||
"focused_text": "#00a542",
|
||||
"unfocused_text": "#b3b3b3",
|
||||
"background": "#141414"
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"stackbar"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"height"</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"mode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OnStack"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"tabs"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"width"</span><span class="p">:</span><span class="w"> </span><span class="mi">300</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"focused_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#00a542"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"unfocused_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#b3b3b3"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"background"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#141414"</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>This feature is not considered stable, and you may encounter visual artifacts
|
||||
from time to time.</p>
|
||||
|
||||
|
||||
@@ -472,6 +472,8 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
@@ -540,6 +542,26 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../troubleshooting.html" class="md-nav__link">
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Troubleshooting
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -4043,16 +4065,16 @@ but minimizing the same window does not, you have probably enabled a
|
||||
'close/minimize to tray' option for that application. You can tell <code>komorebi</code>
|
||||
to handle this application appropriately by identifying it via the executable
|
||||
name or the window class.</p>
|
||||
<pre><code class="language-json">{
|
||||
"tray_and_multi_window_applications": [
|
||||
{
|
||||
"kind": "Class",
|
||||
"id": "SDL_app",
|
||||
"matching_strategy": "Equals"
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"tray_and_multi_window_applications"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
||||
<span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"kind"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Class"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SDL_app"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"matching_strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equals"</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="w"> </span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user