https://github.com/donovanglover/thud
Generate directory thumbnails for GTK-based file browsers from images inside them.
https://github.com/donovanglover/thud
cover cover-art nautilus rust thumbnail-generator thumbnailer thunar
Last synced: 7 months ago
JSON representation
Generate directory thumbnails for GTK-based file browsers from images inside them.
- Host: GitHub
- URL: https://github.com/donovanglover/thud
- Owner: donovanglover
- License: mit
- Created: 2022-05-27T02:45:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T11:57:43.000Z (8 months ago)
- Last Synced: 2025-03-10T12:51:14.097Z (8 months ago)
- Topics: cover, cover-art, nautilus, rust, thumbnail-generator, thumbnailer, thunar
- Language: Rust
- Homepage: https://donovan.is/thud
- Size: 1.18 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# thud
*thud*, short for **thu**mbnail **d**irectory, is a tool that lets you generate directory thumbnails from images inside them. Useful for a [Dolphin](https://apps.kde.org/dolphin/)/[KDE](https://kde.org/)-like experience with [GTK](https://www.gtk.org/)-based [file](https://apps.gnome.org/Nautilus/) [browsers](https://docs.xfce.org/xfce/thunar/start) that don't show the contents of directories by default.
thud can be customized with *rules* and *strategies* that reside in [`~/.config/thud/config.toml`](./examples/config.toml). By default, it creates thumbnails from `cover.{png,jpg}` files.
Tested and works in: [Caja](https://github.com/mate-desktop/caja), [Nemo](https://github.com/linuxmint/nemo), [Thunar](https://github.com/xfce-mirror/thunar), [Nautilus](https://github.com/GNOME/nautilus).
## Installation
### [NixOS](https://wiki.nixos.org/wiki/Overview_of_the_NixOS_Linux_distribution) (Recommended)
Add [`thud`](https://search.nixos.org/packages?channel=unstable&query=thud) to your `systemPackages` and rebuild.
```nix
{ pkgs, ... }:
{
environment.systemPackages = with pkgs; [
thud
];
}
```
### [Arch Linux](https://archlinux.org/)
I don't use Arch Linux anymore, but I wrote a PKGBUILD for the `pacman` enjoyers out there. Feel free to add it to the AUR.
```fish
git clone https://github.com/donovanglover/thud -b 0.3.1 && cd thud && makepkg -si
```
### Other distributions
```fish
git clone https://github.com/donovanglover/thud && cd thud
cargo build --release
sudo install -Dm755 ./target/release/thud /usr/bin/thud
sudo install -Dm644 ./assets/thud.thumbnailer /usr/share/thumbnailers/thud.thumbnailer
```
## Usage
```man
Usage: thud [OPTIONS]
Arguments:
Directory to thumbnail
Where to save the output image
Options:
-s, --size Thumbnail size [default: 128]
-v, --verbose Print what thud is doing
-h, --help Print help (see more with '--help')
-V, --version Print version
```
By default, directories with `cover.jpg` or `cover.png` will automatically generate cover images. You can customize this with [`~/.config/thud/config.toml`](./examples/config.toml).
## Contributing
Creating your own strategy for thud is easy for both new and experienced Rustaceans. Here are the steps:
1. First add a new function to [`./src/strategy.rs`](./src/strategy.rs)
2. Next add your strategy to `match rule.strategy.as_str()` in [`./src/main.rs`](./src/main.rs)
3. Finally, make a pull request to let anyone be able to use your thumbnailing strategy.
That's it! The possibilities are endless when it comes to how you want your directory thumbnails to look.