IPL file: Difference between revisions

From NeoGeo Development Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
"Initial Program Load" ?
The IPL.TXT file must be stored in the root of a game CD. IPL stands for "Initial Program Load". It indicates which are the first files to load by the [[system ROM]] at startup.


IPL.TXT is an unique text file describing the initial files to load in a NeoGeo CD game. Read by the BIOS on startup along with the ABS, BIB and CPY files. See [[Game CD structure]].
See [[Game CD structure]].


If a file in the list is missing in the CD root, the "DISCO I/O ERROR 0000" is given.
A missing file causes the [[DISC I/O ERROR]] 0000.


==Format==
There must '''not be more than 32 files''' to load.
Filename (in 8.3 format?), Bank, Offset, CRLF (0x0D, 0x0A)


Some IPLs end with a 0x1A byte ?
=Contents=
 
The file's contents must follow a precise format for each line:
 
<pre>
File name in 8.3 format, Bank, Offset, CR LF
</pre>
 
* File names can be in lower or upper case
* File names must be in 8.3 format (max 8 characters name, max 3 characters extension)
* The bank number must be a single digit
* The offset can be any size from 1 to 8 digits
* The line must end with carriage-return and line-feed (CR, LF: 0x0D, 0x0A)
 
The whole file '''must end with character 0x1A'''.
 
=Example=
 
From [[Art_of_Fighting_3_-_The_Path_of_the_Warrior|Art of Fighting 3]], with hex contents to show character values:
 
<pre>
FIX_CD.FIX,0,00          46 49 58 5F 43 44 2E 46 49 58 2C 30 2C 30 30 0D 0A
PROG_CD.PRG,0,0          50 52 4F 47 5F 43 44 2E 50 52 47 2C 30 2C 30 0D 0A
PROG_CDX.PRG,0,058000    50 52 4F 47 5F 43 44 58 2E 50 52 47 2C 30 2C 30 35 38 30 30 30 0D 0A
FIX_DATA.PRG,0,0FD000    46 49 58 5F 44 41 54 41 2E 50 52 47 2C 30 2C 30 46 44 30 30 30 0D 0A
CNV_NM.PRG,0,0C0000      43 4E 56 5F 4E 4D 2E 50 52 47 2C 30 2C 30 43 30 30 30 30 0D 0A
HITMSG.PRG,0,170000      48 49 54 4D 53 47 2E 50 52 47 2C 30 2C 31 37 30 30 30 30 0D 0A
OBJACTLK.PRG,0,130000    4F 42 4A 41 43 54 4C 4B 2E 50 52 47 2C 30 2C 31 33 30 30 30 30 0D 0A
SSEL_CNV.PRG,0,15A000    53 53 45 4C 5F 43 4E 56 2E 50 52 47 2C 30 2C 31 35 41 30 30 30 0D 0A
SSEL_BAK.PRG,0,16F000    53 53 45 4C 5F 42 41 4B 2E 50 52 47 2C 30 2C 31 36 46 30 30 30 0D 0A
SSEL_SPR.PRG,0,19D000    53 53 45 4C 5F 53 50 52 2E 50 52 47 2C 30 2C 31 39 44 30 30 30 0D 0A
SND8V1CD.Z80,0,0        53 4E 44 38 56 31 43 44 2E 5A 38 30 2C 30 2C 30 0D 0A
JYOU.PCM,0,0            4A 59 4F 55 2E 50 43 4D 2C 30 2C 30 0D 0A
JYOU.PAT,0,0            4A 59 4F 55 2E 50 41 54 2C 30 2C 30 0D 0A
�                      1A
</pre>


[[Category:CD systems]]
[[Category:CD systems]]

Revision as of 07:00, 18 April 2017

The IPL.TXT file must be stored in the root of a game CD. IPL stands for "Initial Program Load". It indicates which are the first files to load by the system ROM at startup.

See Game CD structure.

A missing file causes the DISC I/O ERROR 0000.

There must not be more than 32 files to load.

Contents

The file's contents must follow a precise format for each line:

File name in 8.3 format, Bank, Offset, CR LF
  • File names can be in lower or upper case
  • File names must be in 8.3 format (max 8 characters name, max 3 characters extension)
  • The bank number must be a single digit
  • The offset can be any size from 1 to 8 digits
  • The line must end with carriage-return and line-feed (CR, LF: 0x0D, 0x0A)

The whole file must end with character 0x1A.

Example

From Art of Fighting 3, with hex contents to show character values:

FIX_CD.FIX,0,00          46 49 58 5F 43 44 2E 46 49 58 2C 30 2C 30 30 0D 0A
PROG_CD.PRG,0,0          50 52 4F 47 5F 43 44 2E 50 52 47 2C 30 2C 30 0D 0A
PROG_CDX.PRG,0,058000    50 52 4F 47 5F 43 44 58 2E 50 52 47 2C 30 2C 30 35 38 30 30 30 0D 0A
FIX_DATA.PRG,0,0FD000    46 49 58 5F 44 41 54 41 2E 50 52 47 2C 30 2C 30 46 44 30 30 30 0D 0A
CNV_NM.PRG,0,0C0000      43 4E 56 5F 4E 4D 2E 50 52 47 2C 30 2C 30 43 30 30 30 30 0D 0A
HITMSG.PRG,0,170000      48 49 54 4D 53 47 2E 50 52 47 2C 30 2C 31 37 30 30 30 30 0D 0A
OBJACTLK.PRG,0,130000    4F 42 4A 41 43 54 4C 4B 2E 50 52 47 2C 30 2C 31 33 30 30 30 30 0D 0A
SSEL_CNV.PRG,0,15A000    53 53 45 4C 5F 43 4E 56 2E 50 52 47 2C 30 2C 31 35 41 30 30 30 0D 0A
SSEL_BAK.PRG,0,16F000    53 53 45 4C 5F 42 41 4B 2E 50 52 47 2C 30 2C 31 36 46 30 30 30 0D 0A
SSEL_SPR.PRG,0,19D000    53 53 45 4C 5F 53 50 52 2E 50 52 47 2C 30 2C 31 39 44 30 30 30 0D 0A
SND8V1CD.Z80,0,0         53 4E 44 38 56 31 43 44 2E 5A 38 30 2C 30 2C 30 0D 0A
JYOU.PCM,0,0             4A 59 4F 55 2E 50 43 4D 2C 30 2C 30 0D 0A
JYOU.PAT,0,0             4A 59 4F 55 2E 50 41 54 2C 30 2C 30 0D 0A
�                       1A