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.
- Convert images within CBZ files to different formats (e.g., WebP).
- Adjust the quality of the converted images.
- Process multiple chapters in parallel.
- Option to override the original CBZ files.
- Watch a folder for new CBZ files and optimize them automatically.
- Clone the repository:
git clone https://github.com/belphemur/CBZOptimizer.git
cd CBZOptimizer
- Install dependencies:
go mod tidy
The tool provides CLI commands to optimize and watch CBZ files. Below are examples of how to use them:
Optimize all CBZ files in a folder recursively:
go run main.go optimize [folder] --quality 85 --parallelism 2 --override --format webp --split
Watch a folder for new CBZ files and optimize them automatically:
go run main.go watch [folder] --quality 85 --override --format webp --split
--quality
,-q
: Quality for conversion (0-100). Default is 85.--parallelism
,-n
: Number of chapters to convert in parallel. Default is 2.--override
,-o
: Override the original CBZ files. 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.
To run the tests, use the following command:
go test ./... -v
Needs to have libwep installed on the machine if you're not using the docker image
ghcr.io/belphemur/cbzoptimizer:latest
The project includes a GitHub Actions workflow to run tests on every push and pull request to the main
branch. The workflow is defined in .github/workflows/go.yml
.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature-branch
). - Create a new Pull Request.
This project is licensed under the MIT License. See the LICENSE
file for details.