mirror of
https://github.com/Belphemur/CBZOptimizer.git
synced 2025-10-14 04:28:51 +02:00
85 lines
2.3 KiB
Markdown
85 lines
2.3 KiB
Markdown
|
|
# 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.
|
|
|
|
## Features
|
|
|
|
- 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.
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository:
|
|
```sh
|
|
git clone https://github.com/belphemur/CBZOptimizer.git
|
|
cd CBZOptimizer
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```sh
|
|
go mod tidy
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Command Line Interface
|
|
|
|
The tool provides CLI commands to optimize and watch CBZ files. Below are examples of how to use them:
|
|
|
|
#### Optimize Command
|
|
|
|
Optimize all CBZ files in a folder recursively:
|
|
|
|
```sh
|
|
go run main.go optimize [folder] --quality 85 --parallelism 2 --override --format webp --split
|
|
```
|
|
|
|
#### Watch Command
|
|
|
|
Watch a folder for new CBZ files and optimize them automatically:
|
|
|
|
```sh
|
|
go run main.go watch [folder] --quality 85 --override --format webp --split
|
|
```
|
|
|
|
### Flags
|
|
|
|
- `--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.
|
|
|
|
## Testing
|
|
|
|
To run the tests, use the following command:
|
|
|
|
```sh
|
|
go test ./... -v
|
|
```
|
|
|
|
## Requirement
|
|
Needs to have libwep installed on the machine if you're not using the docker image
|
|
|
|
## Docker
|
|
`ghcr.io/belphemur/cbzoptimizer:latest`
|
|
|
|
## GitHub Actions
|
|
|
|
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`.
|
|
|
|
## Contributing
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch (`git checkout -b feature-branch`).
|
|
3. Commit your changes (`git commit -am 'Add new feature'`).
|
|
4. Push to the branch (`git push origin feature-branch`).
|
|
5. Create a new Pull Request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the `LICENSE` file for details. |