-
Notifications
You must be signed in to change notification settings - Fork 14
Fields
Matt Nadareski edited this page Sep 19, 2025
·
11 revisions
For any command that includes a field of any sort, the name of the fields are standardized:
- If the field is in the header (such as filename, author, date), the format will be
header.name - If the field is in the game/machine (such as game name, publisher, manufacturer), the format will be
game.nameormachine.name - If the field is in the dat items (such as CRC, size, or optional flag), the format will be
item.name
Below is a full list of currently supported header fields. Please note that not all header fields are currently accounted for, especially for OfflineList. This is a known issue and is actively being worked on.
| Value | Description | Type | Applies To |
|---|---|---|---|
header.filename |
External DatFile filename | string |
Common DatFile header |
header.datname |
Internal DatFile name | string |
Common DatFile header |
header.description |
DatFile description | string |
Common DatFile header |
header.rootdir |
DatFile root directory | string |
Common DatFile header (SuperDAT only) |
header.category |
DatFile category | string |
Common DatFile header |
header.version |
DatFile version | string |
Common DatFile header |
header.date |
DatFile date | string |
Common DatFile header |
header.author |
DatFile author | string |
Common DatFile header |
header.email |
DatFile email | string |
Common DatFile header |
header.homepage |
DatFile homepage | string |
Common DatFile header |
header.url |
DatFile URL | string |
Common DatFile header |
header.comment |
DatFile comment | string |
Common DatFile header |
header.skipper |
Header skipper | string |
Common DatFile header, see Copier Headers for more details about supported values. |
header.type |
DatFile type field | string |
Common DatFile header (SuperDAT only) |
header.forcemerging |
Force merging | enum |
Common DatFile header, see Merging Modes for more details about supported values. |
header.forcenodump |
Force nodump | enum |
Common DatFile header, see Nodump Modes for more details about supported values. |
header.forcepacking |
Force packing | enum |
Common DatFile header, see Packing Modes for more details about supported values. |
header.debug |
Debug status | bool? |
ListXML and Logiqx only |
header.mameconfig |
MAME configuration name | string |
ListXML only |
header.build |
Build version | string |
Logiqx only |
header.system or header.plugin
|
System or plugin name | string |
Logiqx, OfflineList, and RomCenter only |
header.rommode |
Rom handling mode | enum |
Logiqx only, see Merging Modes for more details about supported values. |
header.biosmode |
BIOS handling mode | enum |
Logiqx only, see Merging Modes for more details about supported values. |
header.samplemode |
Sample handling mode | enum |
Logiqx only, see Merging Modes for more details about supported values. |
header.lockrommode |
Lock Rom handling mode | bool? |
Logiqx only |
header.lockbiosmode |
Lock BIOS handling mode | bool? |
Logiqx only |
header.locksamplemode |
Lock Sample handling mode | bool? |
Logiqx only |
header.screenshotswidth |
Screenshots width |
string (should be numeric) |
OfflineList only |
header.screenshotsheight |
Screenshots height |
string (should be numeric) |
OfflineList only |
header.info.name |
Infos list item name | string |
OfflineList only |
header.info.visible |
Infos list item visiblity | bool? |
OfflineList only |
header.info.inNamingOption |
Infos list item naming option flag | bool? |
OfflineList only |
header.info.default |
Infos list item default status | bool? |
OfflineList only |
header.canopen |
List of extensions that can be opened | string |
OfflineList only |
header.romtitle |
Rom title pattern | string |
OfflineList only |
header.rcversion |
RomCenter format version |
string (should be numeric) |
RomCenter only |
Below is a full list of currently supported game/machine fields. Please note that even though the examples below all use machine as the prefix, game is accepted as well:
| Value | Description | Type | Applies To |
|---|---|---|---|
machine.name |
Machine name | string |
Common Machine field |
machine.comment or machine.extra
|
Machine comment | string |
Common Machine field |
machine.description |
Machine description | string |
Common Machine field |
machine.year |
Machine year | string |
Common Machine field |
machine.manufacturer |
Machine manufacturer | string |
Common Machine field |
machine.publisher |
Machine publisher | string |
Common Machine field |
machine.category |
Machine category | string |
Common Machine field |
machine.romof |
Machine romof parent | string |
Common Machine field |
machine.cloneof |
Machine cloneof parent | string |
Common Machine field |
machine.sampleof |
Machine sampleof parent | string |
Common Machine field |
machine.type |
Machine type | enum |
Common Machine field, see Machine Types for more details about supported values. Please note that machine.type encompasses the ListXML isbios, isdevice, and ismechanical flags. |
machine.players |
Player count |
string (might be numeric?) |
AttractMode and Logiqx TruRip extension only |
machine.rotation |
Display rotation |
string (might be numeric?) |
AttractMode only |
machine.control |
Control method |
string (might be enum?) |
AttractMode only |
machine.amstatus |
AttractMode status flag |
string (might be enum?) |
AttractMode only |
machine.displaycount |
MDisplay count |
string (might be numeric?) |
AttractMode only |
machine.displaytype |
Display type |
string (might be enum?) |
AttractMode only |
machine.buttons |
Button count |
string (might be numeric?) |
AttractMode only |
machine.history |
History.dat entry | string |
ListXML only |
machine.sourcefile |
Source file | string |
ListXML and Logiqx only |
machine.runnable |
Runnability | bool? |
ListXML and Logiqx only |
machine.board |
Board name | string |
Logiqx only |
machine.rebuildto |
Machine rebuild location | string |
Logiqx only |
machine.id |
No-Intro ID | string |
Logiqx only |
machine.cloneofid |
No=Intro cloneof ID |
string |
Logiqx only |
machine.titleid |
Title ID | string |
Logiqx TruRip extension only |
machine.developer |
Developer | string |
Logiqx TruRip extension only |
machine.genre |
Primary game genre |
string (might be enum?) |
Logiqx TruRip extension only |
machine.subgenre |
Secondary game genre |
string (might be enum?) |
Logiqx TruRip extension only |
machine.ratings |
Game rating |
string (might be numeric?) |
Logiqx TruRip extension only |
machine.score |
Game score |
string (might be numeric?) |
Logiqx TruRip extension only |
machine.enabled |
Enabled status |
string (might be bool?) |
Logiqx TruRip extension only |
machine.crc |
CRC status(?) |
string (might be bool?) |
Logiqx TruRip extension only |
machine.relatedto |
Related game name | string |
Logiqx TruRip extension only |
machine.genmsxid |
Generation MSX game ID |
string (might be numeric?) |
openMSX only |
machine.system |
MSX system the game is for |
string (might be enum?) |
openMSX only |
machine.country |
Country of origin | string |
openMSX only |
machine.supported |
Support status | enum |
SoftwareList only, see Supported for more details about supported values. |
Below is a full list of currently supported item fields:
| Value | Description | Type | Applies To |
|---|---|---|---|
item.type |
Item type | enum |
Common DatItem field, see Item Types for more details about supported values. |
item.name |
Name | string |
adjuster, archive, biosset, chip, configuration, device_ref, dipswitch, disk, info, media, ramoption, release, rom, sample, sharedfeat, slot, and softwarelist only |
item.bios |
BIOS value | string |
rom only |
item.size |
Size | long? |
rom only |
item.crc |
CRC32 hash | string |
rom only |
item.md5 |
MD5 hash | string |
disk, media, and rom only |
item.ripemd160 |
RIPEMD160 hash | string |
rom only (Only available in .NET Framework 4.8 builds) |
item.sha1 |
SHA-1 hash | string |
disk, media, and rom only |
item.sha256 |
SHA-256 hash | string |
media and rom only |
item.sha384 |
SHA-384 hash | string |
rom only |
item.sha512 |
SHA-512 hash | string |
rom only |
item.spamsum |
SpamSum fuzzy hash | string |
media and rom only |
item.merge |
Name of item in parent set to merge with | string |
disk and rom only |
item.region |
Item region, usually referring to in the machine | string |
archive, disk, release, and rom only |
item.offset |
Offset within item to start at |
string (might be numeric?) |
rom only |
item.date |
Date associated with an item | string |
release and rom only |
item.status |
Item status | enum |
disk and rom only, see Item Statuses for more details about supported values. |
item.optional |
Denotes if item is required in the set | bool? |
disk and rom only |
item.inverted |
Denotes that the included CRC32 value is inverted | bool? |
rom only |
item.ado_source |
Indicates the source of the item | string |
rom only, Archive.org only |
item.ado_format |
Indicates the recognized file format of the item | string |
rom only, Archive.org only |
item.original_filename |
Indicates the original filename of this item | string |
rom only, Archive.org only |
item.rotation |
Indicates the rotation, if the item represents an image | string |
rom only, Archive.org only |
item.summation |
Archive.org summation | string |
rom only, Archive.org only |
item.alt_romname |
Indicates an alternate name for this item | string |
rom only, AttractMode only |
item.alt_title |
Indicates an alternate title for this item | string |
rom only, AttractMode only |
item.mia |
Indicates if the item is considered MIA | bool? |
rom only, Logiqx only |
item.original |
Original value for the item | string |
rom only, openMSX only |
item.subtype |
openMSX item subtype | enum |
rom only, openMSX only, see openMSX Subtypes for more details about supported values. |
item.openmsxtype |
Classified type of item |
string (might e enum?) |
rom only, openMSX only |
item.remark |
Remark about item | string |
rom only, openMSX only |
item.boot |
Boot status? | string |
rom only, openMSX only |
item.loadflag |
Load instructions for item | enum |
rom only, SoftwareList only, see Loadflags for more details about supported values. |
item.value |
Item value (changes with item type) | string |
condition, info, rom, and sharedfeat only, SoftwareList only |
item.index |
Indexed order of item |
string (might be numeric?) |
disk only, ListXML only |
item.writable |
Writable flag of item | bool? |
disk only, ListXML and SoftwareList only |
item.default |
Default status of item | bool? |
adjuster, biosset, ramoption, and release only |
item.analog.mask |
Mask value for an item | string |
analog only |
item.number |
Item ID number | string |
archive only |
item.clone |
Clone ID number | string |
archive only |
item.regparent |
Regional parent | string |
archive only |
item.languages |
Comma-separated list of languages | string |
archive only |
item.devstatus |
Development status | string |
archive only |
item.physical |
Physical | string |
archive only |
item.complete |
Complete | string |
archive only |
item.categories |
Comma-separated list of categories | string |
archive only |
item.description |
Item description | string |
biosset only |
item.tag |
Tag value for the item | string |
chip, condition, configuration, device, dipswitch, display, and port only |
item.chiptype |
Chip type | enum |
chip only, see Chip Types for more details about supported values. |
item.clock |
Clock speed for the item | long? |
chip only |
item.mask |
Mask value? | string |
condition, configuration, and dipswitch only |
item.relation |
Relationship between values | enum |
condition only, see Relations for more details about supported values. |
item.condition.tag |
Tag for conditions that are under other items | string |
condition only |
item.condition.mask |
Mask for conditions that are under other items | string |
condition only |
item.condition.relation |
Relation for conditions that are under other items | enum |
condition only, see Relations for more details about supported values. |
item.condition.value |
Value for conditions that are under other items | string |
condition only |
item.control.type |
General type of input | enum |
control only, see Control Types for more details about supported values. |
item.control.player |
Player which the input belongs to | long? |
control only |
item.control.buttons |
Total number of buttons | long? |
control only |
item.control.reqbuttons |
Total number of non-optional buttons | long? |
control only |
item.control.minimum |
Analog minimum value | long? |
control only |
item.control.maximum |
Analog maximum value | long? |
control only |
item.control.sensitivity |
Default analog sensitivity | long? |
control only |
item.control.keydelta |
Default analog keydelta | long? |
control only |
item.control.reverse |
Default analog reverse setting | bool? |
control only |
item.control.ways |
Number of primary ways for input | string |
control only |
item.control.ways2 |
Number of secondary ways for input | string |
control only |
item.control.ways3 |
Number of tertiary ways for input | string |
control only |
item.area.name |
Name of the item area | string |
dataarea and diskarea only |
item.area.size |
Size of the item area | long? |
dataarea only |
item.area.width |
Byte width of the item area | long? |
dataarea only |
item.area.endianness |
Endianness of the item area | enum |
dataarea only, see Endianness for more details about supported values. |
item.devicetype |
Device type for the item | enum |
device only, see Device Types for more details about supported values. |
item.fixedimage |
Fixed image? | string |
device only |
item.mandatory |
Mandatory flag | long? |
device only, only value used is 1 and used like bool?
|
item.interface |
Interface the item relates to | string |
device only |
item.displaytype |
Display type | enum |
display only, see Display Types for more details about supported values. |
item.rotate |
Display rotation |
long? (Generally only 0, 90, 180, and 270) |
display only |
item.flipx |
Determines if display is flipped on X-axis | bool? |
display only |
item.width |
Display width | long? |
display only |
item.height |
Display height | long? |
display only |
item.refresh |
Display refresh rate | double? |
display only |
item.pixclock |
Display pixel clock | long? |
display only |
item.htotal |
Total horizontal lines | long? |
display only |
item.hbend |
Horizontal blank end | long? |
display only |
item.hbstart |
Horizontal blank start | long? |
display only |
item.vtotal |
Total vertical lines | long? |
display only |
item.vbend |
Vertical blank end | long? |
display only |
item.vbstart |
Vertical blank start | long? |
display only |
item.supportstatus |
Support status of item | enum |
driver only, see Support Statuses for more details about supported values. |
item.emulationstatus |
Emulation status of item | enum |
driver only, see Support Statuses for more details about supported values. |
item.cocktailstatus |
Cocktail mode status of item | enum |
driver only, see Support Statuses for more details about supported values. |
item.savestatestatus |
Save state status of item | enum |
driver only, see Supported for more details about supported values. |
item.extension.name |
Extension represented by the item | string |
extension only |
item.featuretype |
Type of feature | enum |
feature only, see Feature Types for more details about supported values. |
item.featurestatus |
Status of feature | enum |
feature only, see Feature Statuses for more details about supported values. |
item.featureoverall |
Overall status of feature | string |
feature only, see Feature Statuses for more details about supported values. |
item.service |
Service enabled for item | bool? |
input only |
item.tilt |
Tilt enabled for item | bool? |
input only |
item.players |
Number of players supported for item | long? |
input only |
item.coins |
Number of coins needed for item | long? |
input only |
item.instance.name |
Name of item instance | string |
instance only |
item.instance.briefname |
Short name for item instance? | string |
instance only |
item.location.name |
Location name | string |
location only (conflocation and diplocation) |
item.location.number |
Location ID | long? |
location only (conflocation and diplocation) |
item.location.inverted |
Determines if state is inverted | bool? |
location only (conflocation and diplocation) |
item.part.name |
Name part of item | string |
part only |
item.part.interface |
Interface for part of item | string |
part only |
item.part.feature.name |
Name for the internal feature | string |
partfeature only |
item.part.feature.value |
Value for the internal feature | string |
partfeature only |
item.content |
Contents of the item | string |
ramoption only (not a field, rather the contents of the XML tag) |
item.language |
One language for the machine as an item | string |
release only |
item.setting.name or item.value.name
|
Determines name of setting | string |
setting only (confsetting or dipvalue) |
item.setting.value or item.value.value
|
Determines value of setting | string |
setting only (confsetting or dipvalue) |
item.setting.default or item.value.default
|
Determines if setting is default or not | bool? |
setting only (confsetting or dipvalue) |
item.slotoption.name |
Represents the name of the option | string |
slotoption only |
item.slotoption.devicename |
Represents the device set related to the option | string |
slotoption only |
item.slotoption.default |
Determines if option is default or not | bool? |
slotoption only |
item.softwarelist.status |
Support status for the softawre list | enum |
softwarelist only, see SoftwareList Statuses for more details about supported values. |
item.filter |
Name or extension filter | string |
softwarelist only |
item.channels |
Number of audio channels | long? |
sound only |
- Introduction
- Feature Overviews
- Auxiliary Information
- Development Information