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

update README

Browse Source
This commit is contained in:
Waveplate 2024-12-15 07:35:24 -08:00
parent f146a613e6
commit 2dfac15db6
1 changed files with 34 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,19 +1,7 @@
# img2irc (1.1.0) # img2irc (1.1.0)
![img2irc preview](https://i.imgur.com/0omljq5.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 premiere command-line utility which converts images to irc/ansi art, with a lot of post-processing filters
`halfblock` mode increases the vertical resolution, doubling the total resolution for a given size
`quarterblock` mode increases both the vertical and horizontal resolution by twofold, quadrupling the total resolution for a given size
`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
@ -56,12 +44,39 @@ img2irc is a utility which converts images to half or quarterblock irc/ansi art,
| --rotate | rotate degrees | 0 | | --rotate | rotate degrees | 0 |
| --fliph | flip horizontal | false | | --fliph | flip horizontal | false |
| --flipv | flip vertical | false | | --flipv | flip vertical | false |
| --irc | use irc99 colours | false |
| --ansi | use 8-bit ansi colours | false | ### colours rendering options (select one)
| --ansi24 | use 24-bit ansi colours | false |
| --braille | use braille pixels | false | `irc` mode has 99 colours, (6.62-bit)
| --hb, --halfblock | use halfblock pixels | true |
| --qb, --quarterblock | use quarterblocks pixels | false | `ansi` mode has 256 colours (8-bit)
`ansi24` has 16777216 colours (24-bit)
| option | description |
|----------------------------------------|---------------------------------------------------------------|
| --irc | use irc99 colours |
| --ansi | use 8-bit ansi colours |
| --ansi24 | use 24-bit ansi colours |
### pixel rendering options (select one)
`halfblock` mode increases the vertical resolution, doubling the total resolution for a given size
`quarterblock` mode increases both the vertical and horizontal resolution by twofold, quadrupling the total resolution for a given size
`braille` mode uses 2x4 dot patterns to represent pixels, increasing resolution eightfold
| option | description |
|----------------------------------------|---------------------------------------------------------------|
| --braille | use braille pixels |
| --hb, --halfblock | use halfblock pixels |
| --qb, --quarterblock | use quarterblocks pixels |
### image processing options
| option | description | default value |
|----------------------------------------|---------------------------------------------------------------|---------------|
| -b, --brightness | adjust brightness (0 = no change) | 0.0 | | -b, --brightness | adjust brightness (0 = no change) | 0.0 |
| -c, --contrast | adjust contrast (0 = no change) | 0.0 | | -c, --contrast | adjust contrast (0 = no change) | 0.0 |
| -g, --gamma | adjust gamma (0 to 255) | 0.0 | | -g, --gamma | adjust gamma (0 to 255) | 0.0 |