<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/wpaperd @ main</title>
<meta name="description" content="README.md in fork/wpaperd at main.">
<meta property="og:title" content="README.md - fork/wpaperd @ main">
<meta property="og:description" content="README.md in fork/wpaperd at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="eb0422cb06fc46d1bbac968e0996f6f9b4614197">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wpaperd</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wpaperd</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Danilo Spinella</span><span class="commit-message" data-commit="8f1555cdcb559879abb357ae7cd945332ae21f5f">Update README.md</span><span class="snapshot-sha sha" data-commit="8f1555cdcb559879abb357ae7cd945332ae21f5f">8f1555c</span><time datetime="2024-04-15T12:10:54+02:00" title="2024-04-15 12:10:54 +0200">2024-04-15</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a href="/fork/wpaperd/ref/egl-buffer/">egl-buffer</a><a href="/fork/wpaperd/ref/follow-links/">follow-links</a><a class="current" href="/fork/wpaperd/ref/main/">main</a><strong>tags</strong><a href="/fork/wpaperd/ref/0.1.0/">0.1.0</a><a href="/fork/wpaperd/ref/0.1.1/">0.1.1</a><a href="/fork/wpaperd/ref/0.2.0/">0.2.0</a><a href="/fork/wpaperd/ref/0.3.0/">0.3.0</a><a class="all" href="/fork/wpaperd/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wpaperd/">wpaperd</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>5.6 KiB</span><span>173 lines</span></span><span class="actions"><a class="raw" href="/fork/wpaperd/raw/3564e19ee982cffd7925890116d926d74b6712c5/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>wpaperd</h1>
<p><img src="https://img.shields.io/github/v/release/danyspin97/wpaperd?logo=github&amp;style=flat-square" alt="GitHub&#39;s release (latest by date)" />
<a href="https://github.com/danyspin97/wpaperd/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/danyspin97/wpaperd?logo=github&amp;style=flat-square" alt="GitHub license" /></a>
<img src="https://img.shields.io/github/actions/workflow/status/danyspin97/wpaperd/cargo.yml?branch=main&amp;logo=github&amp;style=flat-square" alt="GitHub Workflow Status" /></p>
<p><strong>wpaperd</strong> is the modern wallpaper daemon for Wayland. It dynamically changes the current wallpaper,
either after a certain amount of time or via a command-line interface. It uses OpenGL ES to render
the images and have beautiful hardware-accelerated transitions, while being easy on resources.</p>
<p><em>Notice</em>: wpaperd uses wayland protocols available on all wlroots based compositors (sway,
hyprland, ...) and on KDE. <strong>Therefore it won't work on GNOME.</strong></p>
<h2>Features</h2>
<ul>
<li>Different wallpaper for each display</li>
<li>Pick a wallpaper from a directory</li>
<li>Change the wallpaper after a set time</li>
<li>Multiple sorting methods (random or ordered)</li>
<li>Flexible TOML configuration file</li>
<li>Hot config reloading for all settings</li>
<li>Easy to use command line interface</li>
<li>Hardware-accelerated configurable transitions</li>
<li>Multiple background modes (center, fit, fill)</li>
<li>Easy on resources (low CPU and memory usage)</li>
</ul>
<h2>Getting started</h2>
<h3>Dependencies</h3>
<p><em>wpaperd</em> is written in Rust and requires a working Cargo installation. It also depends on:</p>
<ul>
<li><code>mesa</code></li>
<li><code>wayland-client</code></li>
<li><code>wayland-egl</code></li>
<li><code>rinstall</code> (optional for installing <code>wpaperd</code>)</li>
</ul>
<h3>Build</h3>
<p>To install <code>wpaperd</code>, clone the repository and build the project:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>git</a-pr> clone https://github.com/danyspin97/wpaperd
<a-o>$</a-o><a-f> </a-f><a-pr>cd</a-pr> wpaperd
<a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> build <a-co>--release</a-co></pre>
<p>Generate the man pages by running <code>scdoc</code>:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>scdoc</a-pr> <a-o>&lt;</a-o> man/wpaperd-output.5.scd <a-o>&gt;</a-o> man/wpaperd-output.5</pre>
<h3>Install</h3>
<p>You can install both the daemon (<code>wpaperd</code>) and cli (<code>wpaperctl</code>) using <strong>rinstall</strong>:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>rinstall</a-pr> <a-co>--yes</a-co></pre>
<p>To run <em>wpaperd</em>, run the <strong>daemon</strong>:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>wpaperd</a-pr></pre>
<p>If you want to automatically run it at startup, add this line to your sway configuration
(located in <code>$HOME/.config/sway/config</code>):</p>
<pre># Assuming it has been installed in ~/.local/bin/wpaperd
exec ~/.local/bin/wpaperd -d
</pre>
<p>Or in Hyprland:</p>
<pre>exec-once=~/.local/bin/wpaperd -d
</pre>
<h2>Image formats support</h2>
<p>loading and dislaying images. Have a look on its
<a href="https://github.com/image-rs/image/blob/main/README.md#supported-image-formats">documentation</a>
for the supported formats.</p>
<h2>Cycling images</h2>
<p>When <code>path</code> is set to a directory, you can cycle the images by running the commands <code>next</code> and
<code>previous</code> using <em>wpaperctl</em>:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>wpaperctl</a-pr> next
<a-o>$</a-o><a-f> </a-f><a-pr>wpaperctl</a-pr> previous</pre>
<p>When <code>sorting</code> is set to <code>asceding</code> and <code>desceding</code>, <em>wpaperd</em> will use the wallpaper name to
calculate the next wallpaper accordingly. When <code>sorting</code> is set to <code>random</code>, it will store
all the wallpapers shown in a queue, so that the commands <code>next</code> and <code>previous</code> can work
as intended.</p>
<h2>Wallpaper Configuration</h2>
<p>The configuration file for <em>wpaperd</em> is located in <code>XDG_CONFIG_HOME/wpaperd/config.toml</code>
(which defaults to <code>~/.config/wpaperd/config.toml</code>). Each section
represents a different output and can contain the following keys:</p>
<ul>
<li><code>path</code>, path to the image to use as wallpaper or to a directory to pick the wallpaper from</li>
<li><code>duration</code>, how much time the image should be displayed until it is changed with a new one.
It supports a human format for declaring the duration (e.g. <code>30s</code> or <code>10m</code>), described
<a href="https://docs.rs/humantime/latest/humantime/fn.parse_duration.html">here</a>.
This is only valid when path points to a directory. (<em>Optional</em>)</li>
<li><code>sorting</code>, choose the sorting order. Valid options are <code>ascending</code>, <code>descending</code>, and <code>random</code>,
with the default being <code>random</code>. This is only valid when path points to a directory. (<em>Optional</em>)</li>
<li><code>mode</code>, choose how to display the wallpaper when the size is different than the display
resolution:
<ul>
<li><code>fit</code> shows the entire image with black corners covering the empty space left</li>
<li><code>center</code> centers the image on the screen, leaving out the corners of the image that couldn't fit</li>
<li><code>stretch</code> shows the entire image stretching it to fit the entire screen without leaving any
black corner, changing the aspect ratio</li>
<li><code>tile</code> shows the image multiple times horizontally and vertically to fill the screen</li>
</ul>
</li>
<li><code>transition_time</code>, how many milliseconds should the transition run. (<em>Optional</em>, <code>300</code> by default).</li>
<li><code>queue_size</code>, decide how big the queue should be when <code>path</code> is set a directory and <code>sorting</code> is
set to <code>random</code>. (<em>Optional</em>, <code>10</code> by default)</li>
</ul>
<p>The section <code>default</code> will be used as base for the all the display configuration; the section
<code>any</code> will be used for all the displays that are not explictly listed. This allows to have a
flexible configuration without repeating any settings. <em>wpaperd</em> will check the configuration at
startup and each time it changes and provide help when it is incorrect.</p>
<p>This is the simplest configuration:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>DP-3</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/github_octupus.png&quot;</a-s>

<a-p>[</a-p><a-pr>DP-4</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/Wallpapers&quot;</a-s>
<a-pr>duration</a-pr> <a-o>=</a-o> <a-s>&quot;30m&quot;</a-s></pre>
<p>This is a more complex configuration:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>default</a-pr><a-p>]</a-p>
<a-pr>duration</a-pr> <a-o>=</a-o> <a-s>&quot;30m&quot;</a-s>
<a-pr>mode</a-pr> <a-o>=</a-o> <a-s>&quot;center&quot;</a-s>
<a-pr>sorting</a-pr> <a-o>=</a-o> <a-s>&quot;ascending&quot;</a-s>

<a-p>[</a-p><a-pr>any</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/default_wallpaper.png&quot;</a-s>

<a-p>[</a-p><a-pr>DP-3</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/Wallpapers&quot;</a-s></pre>
<p>If you're running sway, you can look for the available outputs and their ID by running:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>swaymsg</a-pr> <a-co>-t</a-co> get_outputs</pre>
<p>On Hyprland you can run:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>hyprctl</a-pr> monitors</pre>
<h2>License</h2>
<p><strong>wpaperd</strong> is licensed under the <a href="/LICENSE.md">GPL-3.0+</a> license.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>wpaperd</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">![GitHub&#39;s release (latest by date)](https://img.shields.io/github/v/release/danyspin97/wpaperd?logo=github&amp;style=flat-square)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![GitHub license](https://img.shields.io/github/license/danyspin97/wpaperd?logo=github&amp;style=flat-square)](https://github.com/danyspin97/wpaperd/blob/main/LICENSE.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/danyspin97/wpaperd/cargo.yml?branch=main&amp;logo=github&amp;style=flat-square)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">**wpaperd** is the modern wallpaper daemon for Wayland. It dynamically changes the current wallpaper,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">either after a certain amount of time or via a command-line interface. It uses OpenGL ES to render</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">the images and have beautiful hardware-accelerated transitions, while being easy on resources.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">*Notice*: wpaperd uses wayland protocols available on all wlroots based compositors (sway,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">hyprland, ...) and on KDE. **Therefore it won&#39;t work on GNOME.**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>##</a-p> <a-tt>Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>- </a-p>Different wallpaper for each display</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>- </a-p>Pick a wallpaper from a directory</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>- </a-p>Change the wallpaper after a set time</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>- </a-p>Multiple sorting methods (random or ordered)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>- </a-p>Flexible TOML configuration file</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>- </a-p>Hot config reloading for all settings</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>- </a-p>Easy to use command line interface</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>- </a-p>Hardware-accelerated configurable transitions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>- </a-p>Multiple background modes (center, fit, fill)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>- </a-p>Easy on resources (low CPU and memory usage)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>## </a-p><a-tt>Getting started</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>### </a-p><a-tt>Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>*wpaperd* is written in Rust and requires a working Cargo installation. It also depends on:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>- `mesa`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>- `wayland-client`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>- `wayland-egl`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>- `rinstall` (optional for installing `wpaperd`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>### </a-p><a-tt>Build</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>To install `wpaperd`, clone the repository and build the project:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>$ </a-p><a-pr>git</a-pr><a-p> clone https://github.com/danyspin97/wpaperd</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>$ </a-p><a-pr>cd</a-pr><a-p> wpaperd</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>$ </a-p><a-pr>cargo</a-pr><a-p> build </a-p><a-co>--release</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>Generate the man pages by running `scdoc`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>$ </a-p><a-pr>scdoc</a-pr><a-p> </a-p><a-o>&lt;</a-o><a-p> man/wpaperd-output.5.scd </a-p><a-o>&gt;</a-o><a-p> man/wpaperd-output.5</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>### </a-p><a-tt>Install</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>You can install both the daemon (`wpaperd`) and cli (`wpaperctl`) using **rinstall**:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>$ </a-p><a-pr>rinstall</a-pr><a-p> </a-p><a-co>--yes</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>To run _wpaperd_, run the **daemon**:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>$ </a-p><a-pr>wpaperd</a-pr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>If you want to automatically run it at startup, add this line to your sway configuration</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>(located in `$HOME/.config/sway/config`):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p># Assuming it has been installed in ~/.local/bin/wpaperd</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>exec ~/.local/bin/wpaperd -d</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>Or in Hyprland:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>exec-once=~/.local/bin/wpaperd -d</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>## </a-p><a-tt>Image formats support</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>loading and dislaying images. Have a look on its</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>[documentation](https://github.com/image-rs/image/blob/main/README.md#supported-image-formats)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>for the supported formats.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>## </a-p><a-tt>Cycling images</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>When `path` is set to a directory, you can cycle the images by running the commands `next` and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>`previous` using _wpaperctl_:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>$ </a-p><a-pr>wpaperctl</a-pr><a-p> next</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>$ </a-p><a-pr>wpaperctl</a-pr><a-p> previous</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>When `sorting` is set to `asceding` and `desceding`, _wpaperd_ will use the wallpaper name to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>calculate the next wallpaper accordingly. When `sorting` is set to `random`, it will store</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>all the wallpapers shown in a queue, so that the commands `next` and `previous` can work</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>as intended.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>## </a-p><a-tt>Wallpaper Configuration</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>The configuration file for *wpaperd* is located in `XDG_CONFIG_HOME/wpaperd/config.toml`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>(which defaults to `~/.config/wpaperd/config.toml`). Each section</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>represents a different output and can contain the following keys:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>- `path`, path to the image to use as wallpaper or to a directory to pick the wallpaper from</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>- `duration`, how much time the image should be displayed until it is changed with a new one.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>  It supports a human format for declaring the duration (e.g. `30s` or `10m`), described</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>  [here](https://docs.rs/humantime/latest/humantime/fn.parse_duration.html).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>  This is only valid when path points to a directory. (_Optional_)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>- `sorting`, choose the sorting order. Valid options are `ascending`, `descending`, and `random`,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>  with the default being `random`. This is only valid when path points to a directory. (_Optional_)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>- `mode`, choose how to display the wallpaper when the size is different than the display</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>  resolution:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>  - `fit` shows the entire image with black corners covering the empty space left</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>  - `center` centers the image on the screen, leaving out the corners of the image that couldn&#39;t fit</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>  - `stretch` shows the entire image stretching it to fit the entire screen without leaving any</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>    black corner, changing the aspect ratio</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>  - `tile` shows the image multiple times horizontally and vertically to fill the screen</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>- `transition_time`, how many milliseconds should the transition run. (_Optional_, `300` by default).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>- `queue_size`, decide how big the queue should be when `path` is set a directory and `sorting` is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>   set to `random`. (_Optional_, `10` by default)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>The section `default` will be used as base for the all the display configuration; the section</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>`any` will be used for all the displays that are not explictly listed. This allows to have a</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>flexible configuration without repeating any settings. _wpaperd_ will check the configuration at</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>startup and each time it changes and provide help when it is incorrect.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>This is the simplest configuration:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>[</a-p><a-pr>DP-3</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/github_octupus.png&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>[</a-p><a-pr>DP-4</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/Wallpapers&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>duration </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;30m&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>This is a more complex configuration:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>[</a-p><a-pr>default</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>duration </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;30m&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>mode </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;center&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>sorting </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;ascending&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>[</a-p><a-pr>any</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/default_wallpaper.png&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>[</a-p><a-pr>DP-3</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/Wallpapers&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"><a-p>If you&#39;re running sway, you can look for the available outputs and their ID by running:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>$ </a-p><a-pr>swaymsg</a-pr><a-p> </a-p><a-co>-t</a-co><a-p> get_outputs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>On Hyprland you can run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>$ </a-p><a-pr>hyprctl</a-pr><a-p> monitors</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>## </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>**wpaperd** is licensed under the [GPL-3.0+](/LICENSE.md) license.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-tu>[swaybg]</a-tu><a-p>: </a-p><a-tu>https://github.com/swaywm/swaybg</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
