celogeek/go-comic-converter
1
0
Fork 0
mirror of https://github.com/celogeek/go-comic-converter.git synced 2025-05-24 15:52:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Celogeek 2024-04-28 22:10:13 +02:00
parent 897efdc1d1
commit 5e5a07c930
Signed by: celogeek
SSH Key Fingerprint: SHA256:njNJLzoLQdbV9PC6ehcruRb0QnEgxABoCYZ+0+aUIYc
1 changed files with 194 additions and 195 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

389
README.md
View File

@ -44,7 +44,7 @@ $ go install github.com/celogeek/go-comic-converter/v2
To force install a specific version: To force install a specific version:
``` ```
# specific version # specific version
$ go install github.com/celogeek/go-comic-converter/v2@v2.4.0 $ go install github.com/celogeek/go-comic-converter/v2@v2.6.9
# main branch # main branch
$ go install github.com/celogeek/go-comic-converter/v2@main $ go install github.com/celogeek/go-comic-converter/v2@main
@ -65,12 +65,12 @@ You can check if a new version is available with:
$ go-comic-converter -version $ go-comic-converter -version
go-comic-converter go-comic-converter
Path : github.com/celogeek/go-comic-converter/v2 Path : github.com/celogeek/go-comic-converter/v2
Sum : h1:4PRd8xrqnK6B1fNaKdUDdIR5CEhBmfUAl8IkUtNLz7s= Sum : h1:tUFF2m/fGlOJOwC0/PlTopMfcBMprKvgr6TiQHQxEeo=
Version : v2.6.3 Version : v2.6.9
Available Version: v2.6.3 Available Version: v2.6.9
To install the latest version: To install the latest version:
$ go install github.com/celogeek/go-comic-converter/v2@v2.6.3 $ go install github.com/celogeek/go-comic-converter/v2@v2.6.9
``` ```
# Supported image files # Supported image files
@ -137,35 +137,35 @@ $ go-comic-converter -input ~/Downloads/mymanga.cbr -profile SR -auto -manga -li
Go Comic Converter Go Comic Converter
Options: Options:
Input : ~/Downloads/mymanga.cbr Input : ~/Downloads/mymanga.cbr
Output : ~/Downloads/mymanga.epub Output : ~/Downloads/mymanga.epub
Author : GO Comic Converter Author : GO Comic Converter
Title : mymanga Title : mymanga
Workers : 8 Workers : 20
Profile : SR - Standard Resolution - 1200x1920 Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 90 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : true Auto contrast : true
AutoRotate : false Auto rotate : true
AutoSplitDoublePage : false Auto split double page : true
KeepDoublePageIfSplitted : true Keep double page if split : true
NoBlankImage : true No blank image : true
Manga : true Manga : true
HasCover : true Has cover : true
LimitMb : 200 Mb Limit : 200 Mb
StripFirstDirectoryFromToc : true Strip first directory from toc : false
SortPathMode : path=alphanum, file=alpha Sort path mode : path=alphanumeric, file=alpha
Foreground Color : #000 Foreground color : #000
Background Color : #FFF Background color : #FFF
Resize : true Resize : true
Aspect Ratio : 1:1.60 Aspect ratio : auto
Portrait Only : false Portrait only : false
Title Page : always Title page : always
Apple Book Compatibility : false Apple book compatibility : false
TOC: TOC:
- mymanga - mymanga
@ -185,35 +185,35 @@ $ go-comic-converter -input ~/Downloads/mymanga.cbr -profile SR -auto -manga -li
Go Comic Converter Go Comic Converter
Options: Options:
Input : ~/Downloads/mymanga.cbr Input : ~/Downloads/mymanga.cbr
Output : ~/Downloads/mymanga.epub Output : ~/Downloads/mymanga.epub
Author : GO Comic Converter Author : GO Comic Converter
Title : mymanga Title : mymanga
Workers : 8 Workers : 20
Profile : SR - Standard Resolution - 1200x1920 Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 90 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : true Auto contrast : true
AutoRotate : false Auto rotate : true
AutoSplitDoublePage : false Auto split double page : true
KeepDoublePageIfSplitted : true Keep double page if split : true
NoBlankImage : true No blank image : true
Manga : true Manga : true
HasCover : true Has cover : true
LimitMb : 200 Mb Limit : 200 Mb
StripFirstDirectoryFromToc : true Strip first directory from toc : false
SortPathMode : path=alphanum, file=alpha Sort path mode : path=alphanumeric, file=alpha
Foreground Color : #000 Foreground color : #000
Background Color : #FFF Background color : #FFF
Resize : true Resize : true
Aspect Ratio : 1:1.60 Aspect ratio : auto
Portrait Only : false Portrait only : false
Title Page : always Title page : always
Apple Book Compatibility : false Apple book compatibility : false
TOC: TOC:
- mymanga - mymanga
@ -248,29 +248,28 @@ $ go-comic-converter -show
Go Comic Converter Go Comic Converter
Options: Options:
Profile : Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 85 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : false Auto contrast : false
AutoRotate : false Auto rotate : false
AutoSplitDoublePage : false Auto split double page : false
KeepDoublePageIfSplitted : true No blank image : true
NoBlankImage : true Manga : false
Manga : false Has cover : true
HasCover : true Strip first directory from toc : false
StripFirstDirectoryFromToc : false Sort path mode : path=alphanumeric, file=alpha
SortPathMode : path=alphanum, file=alpha Foreground color : #000
Foreground Color : #000 Background color : #FFF
Background Color : #FFF Resize : true
Resize : true Aspect ratio : auto
Aspect Ratio : auto Portrait only : false
Portrait Only : false Title page : always
Title Page : always Apple book compatibility : false
Apple Book Compatibility : false
``` ```
### Change default settings ### Change default settings
@ -280,30 +279,30 @@ $ go-comic-converter -manga -auto -profile SR -limitmb 200 -save
Go Comic Converter Go Comic Converter
Options: Options:
Profile : SR - Standard Resolution - 1200x1920 Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 85 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : true Auto contrast : true
AutoRotate : true Auto rotate : true
AutoSplitDoublePage : true Auto split double page : true
KeepDoublePageIfSplitted : true Keep double page if split : true
NoBlankImage : true No blank image : true
Manga : true Manga : true
HasCover : true Has cover : true
LimitMb : 200 Mb Limit : 200 Mb
StripFirstDirectoryFromToc : false Strip first directory from toc : false
SortPathMode : path=alphanum, file=alpha Sort path mode : path=alphanumeric, file=alpha
Foreground Color : #000 Foreground color : #000
Background Color : #FFF Background color : #FFF
Resize : true Resize : true
Aspect Ratio : auto Aspect ratio : auto
Portrait Only : false Portrait only : false
Title Page : always Title page : always
Apple Book Compatibility : false Apple book compatibility : false
Saving to ~/.go-comic-converter.yaml Saving to ~/.go-comic-converter.yaml
``` ```
@ -313,35 +312,35 @@ If you want to change a setting, you can change only one of them
$ go-comic-converter -manga=0 -save $ go-comic-converter -manga=0 -save
Options: Options:
Profile : SR - Standard Resolution - 1200x1920 Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 85 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : true Auto contrast : true
AutoRotate : true Auto rotate : true
AutoSplitDoublePage : true Auto split double page : true
KeepDoublePageIfSplitted : true Keep double page if split : true
NoBlankImage : true No blank image : true
Manga : false Manga : false
HasCover : true Has cover : true
LimitMb : 200 Mb Limit : 200 Mb
StripFirstDirectoryFromToc : false Strip first directory from toc : false
SortPathMode : path=alphanum, file=alpha Sort path mode : path=alphanumeric, file=alpha
Foreground Color : #000 Foreground color : #000
Background Color : #FFF Background color : #FFF
Resize : true Resize : true
Aspect Ratio : auto Aspect ratio : auto
Portrait Only : false Portrait only : false
Title Page : always Title page : always
Apple Book Compatibility : false Apple book compatibility : false
Saving to ~/.go-comic-converter.yaml Saving to ~/.go-comic-converter.yaml
``` ```
### Reset default ### Reset default
To reset all value to default: To reset all value to default:
``` ```
@ -349,29 +348,28 @@ $ go-comic-converter -reset
Go Comic Converter Go Comic Converter
Options: Options:
Profile : Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 85 Quality : 85
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : false Auto contrast : false
AutoRotate : false Auto rotate : false
AutoSplitDoublePage : false Auto split double page : false
KeepDoublePageIfSplitted : true No blank image : true
NoBlankImage : true Manga : false
Manga : false Has cover : true
HasCover : true Strip first directory from toc : false
StripFirstDirectoryFromToc : false Sort path mode : path=alphanumeric, file=alpha
SortPathMode : path=alphanum, file=alpha Foreground color : #000
Foreground Color : #000 Background color : #FFF
Background Color : #FFF Resize : true
Resize : true Aspect ratio : auto
Aspect Ratio : auto Portrait only : false
Portrait Only : false Title page : always
Title Page : always Apple book compatibility : false
Apple Book Compatibility : false
Reset default to ~/.go-comic-converter.yaml Reset default to ~/.go-comic-converter.yaml
``` ```
@ -382,32 +380,31 @@ After playing around with the options, I have my perfect settings for all my dev
``` ```
$ go-comic-converter -reset $ go-comic-converter -reset
$ go-comic-converter -profile SR -quality 90 -autocontrast -manga -strip -aspect-ratio 1.6 -save $ go-comic-converter -profile SR -quality 90 -manga -aspect-ratio 1.6 -limitmb 200 -save
Options: Options:
Profile : SR - Standard Resolution - 1200x1920 Profile : SR - Standard Resolution - 1200x1920
Format : jpeg Format : jpeg
Quality : 90 Quality : 90
Grayscale : true Grayscale : true
Grayscale Mode : normal Grayscale mode : normal
Crop : true Crop : true
CropRatio : 1 Left - 1 Up - 1 Right - 3 Bottom Crop ratio : 1 Left - 1 Up - 1 Right - 3 Bottom - Limit 10% - Skip true
AutoContrast : true Auto contrast : false
AutoRotate : false Auto rotate : false
AutoSplitDoublePage : false Auto split double page : false
KeepDoublePageIfSplitted : true No blank image : true
NoBlankImage : true Manga : true
Manga : true Has cover : true
HasCover : true Strip first directory from toc : false
StripFirstDirectoryFromToc : true Sort path mode : path=alphanumeric, file=alpha
SortPathMode : path=alphanum, file=alpha Foreground color : #000
Foreground Color : #000 Background color : #FFF
Background Color : #FFF Resize : true
Resize : true Aspect ratio : 1:1.60
Aspect Ratio : 1:1.60 Portrait only : false
Portrait Only : false Title page : always
Title Page : always Apple book compatibility : false
Apple Book Compatibility : false
Saving to ~/.go-comic-converter.yaml Saving to ~/.go-comic-converter.yaml
``` ```
@ -415,11 +412,9 @@ Saving to ~/.go-comic-converter.yaml
Explanation: Explanation:
- `-profile SR`: standard resolution (fast conversion from Amazon as images do not need to be resized) - `-profile SR`: standard resolution (fast conversion from Amazon as images do not need to be resized)
- `-quality 90`: JPEG output quality of images - `-quality 90`: JPEG output quality of images
- `-autocontrast`: automatically improve contrast
- `-manga`: manga mode, read right to left - `-manga`: manga mode, read right to left
- `-limitmb 200`: size limit to 200MB allowing upload from SendToKindle website - `-limitmb 200`: size limit to 200MB allowing upload from SendToKindle website
- `-strip`: remove first level if alone on TOC, as often comics include a main directory with the title - `-aspect-ratio`: ensure aspect ratio is 1:1.6, best for kindle devices.
- `aspect-ratio`: ensure aspect ratio is 1:1.6, best for kindle devices.
# Help # Help
``` ```
@ -439,7 +434,7 @@ Output:
Config: Config:
-profile string (default "SR") -profile string (default "SR")
Profile to use: Profile to use:
- HR ( 2400x3840 ) - High Resolution - HR ( 2400x3840 ) - High Resolution
- SR ( 1200x1920 ) - Standard Resolution - SR ( 1200x1920 ) - Standard Resolution
- K1 ( 600x670 ) - Kindle 1 - K1 ( 600x670 ) - Kindle 1
@ -487,18 +482,22 @@ Config:
Crop ratio right: ratio of pixels allow to be non blank while cutting on the right. Crop ratio right: ratio of pixels allow to be non blank while cutting on the right.
-crop-ratio-bottom int (default 3) -crop-ratio-bottom int (default 3)
Crop ratio bottom: ratio of pixels allow to be non blank while cutting on the bottom. Crop ratio bottom: ratio of pixels allow to be non blank while cutting on the bottom.
-crop-limit int (default 10)
Crop limit: maximum number of cropping in percentage allowed. 0 mean unlimited.
-crop-skip-if-limit-reached (default true)
Crop skip if limit reached.
-brightness int -brightness int
Brightness readjustement: between -100 and 100, > 0 lighter, < 0 darker Brightness readjustment: between -100 and 100, > 0 lighter, < 0 darker
-contrast int -contrast int
Contrast readjustement: between -100 and 100, > 0 more contrast, < 0 less contrast Contrast readjustment: between -100 and 100, > 0 more contrast, < 0 less contrast
-autocontrast -autocontrast
Improve contrast automatically Improve contrast automatically
-autorotate -autorotate
Auto Rotate page when width > height Auto Rotate page when width > height
-autosplitdoublepage -autosplitdoublepage
Auto Split double page when width > height Auto Split double page when width > height
-keepdoublepageifsplitted (default true) -keepdoublepageifsplit (default true)
Keep the double page if splitted Keep the double page if split
-noblankimage (default true) -noblankimage (default true)
Remove blank image Remove blank image
-manga -manga
@ -512,12 +511,12 @@ Config:
-sort int (default 1) -sort int (default 1)
Sort path mode Sort path mode
0 = alpha for path and file 0 = alpha for path and file
1 = alphanum for path and alpha for file 1 = alphanumeric for path and alpha for file
2 = alphanum for path and file 2 = alphanumeric for path and file
-foreground-color string (default "000") -foreground-color string (default "000")
Foreground color in hexa format RGB. Black=000, White=FFF Foreground color in hexadecimal format RGB. Black=000, White=FFF
-background-color string (default "FFF") -background-color string (default "FFF")
Background color in hexa format RGB. Black=000, White=FFF, Light Gray=DDD, Dark Gray=777 Background color in hexadecimal format RGB. Black=000, White=FFF, Light Gray=DDD, Dark Gray=777
-noresize -noresize
Do not reduce image size if exceed device size Do not reduce image size if exceed device size
-format string (default "jpeg") -format string (default "jpeg")
@ -533,7 +532,7 @@ Config:
Title page Title page
0 = never 0 = never
1 = always 1 = always
2 = only if epub is splitted 2 = only if epub is split
Default config: Default config:
-show -show