Skip to main content

Documentation Index

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

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

opencomic-ai-models is an npm package that ships a curated collection of AI model weight files — for upscaling, artifact removal, and descreening — directly inside your node_modules directory. Instead of asking users to manually download, verify, and locate model files, this package resolves the bundled models/ directory to an absolute filesystem path at runtime, so any tool or binary that needs a model directory can receive it with a single property access. It is the foundational data layer of the OpenComic AI ecosystem, consumed by opencomic-ai-bin and the broader OpenComic application.

​
Model Categories

The package bundles three families of models, each targeting a distinct image-processing task: Upscaling — Increases image resolution using neural networks trained on high-quality photo and anime content. Includes well-known models such as RealESRGAN x4 Plus Anime, RealCUGAN, Waifu2x CUnet, Remacri, Ultramix Balanced, and many others. These models are used with the upscayl, realcugan, and waifu2x upscaler backends. Artifact Removal — Reduces JPEG compression artifacts, ringing, and noise without altering structure. Includes the custom OpenComic AI Artifact Removal family (Compact, Lite, and full variants) as well as community models such as NMKD Jaywreck3 Lite and SaiyaJin DeJpeg. Descreening — Removes halftone dot patterns from scanned comic and manga pages. Includes the OpenComic AI Descreen Hard family (Compact, Lite, and full variants) alongside community models such as Halftone Patch and WTP DescreenTon Compact.

​
The API

The entire public API of opencomic-ai-models is a single property: 
import OpenComicAIModels from 'opencomic-ai-models';

const modelsPath: string = OpenComicAIModels.path;
// e.g. "/home/user/project/node_modules/opencomic-ai-models/models"
OpenComicAIModels.path returns the absolute filesystem path to the models/ directory bundled inside the package. Pass this string directly to any upscaler binary or library that accepts a model directory argument — no configuration, no environment variables, no hardcoded paths.

​
Explore the Docs

Installation

Install the package from GitHub via npm, yarn, or pnpm.

Quickstart

Resolve the model path and call an upscaler binary in minutes.

​
Licensing

This package carries a dual license that distinguishes between code and data:
ComponentLicense
Source codeMIT
OpenComic AI model weightsCC BY 4.0
The TypeScript source, build configuration, and JavaScript distribution files are MIT-licensed. The OpenComic AI model weight files (*.bin, *.param, *.onnx, etc.) bundled in the models/ directory are released under the Creative Commons Attribution 4.0 International License. Third-party model weights retain their original upstream licenses — see the README’s Credits section for details. opencomic-ai-models is part of a wider ecosystem of open-source tooling:
  • OpenComic — The desktop comic and manga reader that consumes these models for on-the-fly image enhancement.
  • opencomic-ai-bin — Distributes the upscaler binaries (upscayl, realcugan, waifu2x) as an npm package; pairs with opencomic-ai-models to form a complete, self-contained AI pipeline.
  • opencomic-ai-training — Contains the training scripts and datasets used to produce the custom OpenComic AI model weights shipped in this package.

Build docs developers (and LLMs) love

Get started for freeTalk to us