mirrors/img2irc
1
Fork 0
mirror of https://github.com/waveplate/img2irc.git synced 2024-12-22 13:46:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Waveplate 2024-12-15 07:33:48 -08:00
parent 7cadbf8aad
commit f146a613e6
1 changed files with 70 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
README.md
View File

@ -1,13 +1,19 @@
# img2irc (1.0.6) # img2irc (1.1.0)
![img2irc preview](https://i.imgur.com/oetHhMB.png) ![img2irc preview](https://i.imgur.com/0omljq5.png)
img2irc is a utility which converts images to half or quarterblock irc/ansi art, with a lot of post-processing filters img2irc is a utility which converts images to half or quarterblock irc/ansi art, with a lot of post-processing filters
*halfblock* means that each row will contain two rows worth of pixels, effectively doubling the vertical resolution `halfblock` mode increases the vertical resolution, doubling the total resolution for a given size
*quarterblock* (experimental) means that each row will contain two rows worth of pixels, and each column will contain two columns worth of pixels, quadrupling the resolution `quarterblock` mode increases both the vertical and horizontal resolution by twofold, quadrupling the total resolution for a given size
the `irc` mode has 99 colours, the `ansi` mode has 256, `ansi24` has 16777216 `braille` mode uses 2x4 dot patterns to represent pixels, increasing resolution eightfold
`irc` mode has 99 colours, (6.62-bit)
`ansi` mode has 256 colours (8-bit)
`ansi24` has 16777216 colours (24-bit)
# how to install # how to install
@ -39,45 +45,61 @@ the `irc` mode has 99 colours, the `ansi` mode has 256, `ansi24` has 16777216
`img2irc <URL or PATH> [OPTIONS]` `img2irc <URL or PATH> [OPTIONS]`
| option | description | default value | | option | description | default value |
| ------ | ----------- | ------------- | |----------------------------------------|---------------------------------------------------------------|---------------|
| `<IMAGE>` | image url or file path | none | | image | image url or file path | required |
| `--irc` | irc render type | true | | -w, --width | output image width in columns | auto |
| `--ansi` | 8-bit ansi render type | false | | -h, --height | output image height in rows | auto |
| `--ansi24` | 24-bit ansi render type | false | | --scale | scaling factors (x:y, e.g., "2:2") | none |
| `--qb` | use quarterblocks (experimental) | false | | --aspect | final aspect ratio (x:y, e.g., "2:1") | none |
| `-w, --width <WIDTH>` | output image width in columns | 50 | | --crop | crop image ("x1,y1,x2,y2") | none |
| `-b, --brightness=<BRIGHTNESS>` | adjust brightness (-255 to 255) | 0 | | --filter | sampling filter | nearest |
| `-c, --contrast=<CONTRAST>` | adjust contrast (-255 to 255) | 0 | | --rotate | rotate degrees | 0 |
| `-s, --saturation=<SATURATION>` | adjust saturation (-255 to 255) | 0 | | --fliph | flip horizontal | false |
| `-H, --hue <HUE>` | rotate hue (0 to 360) | 0 | | --flipv | flip vertical | false |
| `-g, --gamma <GAMMA>` | adjust gamma (0 to 255) | 0 | | --irc | use irc99 colours | false |
| `--dither <DITHER>` | dithering (1 to 8) | 0 | | --ansi | use 8-bit ansi colours | false |
| `--pixelize <PIXELIZE>` | pixelize pixel size | 0 | | --ansi24 | use 24-bit ansi colours | false |
| `--gaussian-blur <GAUSSIAN_BLUR>` | gaussian blur radius | 0 | | --braille | use braille pixels | false |
| `--oil <OIL>` | oil ("[RADIUS],[INTENSITY]") | | | --hb, --halfblock | use halfblock pixels | true |
| `--grayscale` | converts image to black and white | | --qb, --quarterblock | use quarterblocks pixels | false |
| `--nograyscale` | exclude grayscale colours from the palette | | -b, --brightness | adjust brightness (0 = no change) | 0.0 |
| `--halftone` | made up of small dots creating a continuous-tone illusion | | -c, --contrast | adjust contrast (0 = no change) | 0.0 |
| `--sepia` | brownish, aged appearance like old photographs | | -g, --gamma | adjust gamma (0 to 255) | 0.0 |
| `--normalize` | adjusts brightness and contrast for better image quality | | -s, --saturation | adjust saturation (0 = no change) | 0.0 |
| `--noise` | random variations in brightness and color like film grain | | -u, --hue | rotate hue (0 to 360) | 0.0 |
| `--emboss` | gives a raised, 3d appearance | | -i, --invert | colors are inverted, opposite on the color wheel | false |
| `--box-blur` | smoothed appearance like frosted glass | | -d, --dither | dithering (1 to 8) | 0 |
| `--identity` | no modifications, unchanged image | | -B, --luma-brightness | adjust luma brightness (braille only) | 0.0 |
| `--laplace` | enhances edges and boundaries in an image | | -C, --luma-contrast | adjust luma contrast (braille only) | 0.0 |
| `--noise-reduction` | reduces noise for a cleaner, clearer image | | -G, --luma-gamma | adjust luma gamma (braille only) | 0.0 |
| `--sharpen` | increases clarity and definition, making edges and details more distinct | | -S, --luma-saturation | adjust luma saturation (braille only) | 0.0 |
| `--cali` | cool blue tone with increased contrast | | -I, --luma-invert | luminance is inverted (braille only) | false |
| `--dramatic` | high contrast and vivid colors for a dramatic effect | | --colorspace | colourspace (hsl, hsv, hsluv, lch) | hsv |
| `--firenze` | warm, earthy tones reminiscent of tuscan landscapes | | --grayscale | converts image to black and white | false |
| `--golden` | warm, golden glow like sunset light | | --nograyscale | exclude grayscale colours from the palette | false |
| `--lix` | high-contrast black and white appearance with increased sharpness | | --pixelize | pixelize pixel size | 0 |
| `--lofi` | low-fidelity, retro appearance like old photographs or film | | --boxblur | simple average of all the neighboring pixels surrounding one | false |
| `--neue` | clean, modern appearance with neutral colors and simple design | | --gaussianblur | gaussian blur radius | 0 |
| `--obsidian` | dark, monochromatic appearance with black and gray shades | | --oil | oil filter ("[radius],[intensity]") | none |
| `--pastel-pink` | soft, delicate pink tint like pastel colors | | --halftone | made up of small dots creating a continuous-tone illusion | false |
| `--ryo` | bright, high-contrast appearance with vivid colors and sharp details | | --sepia | brownish, aged appearance like old photographs | false |
| `--invert` | colors are inverted, opposite on the color wheel | | --normalize | adjusts brightness and contrast for better image quality | false |
| `--frosted-glass` | blurred, frosted appearance as if viewed through semi-transparent surface | | --noise | random variations in brightness and color like film grain | false |
| `--solarize` | strange, otherworldly appearance with inverted colors and surreal atmosphere | | --emboss | gives a raised, 3d appearance | false |
| `--edge-detection` | highlights edges and boundaries in an image | | --identity | no modifications, unchanged image | false |
| --laplace | enhances edges and boundaries in an image | false |
| --denoise | reduces noise for a cleaner, clearer image | false |
| --sharpen | increases clarity and definition, making edges and details more distinct | false |
| --cali | cool blue tone with increased contrast | false |
| --dramatic | high contrast and vivid colors for a dramatic effect | false |
| --firenze | warm, earthy tones reminiscent of tuscan landscapes | false |
| --golden | warm, golden glow like sunset light | false |
| --lix | high-contrast black and white appearance with increased sharpness | false |
| --lofi | low-fidelity, retro appearance like old photographs or film | false |
| --neue | clean, modern appearance with neutral colors and simple design | false |
| --obsidian | dark, monochromatic appearance with black and gray shades | false |
| --pastelpink | soft, delicate pink tint like pastel colors | false |
| --ryo | bright, high-contrast appearance with vivid colors and sharp details | false |
| --frostedglass | blurred, frosted appearance as if viewed through semi-transparent surface | false |
| --solarize | strange, otherworldly appearance with inverted colors and surreal atmosphere | false |
| --edgedetection | highlights edges and boundaries in an image | false |