GuidesLibrary ScannerManaging Files

Naming convention / File Structure

It’s important to know how Kavita parses the info from the files, so you can see what you want how you want.

Kavita uses parsing (not folder structure) to determine what is a series and what belongs to each series. Kavita requires that each series be in its folder and that no files are at root level of the library.

Read up on how the scanner works prior to continuing with this article.

When parsing filenames, anything between () themselves will be removed from the series name.


If you wish to separate series using Series Name (2019), it’s advised to change parenthesis to brackets { } and change series name in the UI

For all types of libraries, Kavita has an override for treating files as Specials.

Specials

Kavita treats multiple types of files as “Specials” and will group them in a separate tab in series detail. Special marker (SP) will be removed from the UI title, however is used when ordering and is required if not using internal metadata.

An entity is considered a special when a series can be parsed out of it, but no volume or chapter information is found:

Library Root
  ┖── Series Name
      ┖── Series Name.cbz

To force a Special status, the filename can include SP01, SP02, etc. This will take the file and force it to be a special:

Library Root
  ┖── Series Name
      ┖── Series Name SP01 Special Name.cbz

For it to identify as a special and not as the series from the filename, it will look up towards the library root and attempt to parse the series name from the folder names.
For example:

Library Root
  ┖── Again!!
      ┖── Specials
            ┖── Again The After Story SP01.cbz

Will parse "Again!!" for the Series name and group the file "Again The After Story SP01.cbz" as a special under the series "Again!!"

Additionally, if the file is a .cb* file you may set this value with the use of ComicInfo metadata using the format tag

Specials will fall back to the folder name for the Series name. If you have a different name than the series files, then your special may not properly group.

Volumes

In order for something to be parsed as having a volume, a volume must be on the filename.

Volume means:

  • v1
  • vol 1
  • vol. 1
  • volume 01
  • Vol 7.5
  • Volume.2000
  • 卷2
  • 册2
  • 2ĺ·»
  • t. 2
  • tome 2

Additionally if the file is a .cb* file, you may set this value with the use of ComicInfo metadata using the volume tag