Skip to content

Metadata Write-Back

Metadata Write-Back writes the current GuideVault metadata for selected entries back into the source package as a GuideVault JSON metadata file. This is useful when you want the metadata to travel with the file instead of existing only in the GuideVault database or override store.

GuideVault Metadata Write-Back container.

When you choose files in Target Files and click Write JSON to Selected Files, GuideVault writes its current metadata for those selected objects into the package.

The goal is portability. A package with embedded GuideVault JSON carries richer object metadata with it, including fields that may not fit cleanly into older comic/book metadata formats.

GuideVault works with game manuals, strategy guides, magazines, and other gaming documentation. Those object types often need metadata that general comic metadata does not fully capture.

GuideVault JSON is intended to better preserve details such as:

  • content type
  • game title
  • platform or preferred platform
  • publisher
  • author or writer
  • guide type
  • edition type
  • ISBN, ASIN, or book identifiers
  • magazine series
  • issue number
  • volume number
  • cover date
  • region and language
  • GuideVault-specific organization fields

When a CBZ contains a GuideVault JSON metadata file, GuideVault should treat that file as the preferred metadata source. That means GuideVault JSON takes precedence over other metadata files inside the CBZ, such as ComicInfo.xml.

This matters because ComicInfo.xml can be useful, but it was not designed specifically for game manuals, strategy guides, magazine issue cleanup, LaunchBox matching, or GuideVault-specific library organization.

A practical rule:

GuideVault JSON is the authoritative metadata file for GuideVault when it exists in the package.

CBZ files are ZIP-based packages, so GuideVault can update the package by adding or replacing the GuideVault JSON metadata file.

The app indicates that CBZ files are updated in place. That makes CBZ the cleanest format for portable GuideVault metadata.

CBR and PDF sources do not behave exactly like CBZ packages. Depending on the package writer behavior available in the runtime, GuideVault may create a metadata package or use another write path instead of modifying the original file directly.

Treat write-back behavior for CBR and PDF as implementation-dependent unless the app reports exactly what it is going to do in the preview/status message.

Write-back is not the same thing as a full library backup. It embeds metadata into selected packages, but it does not replace:

  • the GuideVault database
  • the library scan index
  • server configuration backups
  • source file backups
  • a real backup strategy for your library volume

Use Metadata Write-Back when you want selected items to carry GuideVault metadata with them. Use backups when you want to preserve the server state or library data.

  1. Clean or confirm metadata in GuideVault.
  2. Go to Server → Files.
  3. Use Target Files to select the objects you want to update.
  4. Confirm the selected object types and file paths.
  5. Run Write JSON to Selected Files.
  6. Rescan or reopen items if you want to confirm that embedded metadata is being read back correctly.

The sharp edge is that write-back preserves the metadata currently known to GuideVault. If the metadata is wrong before write-back, the embedded GuideVault JSON will faithfully preserve the wrong data. Clean first, write second.