<!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 @ 0.3.0</title>
<meta name="description" content="README.md in fork/wpaperd at 0.3.0.">
<meta property="og:title" content="README.md - fork/wpaperd @ 0.3.0">
<meta property="og:description" content="README.md in fork/wpaperd at 0.3.0.">
<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="0.3.0" data-tip="a99e4e3d8c05a933a3f428329c2883e635feca14">
<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="a76fb565cf6193e54022c17bb96160481a8a679e">Rename output.conf to wallpaper.toml</span><span class="snapshot-sha sha" data-commit="a76fb565cf6193e54022c17bb96160481a8a679e">a76fb56</span><time datetime="2023-04-07T12:30:10+02:00" title="2023-04-07 12:30:10 +0200">2023-04-07</time></p>
<header class="topbar"><details class="switcher"><summary>0.3.0</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 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 class="current" 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>4.1 KiB</span><span>138 lines</span></span><span class="actions"><a class="raw" href="/fork/wpaperd/raw/e41e0571163190d31a0e44186f82f7ab27f666d7/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 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" alt="GitHub license" /></a>
<img src="https://img.shields.io/github/workflow/status/danyspin97/wpaperd/Continuous%20integration?logo=github&amp;style=flat-square" alt="GitHub Workflow Status" /></p>
<p><strong>wpaperd</strong> is a minimal wallpaper daemon for Wayland. It allows the user to choose a different
image for each output (aka for each monitor) just as <em><a href="https://github.com/swaywm/swaybg">swaybg</a></em>. Moreover, a directory can be
chosen and <em>wpaperd</em> will randomly choose an image from it. Optionally, the user can set a
duration, after which the image displayed will be changed with another random one.</p>
<h2>Features</h2>
<ul>
<li>Choose your wallpaper for each input</li>
<li>Randomly choose an image from a directory</li>
<li>Change the random image after a set duration</li>
<li>Configurable via a TOML configuration file</li>
<li>Reload config at runtime and apply new settings</li>
<li>(optional) Apply a shadow on the top of the wallpaper</li>
</ul>
<h2>Getting started</h2>
<h3>Dependencies</h3>
<p><em>wpaperd</em> is written entirely in Rust and, other than the crates it depends
on, it has the following dependencies:</p>
<ul>
<li><code>pkg-config</code> (<em>build-time</em>)</li>
<li><code>libxkbcommon</code></li>
</ul>
<p>It does not depend on <code>wayland-client</code> C library, but it instead uses a Rust
implementation.</p>
<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>
<h3>Install</h3>
<p>You can install wpaperd using cargo:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> install <a-co>--path=</a-co><a-s>&quot;.&quot;</a-s></pre>
<p>Otherwise you can install it using rinstall:</p>
<pre class="language-bash"><a-c># First generate the man page</a-c>
<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
<a-o>$</a-o><a-f> </a-f><a-pr>rinstall</a-pr> <a-co>-y</a-co></pre>
<p>To run it, execute the <code>wpaperd</code> program:</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>) depending on your installation method:</p>
<pre># For installation using cargo
exec ~/.cargo/bin/wpaperd
# For installation using rinstall
exec ~/.local/bin/wpaperd
</pre>
<h2>Images format support</h2>
<p><em>wpaperd</em> relies on the <code>image</code> crate for loading and dislaying images. By default it
supports for the following formats:</p>
<ul>
<li><code>jpeg</code></li>
<li><code>png</code></li>
<li><code>webp</code></li>
</ul>
<p>Optionally, support for <code>avif</code> images can be enabled by adding its respective feature:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> build <a-co>--release</a-co> <a-co>--features</a-co> avif</pre>
<h2>Wallpaper Configuration</h2>
<p>The wallpaper configuration file for <em>wpaperd</em> is located in <code>XDG_CONFIG_HOME/wpaperd/wallpaper.toml</code>
(which defaults to <code>$HOME/.config/wpaperd/wallpaper.toml</code>) and is a TOML file. Each section
represents a different output and contains the following keys:</p>
<ul>
<li><code>path</code>, path to the image/directory</li>
<li><code>duration</code>, how much time the image should be displayed until it is changed with a new one.
This is only valid when path points to a directory. (<em>Optional</em>)</li>
<li><code>apply-shadow</code>, apply a shadow on the top part of the image, to work as a shadow effect
of the status bar. This is particularly suited for window managers like sway. (<em>Optional</em>)</li>
</ul>
<p>The section <code>default</code> will be used as fallback for the all the outputs that aren't listed in
the config file. This is an example configuration:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>default</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/Pictures/Wallpapers/&quot;</a-s>
<a-pr>duration</a-pr> <a-o>=</a-o> <a-s>&quot;30m&quot;</a-s>

<a-p>[</a-p><a-pr>eDP-1</a-pr><a-p>]</a-p>
<a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;/home/danyspin97/Pictures/Wallpapers/github_octupus.png&quot;</a-s>
<a-pr>apply-shadow</a-pr> <a-o>=</a-o> <a-co>true</a-co></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>Every time you update the configuration while the program is running, the changes will
be applied automatically.</p>
<h2>TODO</h2>
<p><strong>wpaperd</strong> is still a work in progress. The next things to do, in order, are:</p>
<ul>
<li><input disabled="" type="checkbox"/>
Configurable upscaling algorithm, right now Lanzcos3 is always used</li>
<li><input disabled="" type="checkbox"/>
Add different modes to apply the wallpaper, i.e. <code>center</code>, <code>fit</code>, <code>original</code></li>
<li><input disabled="" type="checkbox"/>
Add IPC and a client to control wpaperd</li>
<li><input disabled="" type="checkbox"/>
Update smithay-client-toolkit to next version (still unreleased)</li>
</ul>
<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 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)](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/workflow/status/danyspin97/wpaperd/Continuous%20integration?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 a minimal wallpaper daemon for Wayland. It allows the user to choose a different</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">image for each output (aka for each monitor) just as *[swaybg]*. Moreover, a directory can be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">chosen and *wpaperd* will randomly choose an image from it. Optionally, the user can set a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">duration, after which the image displayed will be changed with another random one.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</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="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>Choose your wallpaper for each input</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>- </a-p>Randomly choose an image from a directory</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>Change the random image after a set duration</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>Configurable via a TOML configuration file</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>Reload config at runtime and apply new settings</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>(optional) Apply a shadow on the top of the wallpaper</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></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><a-tt>Getting started</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></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><a-tt>Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></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>*wpaperd* is written entirely in Rust and, other than the crates it depends</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>on, it has the following dependencies:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>- `pkg-config` (_build-time_)</a-p></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>- `libxkbcommon`</a-p></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>It does not depend on `wayland-client` C library, but it instead uses a Rust</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"><a-p>implementation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></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>### </a-p><a-tt>Build</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></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>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="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-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</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="L40" href="#L40">40</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="L41" href="#L41">41</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="L42" href="#L42">42</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></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-tt>Install</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></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>You can install wpaperd using cargo:</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>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>$ </a-p><a-pr>cargo</a-pr><a-p> install </a-p><a-co>--path=</a-co><a-s>&quot;.&quot;</a-s></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></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>Otherwise you can install it using rinstall:</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-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p># First generate the man page</a-p></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>$ </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="L57" href="#L57">57</a><span class="code-text"><a-p>$ </a-p><a-pr>rinstall</a-pr><a-p> </a-p><a-co>-y</a-co></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>To run it, execute the `wpaperd` program:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</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="L63" href="#L63">63</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="L64" href="#L64">64</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</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="L67" href="#L67">67</a><span class="code-text"><a-p>(located in `$HOME/.config/sway/config`) depending on your installation method:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>```</a-p></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># For installation using cargo</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>exec ~/.cargo/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># For installation using rinstall</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>exec ~/.local/bin/wpaperd</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>## </a-p><a-tt>Images format support</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></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>*wpaperd* relies on the `image` crate for loading and dislaying images. By default it</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>supports for the following formats:</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>- `jpeg`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>- `png`</a-p></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>- `webp`</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"></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>Optionally, support for `avif` images can be enabled by adding its respective feature:</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-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>$ </a-p><a-pr>cargo</a-pr><a-p> build </a-p><a-co>--release</a-co><a-p> </a-p><a-co>--features</a-co><a-p> avif</a-p></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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</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="L92" href="#L92">92</a><span class="code-text"></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>The wallpaper configuration file for *wpaperd* is located in `XDG_CONFIG_HOME/wpaperd/wallpaper.toml`</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>(which defaults to `$HOME/.config/wpaperd/wallpaper.toml`) and is a TOML file. Each section</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>represents a different output and contains the following keys:</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>- `path`, path to the image/directory</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>- `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="L99" href="#L99">99</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="L100" href="#L100">100</a><span class="code-text"><a-p>- `apply-shadow`, apply a shadow on the top part of the image, to work as a shadow effect</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"><a-p>  of the status bar. This is particularly suited for window managers like sway. (_Optional_)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>The section `default` will be used as fallback for the all the outputs that aren&#39;t listed in</a-p></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 config file. This is an example configuration:</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"></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>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</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="L108" href="#L108">108</a><span class="code-text"><a-p>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/Pictures/Wallpapers/&quot;</a-s></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 </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="L110" href="#L110">110</a><span class="code-text"></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>[</a-p><a-pr>eDP-1</a-pr><a-p>]</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>path </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;/home/danyspin97/Pictures/Wallpapers/github_octupus.png&quot;</a-s></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>apply-shadow </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></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>```</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"></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>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="L117" href="#L117">117</a><span class="code-text"></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>```</a-p><a-tl>bash</a-tl></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>$ </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="L120" href="#L120">120</a><span class="code-text"><a-p>```</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"></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>Every time you update the configuration while the program is running, the changes will</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>be applied automatically.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>## </a-p><a-tt>TODO</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></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>**wpaperd** is still a work in progress. The next things to do, in order, are:</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"></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>- [ ] Configurable upscaling algorithm, right now Lanzcos3 is always used</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"><a-p>- [ ] Add different modes to apply the wallpaper, i.e. `center`, `fit`, `original`</a-p></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>- [ ] Add IPC and a client to control wpaperd</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"><a-p>- [ ] Update smithay-client-toolkit to next version (still unreleased)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"></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-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</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="L137" href="#L137">137</a><span class="code-text"></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-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>
