Difference between revisions of "AppSignature"
From MSX Game Library
(→Programming) |
|||
| (9 intermediate revisions by the same user not shown) | |||
| Line 41: | Line 41: | ||
<syntaxhighlight lang="c"> | <syntaxhighlight lang="c"> | ||
extern const u16 g_AppSignature[2]; | extern const u16 g_AppSignature[2]; | ||
| + | </syntaxhighlight><syntaxhighlight lang="c"> | ||
extern const u8 g_AppSignature[4]; | extern const u8 g_AppSignature[4]; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 64: | Line 65: | ||
| <tt>"EF"</tt> || ✔️ || Konami (''Pennant Race'' and ''Knightmare 3'') | | <tt>"EF"</tt> || ✔️ || Konami (''Pennant Race'' and ''Knightmare 3'') | ||
|- | |- | ||
| − | | <tt>"FD"</tt> || | + | | <tt>"FD"</tt> || ✔️ || FutureDisk |
| + | |- | ||
| + | | <tt>"FP"</tt> || || Fausto | ||
|- | |- | ||
| <tt>"JP"</tt> || || Johan de Punder | | <tt>"JP"</tt> || || Johan de Punder | ||
| Line 71: | Line 74: | ||
|- | |- | ||
| <tt>"GL"</tt> || ✔️ || MSXgl (samples) | | <tt>"GL"</tt> || ✔️ || MSXgl (samples) | ||
| + | |- | ||
| + | | <tt>"MO"</tt> || || MO5.com | ||
|- | |- | ||
| <tt>"NB"</tt> || || Nicola "8bit" | | <tt>"NB"</tt> || || Nicola "8bit" | ||
|- | |- | ||
| − | | <tt>"PH"</tt> || | + | | <tt>"PH"</tt> || ✔️ || Pixel Phenix |
|- | |- | ||
| <tt>"PP"</tt> || ✔️ || Pixel Phenix (obsolete) | | <tt>"PP"</tt> || ✔️ || Pixel Phenix (obsolete) | ||
|- | |- | ||
| <tt>"RC"</tt> || || ''Reserved'' | | <tt>"RC"</tt> || || ''Reserved'' | ||
| + | |- | ||
| + | | <tt>"RG"</tt> || || Rutagames (Diogo Patrão) | ||
|- | |- | ||
| <tt>"RO"</tt> || || ''Reserved for [[ROM type signature]]'' | | <tt>"RO"</tt> || || ''Reserved for [[ROM type signature]]'' | ||
| Line 98: | Line 105: | ||
Note: | Note: | ||
| − | * Come on [https://discord.gg/pMeadGfv8E Discord] to reserve your own creator ID. | + | * Come on the MSXgl's [https://discord.gg/pMeadGfv8E Discord Server] to reserve your own creator ID. |
* Creator ID are only definitively assigned when an application is published with this code. | * Creator ID are only definitively assigned when an application is published with this code. | ||
| Line 110: | Line 117: | ||
|- | |- | ||
| <tt>"CC"</tt> || <tt>"PC"</tt> || Casper Croes || ''Phenix Corrupta'' | | <tt>"CC"</tt> || <tt>"PC"</tt> || Casper Croes || ''Phenix Corrupta'' | ||
| + | |- | ||
| + | | <tt>"FS"</tt> || <tt>"SP"</tt> || Fausto Pracek || ''Sam.Pr'' | ||
|- | |- | ||
| <tt>"PP"</tt> || <tt>"CR"</tt> || Pixel Phenix || ''Crawlers (MSXdev'23)'' | | <tt>"PP"</tt> || <tt>"CR"</tt> || Pixel Phenix || ''Crawlers (MSXdev'23)'' | ||
|- | |- | ||
| <tt>"PH"</tt> || <tt>001</tt> || Pixel Phenix || ''Crawlers (cartridge)'' | | <tt>"PH"</tt> || <tt>001</tt> || Pixel Phenix || ''Crawlers (cartridge)'' | ||
| + | |- | ||
| + | | <tt>"PH"</tt> || <tt>002</tt> || Pixel Phenix || ''Final Smash'' | ||
|- | |- | ||
| <tt>"RS"</tt> || <tt>"PE"</tt> || RoboSoft || ''Attack of the Petscii Robots'' | | <tt>"RS"</tt> || <tt>"PE"</tt> || RoboSoft || ''Attack of the Petscii Robots'' | ||
Latest revision as of 23:21, 9 November 2024
This Build tool option allow to add an application signature to binary data (right after the header).
The MSXgl signature format is directly inspired by the meta-data used by Konami to identify their cartridges and add cross-games options.
Definition
Application's signature is 4 bytes long and composed of:
- AppCompany: 2 bytes for the creator ID (reserve yours!),
- AppID: 2 bytes for the product ID (the numbering of the applications is up to each creator).
//-- Add application signature to binary data (boolean) AppSignature = true; //-- Application creator ID. Can be 2 character string or 16-bits integer (0~65535) AppCompany = "GL"; //-- Application product ID. Can be 2 character string or 16-bits integer (0~65535) AppID = 0;
If 2-character string is recommended for creator ID and integer for product ID, in fact, both of those parameters can be any of:
- 2-character string ("MX", "a7" for example),
- 16-bits decimal unsigned number (12345 for example),
- 16-bits hexadecimal number starting with 0x (0x0750 for example).
For example, the header first 2 words of Konami's Penguin Adventure are "CD", 0x4307. "CD" is one of the signature used by Konami to mark there ROM (see next section) and 0x4307 show in binary viewer the number 0743... the serial number of Penguin Adventure (RC743).
You can also add extra data using AppExtra option. WIP
Programming
If AppSignature is set to TRUE in Build tool configuration, then APPSIGN is defined in your C program.
Application signature is put just after the binary header:
- At ROM header address +0x0010 (should be 0x4010 or 0x8010),
- At Basic binary header address +0x0007 (should be 0x8007),
- At DOS binary start address +0x0002 (should be 0x0102).
Define an external variable as g_AppSignature if you need to access the data from your program. It can be defined in several ways depending on your needs. For example:
extern const u16 g_AppSignature[2];
extern const u8 g_AppSignature[4];
Keep in mind than MSX store data as Less significant byte first (Little endian).
Note: For ROM targets, if a ROM type signature is present at offset +0010h, then the application signature is placed just after (header +0x0018)
Creator ID
Some creators' ID are already reserved:
| ID | Rel | Creator's name |
|---|---|---|
| 0x00?? | Reserved | |
| "AB" | ✔️ | Konami (Boxing and Football) |
| "B5" | ✔️ | Bik5 (J. Bikker) |
| "CC" | ✔️ | Casper Croes |
| "CD" | ✔️ | Konami (many games) |
| "EF" | ✔️ | Konami (Pennant Race and Knightmare 3) |
| "FD" | ✔️ | FutureDisk |
| "FP" | Fausto | |
| "JP" | Johan de Punder | |
| "GH" | Reserved | |
| "GL" | ✔️ | MSXgl (samples) |
| "MO" | MO5.com | |
| "NB" | Nicola "8bit" | |
| "PH" | ✔️ | Pixel Phenix |
| "PP" | ✔️ | Pixel Phenix (obsolete) |
| "RC" | Reserved | |
| "RG" | Rutagames (Diogo Patrão) | |
| "RO" | Reserved for ROM type signature | |
| "RS" | ✔️ | RoboSoft |
| "TL" | Tele-Line | |
| "TT" | ✔️ | Thomas ‘Totta’ Lundgren |
| "YZ" | ✔️ | Konami (Game Master 2) |
| "WD" | Wim Dewijngaert | |
| "XX" | Reserved | |
| 0xFF?? | Reserved |
Note:
- Come on the MSXgl's Discord Server to reserve your own creator ID.
- Creator ID are only definitively assigned when an application is published with this code.
Known signed applications
List of released applications that contain compatible signature.
| C | App | Author | Application |
|---|---|---|---|
| "B5" | "EM" | Bik5 (J. Bikker) | Eggy's Maze |
| "CC" | "PC" | Casper Croes | Phenix Corrupta |
| "FS" | "SP" | Fausto Pracek | Sam.Pr |
| "PP" | "CR" | Pixel Phenix | Crawlers (MSXdev'23) |
| "PH" | 001 | Pixel Phenix | Crawlers (cartridge) |
| "PH" | 002 | Pixel Phenix | Final Smash |
| "RS" | "PE" | RoboSoft | Attack of the Petscii Robots |
| "TT" | "TP" | Thomas ‘Totta’ Lundgren | Tetpuz |
| "GL" | ? | MSXgl | (samples) |
| "AB" | ? | Konami | (Boxing and Football) |
| "CD" | ? | Konami | (many games) |
| "EF" | ? | Konami | (Pennant Race and Knightmare 3) |
| "YZ" | ? | Konami | (Game Master 2) |