User Tools

Site Tools


how_datvault_works

This is an old revision of the document!


How DATVault Works

DATVault acts as an indexing, updating, and delivery service for DATs. DATVault is designed to be flexible and it does not force you to organize your DATs in any specific way.

DATVault JSON Files

DATVault works by detecting special JSON files in your DatRoot. Each DAT you would like to manage has its own corresponding JSON file. Each file provides info about the DAT version you currently have.

⚠ CAUTION:
The DATVault JSON files are not meant to be manually edited. Modifying the JSON files may cause DAT updates to not work properly. The information provided is for reference only.

The DATVault JSON files contain the following keys:

  • name: Included for backward compatibility.
  • group: The group the DAT belongs to. Used for filters.
  • system: The name of the system.
  • date: The date the DAT was was last updated on the DATVault server.
  • dateCreated: The date the DAT was first added to DATVault. Used for the configurable β€œNew” filter.
  • version: The version of the DAT.
  • datURL: The download filename for the current DAT.
  • cueURL: The download filename for cue pack of the DAT (if applicable).
  • datName: The file name of the current DAT.

Example DATVault JSON for MAME:

{
   "name":null,
   "group":"MAME",
   "system":"MAME ROMS (listxml)",
   "date":"11/10/2021 2:28:56 PM",
   "dateCreated":"9/7/2021 1:19:26 PM",
   "version":"V0.237",
   "datURL":"MAME V0.237 ROMS (listxml).zip",
   "cueURL":"",
   "datName":"MAME V0.237 ROMS (listxml).dat"
}

The information in the JSON file is compared against the DATVault repository to determine if there are updates available to download. If the JSON file you have does not match the latest version available by DATVault, then the corresponding DAT has an update. When you update a DAT, the JSON file is also updated.

πŸ›ˆ NOTE:
DATVault will download any updates into the same directory that contains the respective JSON file. Any existing DATs for that system will have a .old extension appended to the end of the filename.
πŸ›ˆ NOTE:
Some DATs for disc based systems have accompanying cue sheets. DATVault will download cue packs to a folder called cues in your Primary ToSort directory.

Now that you understand how DATVault works at a high level, refer to the next section to get started using DATVault.

how_datvault_works.1638114351.txt.gz Β· Last modified: 2021/11/28 07:45 by johnsanc