Skip to content

Installation

Jump to bottom Edit New page
Alex Xu edited this page Jan 11, 2025 · 57 revisions

7-Zip

This is an optional requirement as of KCC 6.1.0. You only need to install it if 1) are using Windows 10 (2017) or earlier, 2) need to use an older KCC version, 3) you are using metadata editor, or 4) you are using particular problematic files, usually rar or cbr.

Windows 7-Zip

First install the 64-bit x64 version of 7z from https://www.7-zip.org/ or with command line:

winget install --id 7zip.7zip

KCC expects 7z to be installed to the default location at C:\Program Files\7-Zip\.

macOS 7-Zip/Unar

with Homebrew installed

brew install p7zip
brew install unar

KindleGen

Windows / Mac

Install Kindle Previewer 3 (KP3). KCC will automatically detect KindleGen from it.

An older version of KindleGen can be automatically detected from Kindle Comic Creator (KC2) as backup in case you have issues with KP3.

On Windows, KCC is very finicky with exe placement. If you still have issues, manually copy kindlegen.exe into the same folder as KCC_*.exe

You can find kindlegen.exe by:

  1. Right click Kindle Previewer.
  2. Open File Location.
  3. Repeat last two steps if you don't see a lib folder.
  4. Go to lib/fc/bin folder until you find kindlegen.exe
  5. Copy kindlegen.exe next to KCC.exe

Linux

For flatpak version, download kindlegen_linux_2.6_i386_v2.9 and move the executable kindlegen to ~/.var/app/io.github.ciromattia.kcc/data/

If MOBI conversion gets stuck please use flatseal and add host filesystem permission.

For AppImage place kindlegen in /usr/local/bin or ~/.local/bin.

DOWNLOADS

You can find the latest binary at the following link:

Windows installation

If you are using Windows 11 and it says "Search application in store?" when you open the .exe file, try using Windows 8 compatibility mode.

MacOS installation

x86_64 version

see: KindleComicConverter_osx_*.dmg in https://github.com/ciromattia/kcc/releases
If you can't open the last beta, fix it with:

  • right click on kcc icon -> click open -> click open on popup
M1/M2 arm64 version

GitHub Actions does not currently build on Apple Silicon. The provided DMG .app runs under Rosetta. M1 runners will be available by 2024.

The Apple Silicon compatible fork is available here if you want to run it from source natively:

https://github.com/ciromattia/kcc/pull/523

It only run ~10 seconds faster per volume compared to the packaged version available via Rosetta, since KindleGen still runs under Rosetta.

Or you could also have a look at this other project: https://github.com/celogeek/go-comic-converter

Linux

On Debian based distributions these two commands should install all needed dependencies:

$ sudo apt-get install -y python3 python3-dev libpng-dev libjpeg-dev p7zip-full p7zip-rar unrar-free libgl1 python3-pyqt5 && \
    python -m pip install --upgrade pip && \
    python -m pip install --upgrade -r requirements.txt
Optional dependencies
  • Qt platform integration plugin for Deepin Desktop Environment
$ sudo apt-get install qt5dxcb-plugin

FLATPAK

to use kcc-c2e or kcc-c2p, use this command

flatpak run --command=kcc-c2e io.github.ciromattia.kcc "$@"

APPIMAGE

  • install 7zip 
    $ sudo apt-get install -y p7zip-full
  • copy kindlegen into '/usr/local/bin' and grant execute permissions for MOBI conversion. 
    $ sudo cp -R kindlegen /usr/local/bin && sudo chmod a+x /usr/local/bin/kindlegen
  • make appImage executable 
    $ chmod a+x kindleComicConverter-latest-x86_64.AppImage
  • run with backend x11 or it might not work with fedora 
    $ GDK_BACKEND=x11 ./kindleComicConverter-latest-x86_64.AppImage

DOCKER

Install kindlegen in your working directory (the folder you're going to run KCC from) and get last docker image.

$ docker pull ghcr.io/ciromattia/kcc:latest

execute kcc-c2e

$ docker run --rm -v "$(pwd):/app" ghcr.io/ciromattia/kcc:latest

example

$ docker run --rm -v "$(pwd):/app" ghcr.io/ciromattia/kcc:latest -p KPW5 ./1.cbz

execute kcc-c2p

$ docker run --entrypoint /opt/kcc/kcc-c2p.py --rm -v "$(pwd):/app" ghcr.io/ciromattia/kcc:latest

Regarding local paths, the Docker container will only have access to the current folder and subfolders from where you're running it from. If you need to run this for relative paths, it gets trickier but is certainly doable.

Kindlegen must be accessible to the Docker container in its /app folder. You must also make your other path accessible in another folder. Here's one such example, if you want to convert 1.cbz in your local /path/to/sourcefiles folder:

$ docker run --rm -v "/path/to/kindlegen:/app" -v "/path/to/sourcefiles:/app/files" ghcr.io/ciromattia/kcc:latest -p KPW5 files/1.cbz

where /path/to/kindlegen is the folder where you have Kindlegen in, and /path/to/sourcefiles is the path to the source files you're trying to convert.

INSTALL FROM SOURCE

Easiest to use GitHub Desktop to clone the KCC repo. From GitHub Desktop, click on Repository in the toolbar, then Command Prompt (Windows)/Terminal (Mac) to open a window in the KCC repo.

Depending on your system Python may be called either python or python3.

We recommend using virtual environments to manage dependencies.

If you want to edit the code, a good code editor is VS Code.

Windows

One time setup and running for the first time:

python -m venv venv
venv\Scripts\activate.bat
pip install -r requirements.txt
python kcc.py

Every time you close Command Prompt, you will need to re-activate the virtual environment and re-run:

venv\Scripts\activate.bat
python kcc.py

Mac

You may have issues running the version on master on some Macs. If that happens, run this version instead: https://github.com/ciromattia/kcc/pull/523

One time setup and running for the first time:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python kcc.py

Every time you close Terminal, you will need to reactivate the virtual environment and re-run:

source venv/bin/activate
python kcc.py

Linux

Originally posted by @hhtien1408 in https://github.com/ciromattia/kcc/issues/438#issuecomment-1281159452

$ git clone https://github.com/ciromattia/kcc.git

On Debian based distributions these two commands should install all needed dependencies:

$ sudo apt-get install python3 python3-dev python3-pip libpng-dev libjpeg-dev p7zip-full python3-pyqt5

Then install the necessary packages. You can do it by running the following command. The requirements.txt file is inside this repository, you will see it when you clone the repo.

$ pip3 install -r 'requirements.txt'

This should install the required packages. You can check the version by running

$ pip3 freeze

If the packages are in the wrong version, you can try to upgrade them by running

$ pip3 install --upgrade name_of_the_package

Download kindlegen.

$ wget https://archive.org/download/kindlegen_linux_2_6_i386_v2_9/kindlegen_linux_2.6_i386_v2_9.tar.gz | tar xvzf kindlegen

Copy kindlegen into '/usr/local/bin' and grant execute permissions for MOBI conversion.

$ sudo cp -R '/home/user/Desktop/kindlegen' '/usr/local/bin'

$ sudo chmod +rwx '/usr/local/bin/kindlegen'

Run python file for KCC GUI

$ python3 kcc.py

If everything goes well, you now should be able to use it.

Create destop file in '~/.local/share/applications' with codes:

#!/usr/bin/env xdg-open

[Desktop Entry]
Type=Application
Name=Kindle Comic Converter
Icon=kcc
Exec=python3 '/home/user/kcc/kcc.py'
Terminal=false
StartupWMClass=kcc
Name[en_US]=Kindle Comic Converter

Copy icon file into '/home/user/.local/share/icons'

$ sudo cp -R 'icons/comic2ebook.png' '/home/user/.local/share/icons'
Add a custom footer
Add a custom sidebar
Clone this wiki locally