cbz-volume-combiner/README.md

README.md for CBZ Volume Combiner

# CBZ Volume Combiner

A tool for combining individual CBZ comic chapters into complete volume files.

## Features

- Combines multiple chapter CBZ files into single volume CBZ files
- Preserves chapter and page order
- Handles file naming and encoding issues
- Works with manga and comics stored in CBZ format

## Installation

```bash
# Clone the repository
git clone https://github.com/b3nw/cbz-volume-combiner.git
cd cbz-volume-combiner

# Install the package
pip install -e .

Usage

# Basic usage
cbz-volume-combiner /path/to/manga

# Recursive search
cbz-volume-combiner -r /path/to/manga

# With verbose output
cbz-volume-combiner -v /path/to/manga

# For detailed debugging information
cbz-volume-combiner -vv /path/to/manga

# Output to a specific directory
cbz-volume-combiner -r -o /path/to/output /path/to/manga

# Force recreation of volumes that already exist
cbz-volume-combiner -r -f /path/to/manga

# Set minimum number of chapters required to create a volume
cbz-volume-combiner -r -m 3 /path/to/manga

Expected File Naming Format

The script works best with files named in this format:

Manga Name v01 c001 Chapter Title [Group Name].cbz

Where:

• "v01" indicates volume 1
• "c001" indicates chapter 1
• Chapter title and scanlation group are optional

License

MIT