Starting to fix broken links in the documentation.

Also, moved the "you should install the GBA BIOS" advice from the
install pages (where I doubt anybody would see it) to the "importing and
playing" guide, which I figure people are more likely to stumble across.
The actually instructions are still in `install/general.md` for lack of
anywhere more appropriate.
This commit is contained in:
Tim Allen 2017-08-21 23:29:53 +10:00
parent 281b22e1c0
commit 9be4e59a05
6 changed files with 34 additions and 44 deletions

View File

@ -15,7 +15,7 @@ so you can find the one that works best for you.
To see what drivers you're currently using,
or to choose different ones,
go to
[the Advanced tab](../interface/higan-config.md#Advanced)
[the Advanced tab](../interface/higan-config.md#advanced)
of the Settings window.
Here are the most notable drivers

View File

@ -558,3 +558,21 @@ Then you can import and play the patched game just like
[rhdn]: http://www.romhacking.net/
Game Boy Advance games
----------------------
Before you can play Game Boy Advance games,
you must provide a copy of the Game Boy Advance BIOS.
Unlike game-specific firmware,
the GBA BIOS was part of the console,
not the cartridge,
so it must be installed
[into higan](../install/general.md).
Once the GBA BIOS is installed,
GBA games can be imported and played just like
[any other games](#regular-games).
Note that some GBA games
have trouble with
[in-game saves](../notes#in-game-saves-and-the-game-boy-advance).

View File

@ -107,12 +107,6 @@ You will need to log out and log back in
for changes to `~/.profile` or `~/.bash_profile`
to take effect.
Before you can actually play games,
you'll need to [import them](#the-game-library)
and [configure higan](#configuring-higan).
If you want to play Game Boy Advance games,
you will need [a GBA BIOS](#installing-the-gba-bios).
Uninstalling a compiled build on Linux
--------------------------------------

View File

@ -20,12 +20,6 @@ You may put that folder wherever you like.
To run higan, open the `higan.exe` file.
Before you can actually play games,
you'll need to [import them](#the-game-library)
and [configure higan](#configuring-higan).
If you want to play Game Boy Advance games,
you will need [a GBA BIOS](#installing-the-gba-bios).
Uninstalling an official release on Windows
-------------------------------------------
@ -147,12 +141,6 @@ above.
[instwin]: #installing-an-official-release-on-windows
Before you can actually play games,
you'll need to [import them](#the-game-library)
and [configure higan](#configuring-higan).
If you want to play Game Boy Advance games,
you will need [a GBA BIOS](#installing-the-gba-bios).
Uninstalling a compiled build on Windows
----------------------------------------

View File

@ -58,7 +58,7 @@ or when higan exits.
higan stores the known cheats for a particular game
in `higan/cheats.bml`
inside the corresponding game folder
in [the Game Library](#the-game-library).
in [the Game Library](../concepts/game-library.md).
If your copy of higan includes a cheat database
(a file named `cheats.bml`
@ -95,7 +95,7 @@ For more information on Manager states,
quick states,
saved games
and how they compare,
see [Save States](#save-states).
see [Save States](../concepts/save-states.md).
To create a new manager state,
or to replace an existing one,
@ -123,23 +123,10 @@ click "Reset" in the bottom-right corner.
The Manifest Viewer
-------------------
As mentioned in
[Why game folders?](#why-game-folders),
a game cartridge contains
more than just the raw data of the game.
As described in
[Game Manifests](../concepts/manifests.md),
higan uses a "manifest" to
describe how the various parts of a game cartridge
are wired up together,
and the Manifest Viewer lets you examine
the configuration higan is using for the currently-running game.
For some games,
an actual cartridge has been taken apart and carefully examined
and its configuration has been recorded in icarus' database,
so the manifest icarus produces
is guaranteed accurate.
For games that do not exist in icarus' database,
icarus will make a reasonable guess.
This is enough to get the game running,
but does not necessarily reflect the original cartridge.

View File

@ -1,8 +1,8 @@
When launching icarus,
directly or by picking "Import ROM Files ..."
from higan's [Library menu](#the-library-menu),
from higan's [Library menu](higan.md#the-library-menu),
the main icarus window appears.
This is [a filesystem browser](#the-filesystem-browser),
This is [a filesystem browser](common.md#the-filesystem-browser),
with customisations:
- The filesystem browser only lists
@ -22,11 +22,11 @@ Pressing "Import ..." in the bottom-right
will close the filesystem browser
then try to import all the files
whose check-boxes are ticked
into [the Game Library](#the-game-library).
into [the Game Library][gamelib].
icarus displays a progress dialog during the import process.
**Note:** Some games require extra steps to import correctly;
see [the Game Library](#the-game-library) for details.
see [the Game Library][gamelib] for details.
The icarus Settings dialog
--------------------------
@ -35,20 +35,20 @@ The icarus Settings dialog contains the following settings:
- **Library Location** determines
where icarus puts the games it imports.
See [Moving the Game Library](#moving-the-game-library)
See [Moving the Game Library][movgamelib]
for details.
- **Create Manifests** causes icarus
to write out a manifest file describing
each imported game
to that game's [game folder](#whats-in-a-game-folder).
to that game's [game folder](../concepts/game-folders.md).
This means that higan doesn't have to regenerate
the manifest each time an imported game is loaded,
but it means that a future version of higan
with an incompatible manifest format
may be unable to play these games.
Note that higan also has an "Ignore Manifests" option
in the Advanced tab of
[its Configuration dialog](#the-configuration-dialog).
in its
[Advanced settings](../interface/higan-config#advanced).
- **Use Database** causes icarus to use manifest information
from its database of known-good manifests,
if it's importing a game it recognises.
@ -58,3 +58,6 @@ The icarus Settings dialog contains the following settings:
This option is still relevant when "Create Manifests" is unticked:
higan uses icarus to generate a manifest when a game is loaded,
not just at import-time.
[gamelib]: ../concepts/game-library.md
[movgamelib]: ../concepts/game-library.md#moving-the-game-library