From f0cf1df4afd9076154be408377582b17100e6219 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Sat, 12 Aug 2017 23:41:58 +1000 Subject: [PATCH] Document higan's region-selection features. --- docs/interface/higan-cli.md | 24 +++++++++++++++++++----- docs/interface/higan.md | 15 +++++++++++++-- 2 files changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/interface/higan-cli.md b/docs/interface/higan-cli.md index 15d615c2..bafbff3c 100644 --- a/docs/interface/higan-cli.md +++ b/docs/interface/higan-cli.md @@ -5,11 +5,6 @@ # Description -TODO: Put `NTSC-J|`, `NTSC-U|` or `PAL|` -at the beginning of the path -to force a region -for consoles where it can't be detected. - When launched with `--fullscreen`, higan will automatically enter full-screen mode when it starts. @@ -30,6 +25,18 @@ it will be imported into a game folder in [the Game Library](../concepts/game-library.md), and then loaded from there when higan starts. +When loading a game from the Game Library +via higan's GUI, +you can force higan to emulate a particular regional variant +of the relevant console by +choosing a region code from the drop-down list +in the lower-right of the filesystem browser. +To achieve the same effect from the command-line, +`PATH` should be set to the region code used in the GUI, +followed by a vertical bar (`|`), +followed by actual filesystem path +to the game folder or ROM file to load. + # Examples Play a previously-imported copy of Super Mario World @@ -38,3 +45,10 @@ in full-screen (assuming Linux defaults): ```sh higan --fullscreen ~/Emulation/"Super Famicom"/"Super Mario World.sfc" ``` + +Play a previously-imported copy of Sonic the Hedgehog 3, +forcing higan to emulate a Japanese Mega Drive: + +```sh +higan "NTSC-J|$HOME/Emulation/Mega Drive/Sonic the Hedgehog 3.md" +``` diff --git a/docs/interface/higan.md b/docs/interface/higan.md index cba77c19..fdef2609 100644 --- a/docs/interface/higan.md +++ b/docs/interface/higan.md @@ -27,6 +27,19 @@ and click the Open button, or just double-click the game, and it will begin playing as though you'd just turned on the console. +**Note:** +Sometimes +the NTSC and PAL variants of a particular console +behave differently, +or the Japanese and American variants. +When opening a game from the Game Library, +a drop-down list in the bottom-right of the window +allows you to choose which regional variation +of the console it should emulate. +For most consoles, +higan can reliably guess which variant to use, +and the list defaults to "Auto". + To add a new game to your library, choose "Load ROM File ..." from the Library menu. A [filesystem browser](#the-filesystem-browser) will appear, @@ -38,8 +51,6 @@ if the archive contains a single ROM image. **Note:** Some games require extra steps to import correctly; see [the Game Library](#the-game-library) for details. -TODO: Mention the region-picker. - To add many games at once, run icarus, or choose "Import ROM Files ..." from the Library menu