elie/CBZOptimizer
1
0
Fork 0
mirror of https://github.com/Belphemur/CBZOptimizer.git synced 2025-10-14 04:28:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README to include CBR file support and clarify features

Browse Source
This commit is contained in:
Antoine Aflalo
2025-06-12 09:24:02 -04:00
parent 8a6ddc668e
commit 1258b06210
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,19 +1,22 @@
# CBZOptimizer # CBZOptimizer
CBZOptimizer is a Go-based tool designed to optimize CBZ (Comic Book Zip) files by converting images to a specified format and quality. This tool is useful for reducing the size of comic book archives while maintaining acceptable image quality. CBZOptimizer is a Go-based tool designed to optimize CBZ (Comic Book Zip) and CBR (Comic Book RAR) files by converting images to a specified format and quality. This tool is useful for reducing the size of comic book archives while maintaining acceptable image quality.
**Note**: CBR files are supported as input but are always converted to CBZ format for output.
## Features ## Features
- Convert images within CBZ files to different formats (e.g., WebP). - Convert images within CBZ and CBR files to different formats (e.g., WebP).
- Support for multiple archive formats including CBZ and CBR (CBR files are converted to CBZ format).
- Adjust the quality of the converted images. - Adjust the quality of the converted images.
- Process multiple chapters in parallel. - Process multiple chapters in parallel.
- Option to override the original CBZ files. - Option to override the original files (CBR files are converted to CBZ and original CBR is deleted).
- Watch a folder for new CBZ files and optimize them automatically. - Watch a folder for new CBZ/CBR files and optimize them automatically.
## Installation ## Installation
1. Clone the repository: 1. Clone the repository:
```sh ```sh
git clone https://github.com/belphemur/CBZOptimizer.git git clone https://github.com/belphemur/CBZOptimizer.git
cd CBZOptimizer cd CBZOptimizer
@@ -28,11 +31,11 @@ cd CBZOptimizer
### Command Line Interface ### Command Line Interface
The tool provides CLI commands to optimize and watch CBZ files. Below are examples of how to use them: The tool provides CLI commands to optimize and watch CBZ/CBR files. Below are examples of how to use them:
#### Optimize Command #### Optimize Command
Optimize all CBZ files in a folder recursively: Optimize all CBZ/CBR files in a folder recursively:
```sh ```sh
go run main.go optimize [folder] --quality 85 --parallelism 2 --override --format webp --split go run main.go optimize [folder] --quality 85 --parallelism 2 --override --format webp --split
@@ -40,7 +43,7 @@ go run main.go optimize [folder] --quality 85 --parallelism 2 --override --forma
#### Watch Command #### Watch Command
Watch a folder for new CBZ files and optimize them automatically: Watch a folder for new CBZ/CBR files and optimize them automatically:
```sh ```sh
go run main.go watch [folder] --quality 85 --override --format webp --split go run main.go watch [folder] --quality 85 --override --format webp --split
@@ -50,7 +53,7 @@ go run main.go watch [folder] --quality 85 --override --format webp --split
- `--quality`, `-q`: Quality for conversion (0-100). Default is 85. - `--quality`, `-q`: Quality for conversion (0-100). Default is 85.
- `--parallelism`, `-n`: Number of chapters to convert in parallel. Default is 2. - `--parallelism`, `-n`: Number of chapters to convert in parallel. Default is 2.
- `--override`, `-o`: Override the original CBZ files. Default is false. - `--override`, `-o`: Override the original files. For CBZ files, overwrites the original. For CBR files, deletes the original CBR and creates a new CBZ. Default is false.
- `--split`, `-s`: Split long pages into smaller chunks. Default is false. - `--split`, `-s`: Split long pages into smaller chunks. Default is false.
- `--format`, `-f`: Format to convert the images to (e.g., webp). Default is webp. - `--format`, `-f`: Format to convert the images to (e.g., webp). Default is webp.
@@ -63,9 +66,11 @@ go test ./... -v
``` ```
## Requirement ## Requirement
Needs to have libwep installed on the machine if you're not using the docker image Needs to have libwep installed on the machine if you're not using the docker image
## Docker ## Docker
`ghcr.io/belphemur/cbzoptimizer:latest` `ghcr.io/belphemur/cbzoptimizer:latest`
## GitHub Actions ## GitHub Actions
@@ -82,4 +87,4 @@ The project includes a GitHub Actions workflow to run tests on every push and pu
## License ## License
This project is licensed under the MIT License. See the `LICENSE` file for details. This project is licensed under the MIT License. See the `LICENSE` file for details.