Difference between revisions of "AppSignature"
From MSX Game Library
(→Author code name) |
|||
| Line 6: | Line 6: | ||
Application's signature is 4 bytes long and composed of: | Application's signature is 4 bytes long and composed of: | ||
| − | * <tt>AppCompany</tt>: 2 bytes for the | + | * <tt>AppCompany</tt>: 2 bytes for the creator ID ([[#Creator ID|reserve yours!]]), |
| − | * <tt>AppID</tt>: 2 bytes for the | + | * <tt>AppID</tt>: 2 bytes for the product ID (the numbering of the applications is up to each creator). |
| − | < | + | <syntaxhighlight lang="js"> |
| + | //-- Add application signature to binary data (boolean) | ||
AppSignature = true; | AppSignature = true; | ||
| Line 17: | Line 18: | ||
//-- Application ID. Can be 2 character string or 16-bits integer (0~65535) | //-- Application ID. Can be 2 character string or 16-bits integer (0~65535) | ||
AppID = 0; | AppID = 0; | ||
| − | </ | + | </syntaxhighlight> |
If 2-character string is recommended for creator code and integer for application number, in fact, both of those parameters can be any of: | If 2-character string is recommended for creator code and integer for application number, in fact, both of those parameters can be any of: | ||
Revision as of 02:36, 18 January 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 company (*). Can be 2 character string or 16-bits integer (0~65535) AppCompany = "GL"; //-- Application ID. Can be 2 character string or 16-bits integer (0~65535) AppID = 0;
If 2-character string is recommended for creator code and integer for application number, 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 start address +0010h (should be 4010h or 8010h),
- At Basic binary start address +0007h (should be 8007h),
- At DOS binary start address +0002h (should be 0102h).
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).
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) |
| "JP" | Johan de Punder | |
| "GH" | Reserved | |
| "GL" | ✔️ | MSXgl (samples) |
| "NB" | Nicola "8bit" | |
| "PP" | ✔️ | Pixel Phenix |
| "RC" | Reserved | |
| "RS" | ✔️ | RoboSoft |
| "TL" | Tele-Line | |
| "TT" | ✔️ | Thomas ‘Totta’ Lundgren |
| "YZ" | ✔️ | Konami (Game Master 2) |
| "WD" | Wim Dewijngaert | |
| "XX" | Reserved | |
| 0xFF?? | Reserved |
Note:
- Come on Discord to reserve your own author code name.
- Author code names 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 |
| "PP" | "CR" | Pixel Phenix | Crawlers |
| "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) |