komicinfo
1.0.2indexedRead and write CBZ archives with embedded ComicInfo.xml metadata; create CBZ from ordered image lists; customize per‑page info (types, bookmarks).
0
Stars
—
Used by
dependents
—
Health
/ 100
komicinfo
A Kotlin library for reading and writing ComicBook archives (CBZ) with ComicInfo.xml metadata.
This project is Kotlin Multiplatform (KMP) and publishes artifacts for JVM and Android.
Features
- Read CBZ files - Parse ComicInfo.xml metadata from CBZ archives
- Write CBZ files - Create CBZ archives with embedded ComicInfo.xml
Installation
dependencies {
implementation("io.github.broot5:komicinfo:<version>")
}
Example
Reading a CBZ file
val result = ComicBookReader.read(File("comic.cbz"))
result
.onSuccess { comicInfo ->
println("Title: ${comicInfo.title}")
println("Series: ${comicInfo.series}")
println("Pages: ${comicInfo.pageCount}")
}
.onFailure { exception -> println("Failed to read: ${exception.message}") }
Writing a CBZ file
// Create metadata
info = ComicInfo(
title = ,
series = ,
number = ,
writer = listOf(, ),
publisher = ,
languageISO = ,
)
imageFiles = listOf(
File(),
File(),
File(),
)
comicBook = ComicBook.create(info, imageFiles)
result = ComicBookWriter.write(comicBook, File())
result
.onSuccess { file -> println() }
.onFailure { exception -> println() }
Customizing page information
val comicBook = ComicBook.create(info, imageFiles) { page, file ->
when {
file.name.contains("cover") -> page.copy(type = ComicPageType.FRONT_COVER)
file.name.contains("credits") -> page.copy(bookmark = "Credits")
else -> page
}
}
Building from Source
# Clone the repository
git clone https://github.com/broot5/komicinfo.git
cd komicinfo
# Build
./gradlew build
# Generate JVM JAR
./gradlew jvmJar