Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ollm/opencomic-ai-training/llms.txt

Use this file to discover all available pages before exploring further.

OpenComic AI Training drives Krita programmatically over D-Bus using the kra-remote plugin, which means its system requirements are shaped by both the Node.js generator and by Krita itself. Review the sections below before setting up the pipeline to avoid compatibility issues mid-run.
Windows and macOS are untested. The pipeline has been developed and tested exclusively on Linux (Ubuntu). D-Bus availability, AppImage compatibility, and filesystem path handling may behave differently on other operating systems. Contributions and bug reports for Windows and macOS support are welcome, but you should expect to make adjustments if you run the pipeline on those platforms.

Operating System

PlatformStatus
Linux (Ubuntu and derivatives)✅ Tested and supported
Other Linux distributions⚠️ Should work; untested
Windows⚠️ Untested — may require adjustments
macOS⚠️ Untested — may require adjustments
The primary constraint on Linux is D-Bus, which the kra-remote plugin uses to communicate between the generator and Krita. D-Bus is available by default on all major desktop Linux distributions.

Krita

RequirementDetails
Minimum versionKrita 5.3.0
Recommended deliveryAppImage (Linux)
Plugin requiredkra-remote (see below)
Krita 5.3.0 introduced the scripting and plugin APIs that kra-remote depends on. Any release of Krita at or above version 5.3.0 is compatible.
The Krita AppImage is the recommended way to install Krita on Linux for use with this pipeline. The AppImage is a self-contained executable that does not require system-wide installation, avoids conflicts with any distro-packaged Krita version, and is straightforward to pass directly to the --krita argument. Download the latest AppImage from krita.org.

kra-remote Plugin

The kra-remote plugin must be installed and enabled inside your Krita instance. The plugin exposes a D-Bus interface that the generator uses to issue drawing commands, apply filters, and export image frames. Install the plugin by following the instructions in the kra-remote repository. After installation, launch Krita at least once manually and confirm that the plugin loads without errors before starting a generation run.

Node.js and npm

RequirementDetails
Node.jsAny recent LTS release (Node 18, 20, or 22 recommended)
npmIncluded with all official Node.js distributions
Package managernpm (used by the build and generate scripts)
The generator is written in TypeScript and compiled to ESM output. The build step (npm run prepare) requires tsc (TypeScript compiler) and rollup, both of which are installed as devDependencies and do not need to be present globally on your system. Key runtime dependencies include:
PackagePurpose
sharpImage processing and format conversion
@napi-rs/canvasProcedural canvas rendering
yamlParsing YAML preset option files
dbus-nextD-Bus communication with the kra-remote plugin
cli-progressTerminal progress bar during generation
paperVector graphics and geometry used in procedural drawing routines
pure-randDeterministic random number generation for reproducibility

Disk Space

Dataset generation can produce a very large number of image files. Plan your storage accordingly:
  • The artifact removal models in the project were trained on 400,000 image pairs.
  • Descreen models used 120,000 image pairs.
  • Upscale models used between 25,000 and 100,000 image pairs depending on scale factor.
Each image pair consists of a clean PNG and a degraded PNG. At typical comic panel resolutions, a full artifact-removal dataset run of 400,000 pairs can occupy several hundred gigabytes of disk space. Use a fast local disk (NVMe or SSD) for the datasets/ output directory to keep I/O from becoming a bottleneck during long generation runs.

Hardware

There are no strict GPU requirements for dataset generation — all rendering is performed by Krita on the CPU. However, generation is a CPU- and I/O-bound workload, so faster processors and faster storage will directly reduce total generation time. GPU acceleration is relevant only during the downstream model training phase, which is handled by a separate framework such as traiNNer-redux.

Build docs developers (and LLMs) love