A78 Header Specification - Revision history

MSaarna at 03:11, 21 January 2024

2024-01-21T03:11:36Z

MSaarna at 03:10, 21 January 2024

2024-01-21T03:10:32Z

MSaarna at 02:45, 21 January 2024

2024-01-21T02:45:09Z

MSaarna at 21:26, 20 January 2024

2024-01-20T21:26:59Z

MSaarna at 20:05, 20 January 2024

2024-01-20T20:05:00Z

Trebor: /* Adding Or Modifying an A78 Header on an Existing ROM */

2022-05-28T02:53:06Z

‎Adding Or Modifying an A78 Header on an Existing ROM

Trebor: /* Adding Or Modifying an A78 Header on an Existing ROM */

2022-05-28T02:36:16Z

‎Adding Or Modifying an A78 Header on an Existing ROM

MSaarna at 15:52, 29 March 2022

2022-03-29T15:52:03Z

MSaarna at 15:49, 29 March 2022

2022-03-29T15:49:05Z

MSaarna at 15:48, 29 March 2022

2022-03-29T15:48:00Z

@@ Line 116: / Line 116: @@
 = Souper
-v4+ mapper options details:
+v4+ mapper options details: (The meaning of this field varies depending on the mapper chosen.)
     Linear

@@ Line 64: / Line 64: @@
 <div style="clear:both;"></div>
-cart type word details::
+cart type details::
-    bit 0     = pokey at $4000
+    bit 0  : pokey at $4000
-    bit 1     = supergame bank switched
+    bit 1  : supergame bank switched
-    bit 2     = supergame ram at $4000
+    bit 2  : supergame ram at $4000
-    bit 3     = rom at $4000
+    bit 3  : rom at $4000
-    bit 4     = bank 6 at $4000
+    bit 4  : bank 6 at $4000
-    bit 5     = banked ram
+    bit 5  : banked ram
-    bit 6     = pokey at $450
+    bit 6  : pokey at $450
-    bit 7     = mirror ram at $4000
+    bit 7  : mirror ram at $4000
-    bit 8     = activision banking
+    bit 8  : activision banking
-    bit 9     = absolute banking
+    bit 9  : absolute banking
-    bit 10    = pokey at $440
+    bit 10 : pokey at $440
-    bit 11    = ym2151 at $460/$461
+    bit 11 : ym2151 at $460/$461
-    bit 12    = souper
+    bit 12 : souper
-    bit 13    = banksets
+    bit 13 : banksets
-    bit 14    = halt banked ram
+    bit 14 : halt banked ram
-    bit 15    = pokey@800
+    bit 15 : pokey@800
-controller type byte details:
+controller type details:
 = none
 = 7800 joystick
@@ Line 98: / Line 98: @@
 TV type details:
-    bit 0 = 0:NTSC, 1:PAL
+    bit 0 : 0=NTSC, 1=PAL
-    bit 1 = 0:component, 1:composite
+    bit 1 : 0=component, 1=composite
-    bit 2 = 0:single region, 1:multi-region
+    bit 2 : 0=single region, 1=multi-region
 save device details:
-    bit 0    = HSC
+    bit 0 : HSC
-    bit 1    = SaveKey/AtariVox
+    bit 1 : SaveKey/AtariVox
-expansion module:
+v4+ mapper details:
-    bit 0    = XM
+= Linear
 == A78 Header Version Notes==
-The current header version stands at 4, but not all flash carts and emulators are capable of reading v4 specific fields, nor do all games have them.
+The current header version stands at 4, but not all flash carts and emulators are capable of reading v4 specific fields, nor do all games have v4 headers.
 If game authors choose not to use/support any v4 features, then the header version should be kept at "3". If a v4 header is used, it's encouraged that v3 headers are also used where possible, to allow for maximal compatibility with emulators and flash carts.

@@ Line 95: / Line 95: @@
 = AtariVox/SaveKey
 = SNES2Atari
 TV type details:
     bit 0 = 0:NTSC, 1:PAL
     bit 1 = 0:component, 1:composite
 save device details:

@@ Line 109: / Line 109: @@
-==v3 A78 Header Version Notes==
+== A78 Header Version Notes==
-The current header version stands at 3. There were fields in previous versions that were ambiguously defined, but are now spelled out. To be v3 compliant, a header must:
+The current header version stands at 4, but not all flash carts and emulators are capable of reading v4 specific fields, nor do all games have them.
-* Have a zero-terminated Cart Title field. Any post-title padding should be zeros, rather than spaces.
+If game authors choose not to use/support any v4 features, then the header version should be kept at "3". If a v4 header is used, it's encouraged that v3 headers are also used where possible, to allow for maximal compatibility with emulators and flash carts.
-Previous versions of the header were ambiguous as to the TV Type byte being an index or bitfield. V3 headers define TV type as a bitfield, and have included a bit to indicate whether composite display artifacts are appropriate for the game.
+If an emulator or flash cart are v4 compatible, and they receive a rom with a v4 header, the v4 fields should take precedence over anything encoded in the equivalent v3 fields.

@@ Line 9: / Line 9: @@
   {|  style="float:left;"
    |+A78 Header Fields
-  ! 0000 || style="background-color: #fc8;" | 03 || style="background-color: #fcf;" | 41 || style="background-color: #fcf;" | 54 || style="background-color: #fcf;" | 41 || style="background-color: #fcf;" | 52 || style="background-color: #fcf;" | 49 || style="background-color: #fcf;" | 37 || style="background-color: #fcf;" | 38 || style="background-color: #fcf;" | 30 || style="background-color: #fcf;" | 30 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || <tt>.ATARI7800......</tt>
+  ! 0000 || style="background-color: #fc8;" | 04 || style="background-color: #fcf;" | 41 || style="background-color: #fcf;" | 54 || style="background-color: #fcf;" | 41 || style="background-color: #fcf;" | 52 || style="background-color: #fcf;" | 49 || style="background-color: #fcf;" | 37 || style="background-color: #fcf;" | 38 || style="background-color: #fcf;" | 30 || style="background-color: #fcf;" | 30 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || style="background-color: #fcf;" | 00 || <tt>.ATARI7800......</tt>
   |-
   ! 0010 || style="background-color: #fcf;" | 00 || style="background-color: #acf;" | 43 || style="background-color: #acf;" | 6f || style="background-color: #acf;" | 6d || style="background-color: #acf;" | 6d || style="background-color: #acf;" | 61 || style="background-color: #acf;" | 6e || style="background-color: #acf;" | 64 || style="background-color: #acf;" | 6f || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || style="background-color: #acf;" | 00 || <tt>.Commando.......</tt>
@@ Line 17: / Line 17: @@
   ! 0030 || style="background-color: #acf;" | 00 || style="background-color: #faa;" | 00 || style="background-color: #faa;" | 02 || style="background-color: #faa;" | 00 || style="background-color: #faa;" | 00 || style="background-color: #ffb;" | 00 || style="background-color: #ffb;" | 03 || style="background-color: #8fc;" | 01 || style="background-color: #caa;" | 01 || style="background-color: #8c8;" | 00 || style="background-color: #c8c;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #aac;" | 00 || <tt>................</tt>
   |-
-  ! 0040 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || <tt>................</tt>
+  ! 0040 || style="background-color: #966;" | 01 || style="background-color: #696;" | 00 || style="background-color: #669;" | 00 || style="background-color: #669;" | 05 || style="background-color: #996;" | 00 || style="background-color: #996;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || <tt>................</tt>
   |-
   ! 0050 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || style="background-color: #eee;" | 00 || <tt>................</tt>
@@ Line 51: / Line 51: @@
   |-
   | style="background-color: #aac;" | &nbsp; || slot passthrough device || 1 byte || 63 / 0x3F
   |-
   | style="background-color: #cf8;" | &nbsp; || header end magic-text || 28 bytes || 100 / 0x64

@@ Line 118: / Line 118: @@
 <pre>
      embedded game name : Commando
      rom size           : 131072

@@ Line 118: / Line 118: @@
 <pre>
-A78 Header Info
+     embedded game name : Commando
      rom size           : 131072
      cart format        : Pokey@4000 SuperGame
-     controller 1       : Joystick
+     controllers        : 7800joy1 7800joy2
-    controller 2       : None
+     save peripheral    : none
-     save peripheral    : None
+     xm/xboard          : not enabled
      tv format          : NTSC
-Commands: "save"           Save the A78 file and exit.
+Commands: "save"  [name]   Save the A78 file and exit.
            "set [option]"   Set one of the options.
            "unset [option]" Unset one of the options.
@@ Line 135: / Line 133: @@
            "exit"           Exit the utility. Unsaved changes will be lost.
-Options:  rom@4000 bank6@4000 pokey@450 pokey@4000 supergame supergameram
+Options:  rom@4000 bank6@4000 pokey@440 pokey@450 pokey@800 pokey@4000
-          supergamebankram absolute activision tvpal tvntsc savekey hsc xm
+   ram@4000 mram@4000 hram@4000 ym2151@460 supergame bankram
-          joystick1 joystick2 lightgun1 lightgun2
+   absolute activision souper bankset tvpal tvntsc composite
+joy1 7800joy2 lightgun1 lightgun2 paddle1 paddle2
 > exit
 </pre>
 ==Adding an A78 Header to Source Code==

@@ Line 50: / Line 50: @@
   | style="background-color: #eee;" | &nbsp; || reserved || &nbsp; || &nbsp;
   |-
-  | style="background-color: #aac;" | &nbsp; || expansion module || 1 byte || 63 / 0x3F
+  | style="background-color: #aac;" | &nbsp; || slot passthrough device || 1 byte || 63 / 0x3F
   |-
   | style="background-color: #cf8;" | &nbsp; || header end magic-text || 28 bytes || 100 / 0x64

@@ Line 85: / Line 85: @@
 = ST mouse
 = Amiga mouse
 TV type details: