From b899ee9a9c9a9ca9a1e9c6c6e60c1cc28d683e35 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Sat, 9 Sep 2017 18:32:11 +1000 Subject: [PATCH] Document the command-line interface for games with cartridge slots. --- docs/interface/higan-cli.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/interface/higan-cli.md b/docs/interface/higan-cli.md index 7baf681e..6ccd7436 100644 --- a/docs/interface/higan-cli.md +++ b/docs/interface/higan-cli.md @@ -1,7 +1,7 @@ # Synopsis -> higan [*\-\-fullscreen*] [*GAME*] +> higan [*\-\-fullscreen*] [*GAME* [*SUBGAME1* [*SUBGAME2*]]] # Description @@ -47,6 +47,37 @@ so load a game from the library and check the list before loading it from the command-line. +When `GAME` refers to a game with +a [Satellaview](../guides/import.md#satellaview-games) memory pak slot, +`SUBGAME1` should be +the path to a game folder or ROM file +representing the memory pak to insert into the slot. +If `SUBGAME1` is not supplied, +higan will prompt for one. +`SUBGAME2` is ignored. + +When `GAME` refers to +the [Super Game Boy](../guides/import.md#super-game-boy-games), +`SUBGAME1` should be +the path to a game folder or ROM file +representing a Game Boy game to insert into the slot. +If `SUBGAME1` is not supplied, +higan will prompt for one. +`SUBGAME2` is ignored. + +When `GAME` refers to +the [Sufami Turbo](../guides/import.md#sufami-turbo-games), +then `SUBGAME1` should be +the path to a game folder or ROM file +representing the mini-cartridge to be inserted into +slot A of the Sufami Turbo base cartridge, +and `SUBGAME2` is the same thing for slot B. +higan will prompt for +any mini-cartridges not supplied on the command-line. + +When `GAME` refers to any other game, +both `SUBGAME1` and `SUBGAME2` are ignored. + # Examples Play a previously-imported copy of Super Mario World