ShuriZma
/
bsnes
mirror of https://github.com/bsnes-emu/bsnes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bsnes/docs/interface/icarus.md

101 lines
3.2 KiB
Markdown
Raw Normal View History

Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
icarus is a separate tool
bundled with higan
that allows you to bulk-import ROM files
into higan's [game library].
More cleanups and revision.
2017-08-24 08:34:37 +00:00
Bulk importing ROM files
------------------------
icarus' main window
is [a filesystem browser](common.md#the-filesystem-browser),
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
with customisations:
- The filesystem browser only lists
files with extensions typically used for ROM dumps from
consoles higan emulates,
plus `.zip` files since ROM dumps are often compressed.
- Each matching file has a check-box next to it.
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
- You can tick the check-box next to every listed file at once
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
by pressing "Select All" in the bottom-left.
- You can un-tick all the check-boxes
by pressing "Unselect All" in the bottom-left.
Pressing "Import ..." in the bottom-right
will close the filesystem browser
then try to import all the files
whose check-boxes are ticked
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
into the [game library].
More cleanups and revision.
2017-08-24 08:34:37 +00:00
icarus displays a progress dialog during the import process,
and a result window if any errors occurred.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
**Note:** Some games require extra steps to import correctly;
More cleanups and revision.
2017-08-24 08:34:37 +00:00
see [Importing and playing games](../guides/import.md) for details.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
The icarus Settings dialog
--------------------------
More cleanups and revision.
2017-08-24 08:34:37 +00:00
Pressing "Settings ..."
in the bottom-right corner of the main icarus window
opens the settings dialog.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
The icarus Settings dialog contains the following settings:
- **Library Location** determines
where icarus puts the games it imports.
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.
2017-08-21 13:29:53 +00:00
See [Moving the Game Library][movgamelib]
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
for details.
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
- **Create Manifests** causes icarus to
include a [manifest] file
inside the [game folder] for each imported game.
Fix all the broken links. Also, some of the text in the higan and icarus settings docs wanted to link to a discussion of why we ignore manifests by default; now we have such a thing.
2017-08-22 08:12:17 +00:00
See [Ignoring manifests](../concepts/manifests.md#ignoring-manifests)
for details.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- **Use Database** causes icarus to use manifest information
from its database of known-good manifests,
if it's importing a game it recognises.
For unrecognised games,
and for all games if this box is unticked,
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
icarus guesses the manifest data.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
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.
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.
2017-08-21 13:29:53 +00:00
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
Command line
------------
docs: Review and update docs for v107. Changes include: - The "Library" menu was replaced with the "Systems" menu - The "Settings" menu was reorganised - Game Boy rumble is now under the MBC5 "controller" for the cartridge "port", instead of being presented as a part of the base console - Import instructions now mention that icarus ships with some firmware files, and describe the "Firmware" directory that icarus will use for firmware it needs. - Apparently the correct name is "MSU1", not "MSU-1" - v107 changes the way MSU1 data is stored in game folders - PowerFest '94 import instructions removed, since I can't get it to work with v107 - Links to the official forum have been replaced with links to the unofficial forum archive, since the official forum is shutting down - Links to Mercurial Magic updated to point at qwertymodo's archive, since hex_usr is no longer developing it - Links to nSide updated, since hex_usr no longer uses GitHub. - Windows build instructions now describe a compiler that is actually maintained, instead of stale TDM64-GCC. - Linux build instructions now mention higan requires SDL 2.0. - minor wording changes, typos, broken links fixed, etc.
2018-11-16 05:09:30 +00:00
icarus can be launched in any of the following ways:
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
> icarus
>
> icarus \-\-import *FILE*
>
> icarus \-\-manifest *GAME*
When run without arguments,
icarus runs interactively
as described under [Bulk importing ROM files](#bulk-importing-rom-files) above.
When run with the `--import` flag,
`FILE` should be the path to a ROM file
for one of the consoles higan supports,
or a `.zip` file containing such a ROM file.
icarus will import it into the [game library]
just as it would if running interactively,
and the full path to the ressulting game folder
is printed to icarus' standard output.
Warn that icarus in command-line mode doesn't offer much feedback.
2018-05-17 07:09:28 +00:00
If the game cannot be imported correctly
due to missing firmware,
icarus prints no output.
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
When run with the `--manifest` flag,
`GAME` should be the path to a [game folder],
such as a game previously imported into the [game library].
icarus will examine the game,
come up with a [manifest] describing the game's memory layout,
and print it to standard output.
[game library]: ../concepts/game-library.md
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.
2017-08-21 13:29:53 +00:00
[movgamelib]: ../concepts/game-library.md#moving-the-game-library
Start updating the docs for v107.
2018-05-13 13:00:10 +00:00
[game folder]: ../concepts/game-folders.md
[manifest]: ../concepts/manifests.md