Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

JSON Reading List (JRL) Files

kthoom supports loading in Reading Lists of books. Think of a reading list as a playlist for your comic book reader. It's a way to load in a bunch of comic book files at once.

Since I could not find any existing format for this, I created my own: JSON Reading List files (.JRL).

The format is simple:

{
  "baseURI": "https://example.com",
  "items": [
    {"type": "book", "uri": "/foo/bar.cbz", "name": "Optional name"},
    {"type": "book", "uri": "http://example.com/foo/baz.cbr"}
  ]
}
  • The "baseURI" field is optional. If present, it is used to resolve item URI references.
  • The "uri" field must be an absolute URI or a URI reference that points to a comic book file (.cbz, .cbr). If it is a URI reference:
    • if baseURI is present, that is used
    • else if the Reading List file was fetched via a URI, the Reading List file's URI base is used
    • otherwise, behavior is undefined.
  • The "type" field must have the value "book".
  • The "name" field is optional and can be a short name for the comic book.

The JSON schema for the JRL file format is here.

I created a simple web app to let you search for books and create reading lists: jrlgen.