Skip to content

A wallpaper setup script for hyprpaper with wallhaven

License

Notifications You must be signed in to change notification settings

vivalchemy/hyprhaven

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

Hyprhaven - Wallpaper Setup Script

Overview

Hyprhaven is a Bash script designed to simplify the process of setting up wallpapers on your Linux system. It leverages the Wallhaven API to fetch and download wallpapers based on user-defined criteria. Whether you want a random wallpaper or have specific preferences, Hyprhaven has got you covered.

Features

  • Fetch and download wallpapers from Wallhaven API.
  • Set random wallpapers from a local directory.
  • Configure wallpaper parameters such as categories, purity, and search queries.
  • Set a specific wallpaper using the file path.
  • Automatically set wallpapers using the Hyprpaper wallpaper manager.

Prerequisites

  • Bash (Unix shell)
  • Hyprpaper - Wallpaper manager
  • Wallhaven API key (optional, for accessing NSFW images)

Getting Started

  1. Clone the repository:
git clone https://github.com/your-username/hyprhaven.git
cd hyprhaven
  1. Make the script executable:
chmod +x hyprhaven.sh
  1. Run the script with appropriate options:
./hyprhaven.sh -r   # Set a random wallpaper
./hyprhaven.sh -d   # Fetch and download wallpapers from Wallhaven
./hyprhaven.sh -c "general, anime" -p "sfw" -q "landscape"  # Customize wallpaper search

Enjoy your personalized wallpapers!

Options

Option Description
-r Set a random wallpaper from the local directory.
-d Fetch and download wallpapers from Wallhaven based on specified criteria.
-c CATEGORY Specify wallpaper categories (e.g., "general, anime").
-p PURITY Specify wallpaper purity (e.g., "sfw, nsfw").
-q QUERY Specify a search query for wallpapers.
-s FILE_PATH Set a specific wallpaper using the provided file path.

Configuration

Edit the script to set your Wallhaven API key (API_KEY variable). Adjust other constants such as WALLPAPER_DIR, MIN_RES, and PERMITTED_RATIO as needed.

License

This project is licensed under the MIT License.

Acknowledgments

Hyprhaven is inspired by the Hyprwm project.

Contributing

Contributions are welcome!

Contact

For any inquiries or issues, please open an issue.

About

A wallpaper setup script for hyprpaper with wallhaven

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages