Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goggle/wallsort
A command line utility to sort images according to image dimension properties.
https://github.com/goggle/wallsort
Last synced: 1 day ago
JSON representation
A command line utility to sort images according to image dimension properties.
- Host: GitHub
- URL: https://github.com/goggle/wallsort
- Owner: goggle
- License: gpl-3.0
- Created: 2016-11-21T10:50:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-27T12:37:33.000Z (about 8 years ago)
- Last Synced: 2024-06-20T14:23:39.366Z (6 months ago)
- Language: Go
- Size: 4.22 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wallsort
Wallsort is a command line utility to sort images (mostly intended to sort wallpapers)
according to user defined rules.
If you have a directory which contains all your wallpapers, you might want to
sort them into subdirectories according to their sizes. Wallsort will do this
for you. It currently supports JPEG and PNG images.
## Installation
Run this to install wallsort:
```
go get -u github.com/goggle/wallsort
```
You should now have a executable file called `wallsort` in your `$GOPATH/bin` directory.
## Configuration
Wallsort uses a [TOML] (https://github.com/toml-lang/toml) configuration file called
`config.toml`. It can be stored in the directory `$HOME/.config/wallsort`,
`$HOME/.wallsort` or the directory, where the executable is stored.
When wallsort is executed for the first time, it can automatically create a
default configuration file. It will look like this:
```
directory = "/home/user/Pictures/wallpapers"
[[category]]
name = "1080p"
width = 1920
min_height = 1080
max_height = 1200
[[category]]
name = "1440p"
width = 2560
min_height = 1440
max_height = 1600
[[category]]
name = "QHDplus"
height = 1800
width = 3200
[[category]]
name = "UHD"
height = 2160
width = 3840
[[category]]
name = "lowres"
max_height = 1080
max_width = 1920
max_pixels = 2073599
[[category]]
name = "highres"
min_height = 2160
min_width = 3840
min_pixels = 8294401
[[category]]
name = "others"
```
The configuration file needs to have an entry ```directory = "/path/to/wallpapers"```.
This sets the base image directory.
You can now set rules to sort your images by defining a ```[[category]]``` section.
Valid fields in a ```[[category]]``` section are:
* ```name```: Defines a name for this category (e.g. ```name = "1920x1080"```).
* ```height```: Defines the image height in pixels (e.g. ```height = 1080```).
* ```width```: Defines the image width in pixels (e.g. ```width = 1920```).
* ```heights```: Defines a list of possible image height values (e.g. ```heights = [1080, 1440, 1800]```)
* ```widhts```: Defines a list of possible image width values.
* ```min_height```: Defines the minimum height of the image (e.g. ```min_height = 1080``` matches all the images, which have a height greater or equal 1080).
* ```max_height```: Defines the maximum height of the image.
* ```min_width```: Defines the minimum width of the image.
* ```max_width```: Defines the maximum widht of the image.
* ```min_pixels```: Defines the minimum amount of pixels in the image (e.g. ```min_pixels = 10000``` matches all the images, which have 10000 or more pixels).
* ```max_pixels```: Defines the maximum amount of pixels in the image.
Note: First defined categories have higher precedence. So if an image satisfies the rules
for the categories ```1080p``` and ```others```, it will be moved into the subdirectory
```1080p```, because it was defined first.
## Usage
Just run
```
wallsort
```
to sort all the images in the image base directory defined in ```config.toml```.
It will create subdirectories if necessary and move the matching images into them.