User Tools

Site Tools



This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
how_datvault_works [2021/11/19 20:10]
johnsanc created
how_datvault_works [2022/03/12 09:06] (current)
Line 1: Line 1:
-====== How does DATVault work? ======+====== 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. 
 +{{ :diagrams:datvault-flow.png?nolink |}}
 +===== 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:
 +  * **''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.
 +  * **''directory''**: The default subdirectory the DAT will be downloaded to if the "Use default subdirectories" option is used when adding new DATs with the DATVault UI.
 +  * **''datROMsSize''**: The total uncompressed size of all ROMs in the DAT.
 +**Example DATVault JSON for MAME:**
 +   "group":"MAME",
 +   "system":"MAME ROMS (listxml)",
 +   "date":"2/23/2022 9:55:34 AM",
 +   "dateCreated":"9/7/2021 1:19:26 PM",
 +   "version":"V0.241",
 +   "datURL":"MAME V0.241 ROMS (listxml).zip",
 +   "cueURL":"",
 +   "datName":"MAME V0.241 ROMS (listxml).dat",
 +   "directory":"MAME ROMS (listxml)",
 +   "datROMsSize":307346898538
 +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.
 +|**⚠ CAUTION:** \\ DATVault only manages DAT updates for DATs it has downloaded. It will NOT update DATs you have placed into your DATRoot manually. Its advised to remove any manually managed DATs before having DATVault manage those DATs.|
 +|**ⓘ NOTE:** \\  DATVault will download any updates into the same directory that contains the respective JSON file. Before a DAT is updated, the current DAT you have (which is referenced in your JSON file) will be renamed with a ''.old'' extension. DATVault does not automatically remove these ''.old'' DATs, so you may want to periodically delete them if you do not wish to archive old DATs.|
 +|**ⓘ 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 [[datvault_setup|get started using DATVault]].
how_datvault_works.1637381426.txt.gz · Last modified: 2021/11/19 20:10 by johnsanc