gemus.dat_specification
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
Last revision | |||
— | gemus.dat_specification [2020/05/12 11:17] – created Jimbo | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== GEMUS.DAT Specification ====== | ||
+ | |||
+ | The GEMUS.DAT file is used by GEMUS' | ||
+ | |||
+ | The GEMUS.DAT file is useless by itself. Accompanying any GEMUS.DAT file there should be a \Scripts sub-folder (in the same folder as the DAT file). This folder contains all the GEMUS scripts pointed to by the DAT file. Without these scripts the Emulator Setup Wizard will not run. If using the Global DAT File, the wizard will copy the relevant scripts from the \Scripts folder into the appropriate database' | ||
+ | |||
+ | ==== A Sample GEMUS.DAT File ==== | ||
+ | < | ||
+ | [DAT] | ||
+ | Version=1.0 | ||
+ | |||
+ | [CREDITS] | ||
+ | Author=Fred Bloggs | ||
+ | Contact=http:// | ||
+ | LastUpdated=2002-04-22 | ||
+ | |||
+ | [Commodore 64] | ||
+ | ¬CCS64 v2.0b DOS¬http:// | ||
+ | ¬CCS64 v2.0b Win32¬http:// | ||
+ | ¬CCS64 v1.09¬http:// | ||
+ | ¬WinVICE v1.6¬http:// | ||
+ | |||
+ | [Atari ST] | ||
+ | ... | ||
+ | |||
+ | [ZX Spectrum] | ||
+ | ... | ||
+ | |||
+ | [Arcade] | ||
+ | ... | ||
+ | |||
+ | [Super Nintendo] | ||
+ | ... | ||
+ | |||
+ | [Apple] | ||
+ | ... | ||
+ | |||
+ | [BBC Micro] | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | ==== Explanation ==== | ||
+ | |||
+ | == The [DAT] Section == | ||
+ | |||
+ | < | ||
+ | |||
+ | This is the version of the DAT file. It Should be 1.0. | ||
+ | |||
+ | == The [CREDITS] Section == | ||
+ | |||
+ | < | ||
+ | |||
+ | This is where the authors of the DAT file are specified. In the above example, the author is Fred Bloggs. You can specify multiple authors by separating them with a comma. | ||
+ | |||
+ | < | ||
+ | |||
+ | This is the URL or email address where updates or newer versions of the DAT file are available. This link appears in the first and last screens of the emulator setup wizard. | ||
+ | |||
+ | < | ||
+ | |||
+ | This is the date that the DAT file was last updated, in the format YYYY-MM-DD. In the above example, the DAT file was last updated on the 22nd April 2002 | ||
+ | |||
+ | == The SYSTEM Sections == | ||
+ | |||
+ | **NOTE:** This section can be auto-generated from within the GameBase Frontend. Just select " | ||
+ | |||
+ | < | ||
+ | [Commodore 64] | ||
+ | ¬CCS64 v2.0b DOS¬http:// | ||
+ | ¬CCS64 v2.0b Win32¬http:// | ||
+ | ¬CCS64 v1.09¬http:// | ||
+ | ¬WinVICE v1.6¬http:// | ||
+ | </ | ||
+ | |||
+ | There can be multiple SYSTEM sections in a DAT file. Each one contains the emulator definitions for that system. The name of the section (between the [] characters) is the name of the system. Each emulator definition is split into fields by the ¬ character. An emulator definition line must begin and end with the ¬ character. The wizard, when it starts, lets the user pick which system that they would like to setup emulators for. | ||
+ | |||
+ | The format of an emulator definition line is as follows: - | ||
+ | |||
+ | < | ||
+ | ¬NAME¬URL¬[COMMENT]¬FILENAME¬CRC32¬FILETYPES¬USESHORT¬SCRIPTFILE¬[ASSOCIATED-FILE¬*] | ||
+ | </ | ||
+ | |||
+ | **NAME** | ||
+ | Required. This is the name of the emulator. It is the unique name that GEMUS uses to identify the emulator. When the wizard scans through the emulator definitions, | ||
+ | |||
+ | **URL** | ||
+ | Required. This is the URL of the Emulator' | ||
+ | |||
+ | **[COMMENT]** | ||
+ | Optional. This field can contain any information you want about the emulator. This should be used for such info as specific instructions to running games with this emulator. Good examples of use are: "The script for this emulator only works with the registered version of the emulator", | ||
+ | |||
+ | **FILENAME** | ||
+ | Required. This is the actual filename (without a path) of the file used to run the emulator. The wizard uses this (along with the CRC32 field) when scanning for the emulator on your computer. | ||
+ | |||
+ | **CRC32** | ||
+ | Required. This is the CRC32 checksum of the file used to run the emulator. The wizard uses this (along with the FILENAME field) when scanning for the emulator on your computer. You can specify multiple CRC32 values in one definition by separating them with the pipe ( | ) character (for example ¬A719C6EB|B729DEEB|24E5F221¬). If you specify multiple CRC32 values, you should put them in preference order since the wizard' | ||
+ | |||
+ | **FILETYPES** | ||
+ | Required. This is a list of filetypes that the emulator supports, delimited with the semi-colon character. For example ¬D64; | ||
+ | |||
+ | **USESHORT** | ||
+ | Required. This field specifies whether the emulator uses short filenames when running games via command line. This must be one of two values... ¬Y¬ (uses short filenames) or ¬N¬ (doesn' | ||
+ | |||
+ | **SCRIPTFILE** | ||
+ | Required. This is the filename (without a path) of the emulator' | ||
+ | |||
+ | **[ASSOCIATED-FILE¬*]** | ||
+ | Optional. There can be as many associated files as you wish in an emulator definition. They correspond to the associated files that the emulator' | ||
+ | |||
+ | The following example specifies 2 associated files, one which is assumed to be in the emulator' | ||
+ | |||
+ | < | ||
+ | ...¬settings.ini¬config\controls.ini¬ | ||
+ | </ | ||
+ | |||
gemus.dat_specification.txt · Last modified: 2023/10/04 14:15 by 127.0.0.1