Update some import instructions.

This commit is contained in:
Tim Allen
2018-05-17 14:32:25 +10:00
parent d537eaa0fd
commit c24eb6e592

View File

@@ -1,7 +1,6 @@
Before it can load a game, Before it can load a game,
higan requires that all the game's data higan requires that all the game's data
be stored correctly in be stored correctly in the [Game Library].
[the Game Library](../concepts/game-library.md).
For [regular games](#regular-games) For [regular games](#regular-games)
this is simple, this is simple,
but some games require special treatment, but some games require special treatment,
@@ -11,7 +10,7 @@ unusual hardware.
Regular games Regular games
------------- -------------
higan's importing tool, icarus, can import games higan's importing tool, [icarus], can import games
in the most commonly-used formats in the most commonly-used formats
for each supported console, for each supported console,
and also those same formats inside `.zip` files and also those same formats inside `.zip` files
@@ -20,23 +19,19 @@ More advanced compression formats
like RAR or 7-zip are not supported. like RAR or 7-zip are not supported.
To import a game, To import a game,
open [the Library menu](../interface/higan.md#the-library-menu), open the [Systems menu],
choose "Load ROM File ..." choose "Load ROM File ..."
to open [a filesystem browser](../interface/common.md#the-filesystem-browser), to open a [filesystem browser],
choose the ROM file of the game you want to play, choose the ROM file of the game you want to play,
and it will be imported into the library and start playing. and it will be imported into the library and start playing.
**Note:** **Note:**
If you want to import many games, If you want to import many games,
run icarus directly. run icarus directly.
See [the icarus documentation](../interface/icarus.md) for details. See [icarus] documentation for details.
To play a game for a particular console from your library, To play a game for a particular console from your library,
open the Library menu, open the Systems menu,
pick the console manufacturer sub-menu
(Nintendo for the Super Famicom,
Bandai for the WonderSwan,
etc.)
then choose the appropriate console menu item. then choose the appropriate console menu item.
A filesystem browser will appear A filesystem browser will appear
listing all the games in the library listing all the games in the library
@@ -79,11 +74,11 @@ yourself.
To import a game that requires co-processor firmware, To import a game that requires co-processor firmware,
the easiest approach is to drop the firmware files into the easiest approach is to drop the firmware files into
icarus' `Firmware` directory icarus' `firmware` directory
before importing the game. before importing the game.
The directory should be beside the icarus executable, The directory should be beside the icarus executable,
or it can be `%LOCALAPPDATA%\icarus\Firmware` (on Windows) or it can be `%LOCALAPPDATA%\icarus\firmware` (on Windows)
or `~/.local/share/icarus/Firmware/` (on Linux). or `~/.local/share/icarus/firmware/` (on Linux).
When icarus imports a game that requires firmware When icarus imports a game that requires firmware
it tries to guess which firmware that game needs, it tries to guess which firmware that game needs,
@@ -276,7 +271,7 @@ you can play it just like any [regular game](#regular-games).
Satellaview games Satellaview games
----------------- -----------------
The [Satellaview][wpbsx] The [Satellaview]
was a satellite modem peripheral was a satellite modem peripheral
released for the Super Famicom in Japan. released for the Super Famicom in Japan.
As well as the actual modem As well as the actual modem
@@ -290,7 +285,7 @@ This control cartridge was called
which in English is which in English is
*BS-X The Story of The Town Whose Name Was Stolen*. *BS-X The Story of The Town Whose Name Was Stolen*.
[wpbsx]: https://en.wikipedia.org/wiki/Satellaview [Satellaview]: https://en.wikipedia.org/wiki/Satellaview
The control cartridge had a slot that accepted The control cartridge had a slot that accepted
re-writable "memory paks", re-writable "memory paks",
@@ -309,8 +304,16 @@ containing extra content for specific games.
Importing a game that has a slot for a memory pak Importing a game that has a slot for a memory pak
is just like [importing a regular game](#regular-games). is just like [importing a regular game](#regular-games).
Importing a memory pak is like importing a regular game, To import a memory pak,
but the name of the memory pak file *must* end in `.bs` you should use [icarus].
You can use the "Load ROM File ..." menu item
in the [Systems menu],
but higan cannot actually load a memory pak directly,
so once you choose a file to load
it looks like nothing has happened.
When importing a memory pak,
the name of the memory pak file *must* end in `.bs`
(if it's in a `.zip` file, (if it's in a `.zip` file,
that's OK, that's OK,
but the name *inside* the `.zip` file but the name *inside* the `.zip` file
@@ -373,8 +376,16 @@ from a game in slot B.
Importing the Sufami Turbo cartridge Importing the Sufami Turbo cartridge
is just like [importing a regular game](#regular-games). is just like [importing a regular game](#regular-games).
Importing a mini-cartridge is like importing a regular game, To import a mini-cartridge,
but the name of the mini-cartridge file *must* end in `.st` you should use [icarus].
You can use the "Load ROM File ..." menu item
in the [Systems menu],
but higan cannot actually load a mini-cartridge directly,
so once you choose a file to load
it looks like nothing has happened.
When importing a mini-cartridge,
the name of the file *must* end in `.st`
(if it's in a `.zip` file, (if it's in a `.zip` file,
that's OK, that's OK,
but the name *inside* the `.zip` file but the name *inside* the `.zip` file
@@ -732,3 +743,8 @@ Select *PowerFest '94* from the list
and click the Open button, and click the Open button,
or just double-click the game, or just double-click the game,
and it will begin playing. and it will begin playing.
[filesystem browser]: ../interface/common.md#the-filesystem-browser
[Game Library]: ../concepts/game-library.md
[icarus]: ../interface/icarus.md
[Systems menu]: ../interface/higan.md#the-systems-menu