As of higan v104r07, higan no longer imports separate firmware files.

icarus now requires games and firmware to be combined into a single file,
so we must describe how to achieve that.
This commit is contained in:
Tim Allen 2017-08-31 17:05:47 +10:00
parent 96c45420d1
commit b47488ab09
1 changed files with 33 additions and 17 deletions

View File

@ -81,14 +81,31 @@ copies of the relevant firmware data
yourself. yourself.
To import a game that requires co-processor firmware, To import a game that requires co-processor firmware,
you must put a copy of the required firmware files you must first combine the game data and the firmware into a single file.
beside the game you want to import.
For example, For example,
if you want to import *Mega Man X2* for the Super Famicom, let's say you want to import *Super Bases Loaded 2* for the Super Famicom,
which is stored in the file `mmx2.sfc`, which is stored in the file `sbl2.sfc`
the file `cx4.data.rom` and requires firmware for the DSP1 co-processor
must be placed in the same folder stored in `dsp1.program.rom` and `dsp1.data.rom`.
for the import to succeed. On Windows,
you can combine them from the command-line like this:
```dos
copy /b sbl2.sfc + dsp1.program.rom + dsp1.data.rom
```
On Linux,
the equivalent command-line syntax is:
```bash
cat dsp1.program.rom dsp1.data.rom >> sbl2.sfc
```
(note the use of `>>` to append rather than `>` to overwrite)
**Note:**
For co-processor chips with multiple firmware files,
you must put the "program" file before the "data" file.
Wikipedia [lists which Super Famicom games use which co-processors][wpec], Wikipedia [lists which Super Famicom games use which co-processors][wpec],
although not all co-processors require separate firmware. although not all co-processors require separate firmware.
@ -226,22 +243,20 @@ If you try to import a game
using the "Import ROM Files ..." option using the "Import ROM Files ..." option
in [the Library menu](../interface/higan.md#the-library-menu) in [the Library menu](../interface/higan.md#the-library-menu)
(or using icarus directly) (or using icarus directly)
but do not have the required firmware files but it does not include the correct firmware data,
in the correct place,
a window will appear saying a window will appear saying
"Import completed, but with 1 errors. View log?" "Import completed, but with 1 errors. View log?"
(or however many games were lacking the correct firmware). (or however many games were lacking the correct firmware).
If you press "Yes", If you press "Yes",
a new window will appear listing the games that couldn't be imported, a new window will appear listing the games that couldn't be imported,
and at least one firmware file that was missing or incorrect, like this: and what problem was detected:
> [smk.zip] firmware (dsp1b.program.rom) missing or invalid > [sbl2.sfc] ROM image is missing DSP1 firmware data
If you try to import a game If you try to import a game
using the "Load ROM File ..." option using the "Load ROM File ..." option
in [the Library menu](../interface/higan.md#the-library-menu) in [the Library menu](../interface/higan.md#the-library-menu)
but do not have the required firmware files but it does not include the correct firmware data,
in the correct place,
nothing will happen, nothing will happen,
and higan will just sit there and higan will just sit there
with "No cartridge loaded" in with "No cartridge loaded" in
@ -430,10 +445,11 @@ so it needs a boot ROM:
</table> </table>
To import the SGB base cartridge, To import the SGB base cartridge,
you must copy the required firmware file you must first combine the base cartridge data
into the same folder as the base cartridge. and the boot ROM into a single file,
Then you may import it just like just like
[a regular game](#regular-games). [games with co-processor firmware](#games-with-co-processor-firmware).
Then you may import it like [a regular game](#regular-games).
To play a Game Boy game in Super Game Boy mode, To play a Game Boy game in Super Game Boy mode,
load the Super Game Boy cartridge like any other game. load the Super Game Boy cartridge like any other game.