mirror/didder
1
0
Fork 0
mirror of https://github.com/makew0rld/didder.git synced 2025-09-09 18:10:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from Shrinks99/patch-1

Browse Source
This commit is contained in:
makeworld
2021-04-30 22:42:35 -04:00
committed by GitHub
parent f5c56c9521 25717f541b
commit b4bbf68691
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
didder.1.md
View File

@@ -7,7 +7,7 @@ date: DATE
---
# NAME
didder - dither images
didder — dither images
# SYNOPSIS
**didder** \[global options] command [command options] [arguments...]
@@ -15,9 +15,9 @@ didder - dither images
# DESCRIPTION
Dither images with a variety of algorithms and processing options.
Mandatory global flags are **\--palette**, **\--in**, and **\--out**, all others are optional. Each command represents a dithering algorithm or set of algorithms to apply to the input image(s).
Mandatory global flags are **\--palette**, **\--in**, and **\--out**, all others are optional. Each command applies a dithering algorithm or set of algorithms to the input image(s).
The most important section in this manual is the **TIPS** one. Make sure you check it out.
The most important parts of this manual are highlighted in the **TIPS** section, make sure you check it out!
Homepage: <https://github.com/makeworld-the-better-one/didder>
@@ -88,7 +88,7 @@ Homepage: <https://github.com/makeworld-the-better-one/didder>
: Set frames per second for animated GIF output. Note that not all FPS values can be represented by the GIF format, and so the closest possible one will be chosen. This flag has no default, and is required when animated GIFs are being outputted. This flag is ignored for non animated GIF output.
**-l**, **\--loop** *NUM*
: Set the number of times animated GIF output should loop. 0 is the default, and means infinite looping.
: Set the number of times animated GIF output should loop. 0 is the default, and will loop infinitely.
**-x**, **\--width** *NUM*
: Set the width the input image(s) will be resized to, before dithering. Aspect ratio will be maintained if **\--height** is not specified as well.
@@ -201,24 +201,22 @@ Read about **\--recolor** if you haven't already.
It's easy to mess up a dithered image by scaling it manually. It's best to scale the image to the size you want before dithering (externally, or with **\--width** and/or **\--height**), and then leave it.
If you need to scale it up afterward, use **\--upscale**, rather than another tool. This will prevent image artifacts or blurring.
If you need to scale it up afterward, use **\--upscale**, rather than another tool. This will prevent image artifacts and blurring.
Be wary of environments where you can't make sure an image will be displayed at 100% size, pixel for pixel. Make sure nearest-neighbor scaling is being used at least.
Be wary of environments where you can't make sure an image will be displayed at 100% size, pixel for pixel. Make sure to at least use nearest-neighbor scaling, do your best to preserve sharp pixel edges.
Dithered images must only be encoded in a lossless image format. This is why the tool only outputs PNG or GIF.
Dithered images must only be encoded in a lossless image format. This is why the tool only outputs PNG and GIF.
To increase the dithering artifacts for aesthetic effect, you can downscale the image before dithering and upscale after. Like if the image is 1000 pixels tall, your command can look like **didder --height 500 --upscale 2 [...]**. Depending on the input image size and what final size you want, you can of course just upscale as well.
If your palette (original or recolor) is low-spread, meaning it doesn't span much of the available shades of a single hue or the entire RGB space, you can use flags like **\--brightness**, **\--contrast**, and **\--saturation** to improve the way dithered images turn out. For example, if your palette is dark, you can turn up the brightness.
If your palette (original or recolor) is low-spread — meaning it doesn't span much of the available shades of a single hue or the entire RGB space — you can use flags like **\--brightness**, **\--contrast**, and **\--saturation** to improve the way dithered images turn out. For example, if your palette is dark, you can turn up the brightness. As mentioned above, these flags apply their transformations to the original image and will not adjust your selected palette colors.
# EXAMPLES
**didder --palette 'black white' -i input.jpg -o test.png bayer 16x16**
: This command dithers `input.jpg` to just use black and white (implicitly converting to grayscale first), using a 16x16 Bayer matrix. The result is written to `test.png`.
TODO
: This command dithers `input.jpg` using only black and white (implicitly converting to grayscale first), using a 16x16 Bayer matrix. The result is written to `test.png`.
# REPORTING BUGS
Any bugs can be reported by creating an issue on GitHub: <https://github.com/makeworld-the-better-one/didder>
Any bugs can be reported by creating an issue on GitHub: <https://github.com/makeworld-the-better-one/didder>