PAPERVIEW-RS

Paperview rewrite in rust with compositor support

Table of Contents

• Prerequisites
• Quick Start
  • Installation
  • Single Monitor Use
  • Multi Monitor Use
  • Running as a Background Process
  • Custom Scenes
• License

Prerequisites

• ImLib2.h
• LibXrandr
• Clang
• Cargo

Quick Start

Installation

Clone the repository:

    git clone https://github.com/eatmynerds/paperview-rs.git
    cd paperview-rs
    cargo build --release
    mv target/release/paperview-rs .

Single Monitor Use

paperview-rs can handle a single monitor like so:

    ./paperview-rs --bg "<monitor width>:<monitor height>:<monitor x offset>:<monitor y offset>:<bitmap-directory>:<fps>"

Multi Monitor Use

paperview-rs can handle any number of monitors. Each monitor will render wallpapers independently.

    ./paperview-rs --bg "<monitor width>:<monitor height>:<monitor x offset>:<monitor y offset>:<bitmap-directory>:<fps>" --bg "<monitor width>:<monitor height>:<montior x offset>:<monitor y offset>:<bitmap-directory>:<fps>"

TUI

If you're just not really a big fan of the command line, fear not! paperview-rs has a built-in TUI. You can use it like so:

    ./paperview-rs --tui

Running as a Background Process

Run paperview-rs in the backgrond using &:

    ./paperview-rs --bg "<montior width>:<monitor height>:<monitor x offset>:<monitor y offset>:<bitmap-directory>:<fps>" &

To terminate the background process:

    killall paperview-rs

Creating Custom Scenes

Creating a custom BMP scene folder from a GIF requires imagemagick. For example, to create a castle scene folder from a castle.gif:

./convert.sh castle.gif castle-bmp

Random Animated Wallpapers at Startup

Assuming a scenes folder containing a number of scene folders is present in the home folder, run the following snippet as a background process within .xinitrc before running startx, or simply execute it after X11 is running:

#!/bin/sh

while true; do
    scene=$(ls -d ~/scenes/* | shuf -n 1)

    timeout 600 ./paperview-rs --bg "1920:1080:0:0:${scene}:60"
done

TODO

• X11 support
• Wayland Support

License

Licensed under MIT.