wallpaper

README

---

Differences from original repo

• Fixed feh flag
• ...

---

Wallpaper

A cross-platform (Linux, Windows, and macOS) Golang library for getting and setting the desktop background.

Installation

go get github.com/ktkv419/wallpaper

Example

package main

import (
	"fmt"

	"github.com/reujab/wallpaper"
)

func main() {
	background, err := wallpaper.Get()
	check(err)
	fmt.Println("Current wallpaper:", background)

	err = wallpaper.SetFromFile("/usr/share/backgrounds/gnome/adwaita-day.jpg")
	check(err)

	err = wallpaper.SetFromURL("https://i.imgur.com/pIwrYeM.jpg")
	check(err)

	err = wallpaper.SetMode(wallpaper.Crop)
	check(err)
}

Supported desktops

• Windows
• macOS
• GNOME
• KDE
• Cinnamon
• Unity
• Budgie
• XFCE
• LXDE
• MATE
• Deepin
• Most Wayland compositors (set only, requires swaybg)
• i3 (set only, requires feh)

Documentation

Index

• Variables
• func Get() (string, error)
• func SetFromFile(filename string) error
• func SetFromURL(url string) error
• func SetMode(mode Mode) error
• type Mode

Variables

var Desktop = os.Getenv("XDG_CURRENT_DESKTOP")

Desktop contains the current desktop environment on Linux. Empty string on all other operating systems.

var DesktopSession = os.Getenv("DESKTOP_SESSION")

DesktopSession is used by LXDE on Linux.

var ErrUnsupportedDE = errors.New("your desktop environment is not supported")

ErrUnsupportedDE is thrown when Desktop is not a supported desktop environment.

Functions

func Get

func Get() (string, error)

Get returns the current wallpaper.

func SetFromFile

func SetFromFile(filename string) error

SetFromFile sets the wallpaper for the current user.

func SetFromURL

func SetFromURL(url string) error

SetFromURL downloads the image to a cache directory and calls SetFromFile.

func SetMode

func SetMode(mode Mode) error

SetMode sets the wallpaper mode.

Types

type Mode

type Mode int

const (
	Center Mode = iota
	Crop
	Fit
	Span
	Stretch
	Tile
)