🐧 Linux Wallpaper Engine GUI

A graphical user interface for managing wallpapers on Linux, powered by Electron, Svelte, and linux-wallpaperengine.

📸 Screenshots

Main Window

Settings Window

✨ Features

• 🖼️ Wallpaper Management: Browse and select wallpapers from your Steam Workshop content.
• 💾 Auto-Save & Auto-Run: Automatically saves the last used wallpaper and applies it on application startup.
• 🔇 Mute Audio: A setting to mute the wallpaper's audio.
• ⚙️ Customizable Settings: Configure screen and FPS settings for the wallpaper.
• 🔍 Wallpaper Details: View detailed information about each wallpaper, including title, description, tags, and workshop URL.
• 🖥️ System Tray Integration: Minimize the application to the system tray for background operation.

📋 Prerequisites

Before you begin, ensure you have the following installed:

• 🐧 linux-wallpaperengine: The command-line tool that this GUI interacts with. You can usually find this in your distribution's repositories or compile it from source.

🚀 Installation

You have two main options to get the Linux Wallpaper Engine GUI:

Option 1: Install on Arch Linux 🐧

This method is for users of Arch Linux or Arch-based distributions.

1. Create a temporary directory and download the PKGBUILD:

   mkdir -p ~/linux-wallpaperengine-gui-build
   cd ~/linux-wallpaperengine-gui-build
   curl -O https://raw.githubusercontent.com/AzPepoze/linux-wallpaperengine-gui/main/installer/PKGBUILD
   

2. Build and install the package:

   makepkg -si
   

   This command will automatically handle dependencies, build the package, and install it on your system.
3. Clean up the temporary directory:

   cd ~ && rm -rf ~/linux-wallpaperengine-gui-build
   

4. Remove pnpm (if you don't use it)

   sudo pacman -R pnpm
   

Option 2: Download from Releases 📦

You can download pre-built packages for various Linux distributions directly from the GitHub Releases page.

1. Download the latest release.

   • Go to the Latest Release Page Download the appropriate file for your system (.AppImage, .deb, .rpm, or .snap).
   • Click on the link for your desired package type to download it directly.
     • Click here to download .AppImage file
     • Click here to download .deb file
     • Click here to download .rpm file
     • Click here to download .snap file

2. Install it using your system's package manager. For example:

   • For .AppImage:

     chmod +x linux-wallpaperengine-gui.AppImage
     ./linux-wallpaperengine-gui.AppImage
     

   • For .deb (Debian, Ubuntu):

     sudo dpkg -i linux-wallpaperengine-gui.deb
     

   • For .rpm (Fedora, CentOS):

     sudo rpm -i linux-wallpaperengine-gui.rpm
     

   • For .snap:

     sudo snap install linux-wallpaperengine-gui.snap --dangerous
     

     (The --dangerous flag is needed because the snap is not from the official Snap Store.)

▶️ Usage

Once installed, you can run the application in two ways:

• Normal Mode: Simply execute the application file. This will open the main window.

  linux-wallpaperengine-gui
  

• Minimized Mode: Run the application with the --minimized flag to start it directly in the system tray without showing the main window.

  linux-wallpaperengine-gui --minimized
  

📖 How to Use the GUI

• 🖱️ Selecting a Wallpaper: Click on any wallpaper in the grid to set it as your current wallpaper. The application will automatically save your selection.
• ⚙️ Settings: Click on the "Settings" button to open the settings panel. Here you can:
  • 🖥️ Adjust the SCREEN (e.g., DP-1, HDMI-A-1) where the wallpaper will be displayed.
  • ⚡ Set the FPS (frames per second) for the wallpaper.
  • 🔇 Toggle "Mute Wallpaper Audio" to mute the audio of the wallpaper.
• ➡️ Sidebar: When a wallpaper is selected, a sidebar will appear on the right, showing detailed information about the wallpaper.
• 🔽 System Tray: The application minimizes to the system tray when closed, allowing it to run in the background. You can right-click the tray icon to quit the application.

💻 Development

For those who want to contribute or build the application from source.

Build from Source 🛠️

• Prerequisites: Ensure you have Node.js and pnpm installed.

1. Clone the repository:

   git clone https://github.com/AzPepoze/linux-wallpaperengine-gui.git
   cd linux-wallpaperengine-gui
   

2. Install dependencies:

   pnpm install
   

3. Build and Unpack:

   pnpm build:unpack
   

   This will create an unpacked application in the dist/linux-unpacked directory.
4. Run the Unpacked Application:

   ./dist/linux-unpacked/linux-wallpaperengine-gui
   

Development Mode

To run the application with hot-reloading for development:

pnpm dev

Production Build

To build the application for production (creating executables):

pnpm build

This will create distributable files in the dist directory.

🤝 Contributing

Feel free to contribute to this project by opening issues or submitting pull requests.