go-wallpaper

README

go-wallpaper

go-wallpaper is a cli tool for setting random wallpapers for Windows. It is built with Golang and inspired by styli.sh

How it works

Features

• It can set wallpapers from Unsplash, subreddits like /r/wallpaper, /r/wallpapers
• go-wallpaper.exe help for help

How to install

• If you already have Golang installed, you can clone this repo and run the following commands
  • go mod tidy to install dependencies
  • go install to add the binary to your gopath
  • make sure the bin directory of your gopath is in your system path
• Or you can download the pre-built binaries from releases sections and add it to your path (or somewhere you can use it from terminal, cmd, powershell etc...)

How to use

# set a random background from unsplash
# the default resolution is 1920x1080
> go-wallpaper.exe

# provide resolution with -r or --resolution flag
> go-wallpaper.exe -r 2560x1440

# random background from unsplash with a search term/tag
# -t <tag> or --tag <tag>, multiple tags should be separated
> go-wallpaper.exe -t sunset
> go-wallpaper.exe -t "sunset,beach"

# set a random background from one of these subreddits "EarthPorn", "wallpaper", "wallpapers", "multiwall"
# resolution, tag flags won't have any effect here
> go-wallpaper.exe reddit

# sort reddit wallpapers by new, hot, top with -s or --sort flag
> go-wallpaper.exe reddit -s new

Features to come

• Set wallpapers from subreddits like r/wallpapers etc...
• Set wallpapers from NASA image library NASA Images, NASA API Docs
• Wallpapers from different sections of subreddit like hot, new, top etc...
• Sort subreddit wallpapers from the top section by year, month, week etc...
• Flags for custom subreddit
• Flags for selecting wallpapers from a specific unsplash collection
• Flags for saving the wallpapers permanently with a different name
• Writing tests and maybe publish it as package for others to use

Contribution

the project is a mess currently 😓, I will clean it, and make it easy for contribution, so until then I can not accept any contributions

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.