DOCS: moved thumbnailer docs into docs/ folder

master
Martin Gerhardy 2020-06-29 20:47:24 +02:00
parent 49aaf1d2bc
commit 5af4bcac91
3 changed files with 23 additions and 16 deletions

20
docs/thumbnailer/Index.md Normal file
View File

@ -0,0 +1,20 @@
# General
Create thumbnailer images of all supported voxel formats. In combination with a mimetype definition and a `.thumbnailer` defintiion file
that must be installed in `/usr/share/mime/packages` and `/usr/share/thumbnailer` this will e.g. create small preview images for
`vox`, `qb`, `qbt`, `vxm`, `cub`, ... files.
It works for any file manager that supports `.thumbnailer` entries, including Nautilus, Thunar (when tumbler is installed), Nemo, Caja,
and PCManFM.
# Example
This allows you to create the thumbnails manually.
```bash
for i in $(find $HOME/dev/engine -name "*.vox" -or -name "*.cub" -or -name "*.qbt" -or -name "*.qb" -or -name "*.vxm"); do
fullpath=$(readlink -f $i)
md5=$(echo -n "file://$fullpath" | md5sum -z | awk ' { print $1.".png" }')
vengi-thumbnailer -s 128 $i $HOME/.cache/thumbnails/large/$md5
done
```

View File

@ -28,5 +28,7 @@ nav:
- VoxConvert:
- voxconvert/Index.md
- voxconvert/Usage.md
- Thumbnailer:
- thumbnailer/Index.md
- Game Design:
- GameDesign.md

View File

@ -1,18 +1,3 @@
# Thumbnailer
## Purpose
Create thumbnailer images of all supported voxel formats. In combination with a mimetype definition and a `.thumbnailer` defintiion file
that must be installed in `/usr/share/mime/packages` and `/usr/share/thumbnailer` this will e.g. create small preview images for
`vox`, `qb`, `qbt`, `vxm`, `cub`, ... files.
It works for any file manager that supports `.thumbnailer` entries, including Nautilus, Thunar (when tumbler is installed), Nemo, Caja,
and PCManFM.
```bash
for i in $(find $HOME/dev/engine -name "*.vox" -or -name "*.cub" -or -name "*.qbt" -or -name "*.qb" -or -name "*.vxm"); do
fullpath=$(readlink -f $i)
md5=$(echo -n "file://$fullpath" | md5sum -z | awk ' { print $1.".png" }')
vengi-thumbnailer -s 128 $i $HOME/.cache/thumbnails/large/$md5
done
```
[more details](../../../docs/thumbnailer/)