Custom metadata supports

Mr. SimPle (asd) 3 years ago updated by eduo 3 years ago 15

I want to make my own metadata for cbz files and display on the webpage.

I tried ComicTagger but it doesn't have custom tags that I want and Ubooquity doesn't display those metadata so instead using this, I want to make txt file in it and display them on Ubooquity.

txt file format:

Name: 'comic_name';

Author: 'author_name';

Publisher: 'publisher_name';

Volume: 65;

Characters: 'character1' , 'character2';  


To me it sounds like you are not looking in the right direction.

Could you please explain your need behind your wish?

If you want customs metadata, then modify the xml according to your needs.

There is more change for non-standard metadata to be one day considered by Tom. Tom to adapt his code to cope with a unusual txt file to embed this seems very unprovable to me.

FYI, open any cbz you have previously created and look for the file ComicInfo.xml

Its format looks like this:

<?xml version="1.0"?>









which is just an extract of what you can add as metadata type.

Oh, so I can add any tags I want in that xml file?

and also, can I see them in Ubooquity server website? because I made metadata using ComicTagger and only I could see was the name of comic and language like EN, KO.


Ubooquity reads the ComicInfo.xml file mentionned by Matthieu.

The following tags are extracted: (not all of them are displayed in Ubooquity yet)


Adding custom tags is not possible (nor planned).

Comictagger can produce the proper tags Ubooquity currently supports. You just need to change the read and modify format to ComicRack. I imagine you have Comicbooklover's format which is faster but is currently not recognized by UBooquity (from what I can see).

You can change the format and the details as captured from Comicvine by comictagger should start appearing in Ubooquity.

I've just realised I'm getting half of the potential experience because of this.  All my comics are CBI'd CBZs rather than Comicrack's.

I find ComicRack's tagging terrible in all respects, as it requires uncompression and recompression of the files whenever something is changed. CBI's tagging works on the ZIP comment so it can be rewritten in a second, even for CBZs of hundred's of megabytes.

Has CBL tagging ever been considered for Ubooquity? Comictagger supports both and can convert between one and the other, but CBI on CBZ has too many advantages to ignore (CBR vs CBZ arguments are moot, as files are pre-compressed and savings differences are minimal).

I tried searching the forum but didn't find anything.

Perhaps it could be implemented so if there's CR tags it uses those and only if there aren't then it looks for CBI and uses them if existing?

CBI Scheme:


Has CBL tagging ever been considered for Ubooquity ?

Yes, when I added metadata support I considered the three schemes supported by ComicTagger.

I don't remember all the factors of my choice (it was in 2014), but from what I can remember:

  • ComicRack: de facto standard, as it is the most supported format. Implemented.
  • Comet: used by one application only. Not implemented.
  • CBI: not supported by a lot of applications at the time (still not many today), and I did not like the use of the zip comment, which was harder to extract/use/understand (not only from a code perspective but for end-users) than a simple embedded file. Not implemented.

    And since you mention the CBZ/CBR argument being moot (CBR are a useless heresy when it comes to storing comics), I might add that compression in the CBZ file is pointless (JPG files are already compressed inside anyway), so a good CBZ file should not use it. And in that case (zip file used as a container, without compression), replacing a file inside the CBZ is very fast (although not as fast a changing the comment, granted). But that's just for the sake of argument. I agree with your performance point.

So I have no plan to add support for it as today, mostly because it is not used much at all. (and because I already have a huuuuge feature backlog and not enough sleep).

I appreciate the response. I understand your reasoning and respect it even though it's not what I'd prefer :)

I agree that CBR, CBR or rarer ones like CBT or CB7 should only store and not compress. And for this the STORE method from ZIP is much cleaner, faster and simpler to implement. In the end the point is not the compression but the packaging.

Sadly (to my eyes), CBR is the de facto standard out there. As a developer myself I much prefer zip so I standardized to CBZ early on and from there CBI tags seemed the logical choice (also because they don't "touch" the contents of the package, something I thought was the least I could do since I was renaming the archives. Also because from working for a long time with MP3 and MP4 files, I got very used to quick tag updates and only CBZ+CBI could provide that.

To be honest, all tagging standards are questionable, but it's because they've had to make do with the previous de facto standard (CBZ/CBR).

Thanks again, and congratulations on Ubooquity. I finally upgraded to 2.0 today after much insistence from the Application and there hasn't been a problem at all. Looking around for themes I *discovered* I should be able to see a lot more data than I do (I think it was looking at the Comixology theme, which doesn't work in 2.1.0 anyway but still...) and looking around discovered why I have never been able to see it online. Metadata is the only reason I continue using also Comicstreamer for some cases (it uses Comictagger behind the scenes, so it reads CBI)

If you send me a (small please) comic sample with CBI metadata, I might take a very quick look, just in case... (no promises though)


This is a zip file with two CBZ and two CBR. All four files have a single JPG in them and all are tagged with exactly the same data. I have tagged all four with ComicTagger without modifying the data in any file afterwards:


The files with CBI in the name have ComicBookInfo JSON tags in the comments of the archive.

The comment in a zip file can be seen with this command: 

unzip -z *CBI.cbz

The comment in a rar file can be seen wit this command:

rar v *.CBI.cbr

The JSON looks like this: 


JSON Formatted for human reading:


The files with CR in the name have ComicRack tags in an XML file called ComicInfo.xml inside the archive.

The XML file contents look like this:


If you need different types of sample files or if the files threw an error let me know and I'll try to come up with new ones.


I have downloaded them and had begun to take a look, but I've been taken away by non-Ubboquity issues for a while.

I still plan to give it shot. :)

Ubooquity 2.1.1 released with CBI support for CBZ (not CBR, as I couldn't access the comment for this type of archive).

Holy snaps!

Testing right away!

Was there a problem in the CBR or is there a problem with the unrar library getting the comments. I used the command line but the library you're using may not handle comments.

I'm using JUnrar, which is the only Java RAR librtary I know about. And as far as I know it doesn't handle comments.

That's a shame. Works for me as I convert everything to CBZ (which I prefer for various reasons) but I understand it's a bummer.

I've updated, cleaned the database and it now works perfectly. Thanks! :D