Skip to content

Commit 12e7357

Browse files
committed
Update README
1 parent b7248b7 commit 12e7357

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Find the website and documentation at https://superfw.davidgf.net/
1616
Installation
1717
------------
1818

19+
Check https://superfw.davidgf.net/docs/install/flash/ for more details.
20+
1921
The firmware can be chain-loaded using another firmware (ie. the default
2022
SuperCard firmware or SCFW) and loaded as a regular game. It can also be
2123
installed on the internal flash device. Installing it enables some nice
@@ -34,36 +36,18 @@ https://github.com/davidgfnet/superfw-nds-flasher-tool/releases/ and launch
3436
it with your Supercard on your Slot-2. You should be able to flash (as well
3537
as backup) your flash.
3638

37-
38-
Files and configuration on the SD card
39-
--------------------------------------
40-
41-
All SuperFW related files are stored under "/.superfw" at the root of the card.
42-
The following files are usually created:
43-
44-
- .superfw/settings.txt: User settings, loaded on startup.
45-
- .superfw/ui-settings.txt: UI settings, loaded on startup.
46-
- .superfw/recent.txt: Recently played ROMs, in order.
47-
- .superfw/pending-save.txt: SRAM save information (temp file).
48-
- .superfw/pending-sram-test.txt: SRAM test flag (temp file).
49-
50-
Other noteworthy paths:
51-
52-
- .superfw/config/: Per-ROM load configuration.
53-
- .superfw/patches/: Patch cache (created by PatchEngine).
54-
- .superfw/cheats/: Cheat database, contains .cht files.
55-
- .superfw/emulators/: Emulator ROMs, used to play other device's ROMs.
56-
5739
GB/GBC Emulation
5840
----------------
5941

6042
GameBoy and GameBoy Color ROMs can be played by using the built-in Goombacolor
61-
emulator binary. Picking any .gb/.gbc file will load the emulator and the ROM
62-
and start its execution.
43+
emulator binary (the Lite build doesn't ship any emulator though).Picking any
44+
.gb/.gbc file will load the emulator and the ROM and start its execution.
6345

6446
Other devices can also be played as long as the right emulator is installed in
6547
the SD card (and supported by SuperFW).
6648

49+
Check https://superfw.davidgf.net/docs/usermanual/emulators/ for details.
50+
6751
ROM patching
6852
------------
6953

@@ -81,8 +65,12 @@ and improvements can be added). The patches contain information about:
8165
- RTC patches: Used for games that contained an RTC IC in theri cart, to keep
8266
track of time (both time and date). There's only a handful such ROMs.
8367

68+
More information at https://superfw.davidgf.net/docs/usermanual/patches/
69+
8470
These patches are generated mostly automatically, check out the patch repo at:
8571
https://github.com/davidgfnet/gba-patch-gen
72+
It is also possible to use the web-based patch generator for better patches:
73+
https://patchtool.superfw.davidgf.net/
8674

8775
In-game menu
8876
------------
@@ -128,6 +116,25 @@ save game, this is called Direct-Saving mode. This makes saving more reliable
128116
saving or using the in-game menu). Games that use Flash or EEPROM will display
129117
an option for direct-saving (this is the default choice in Auto mode).
130118

119+
Files and configuration on the SD card
120+
--------------------------------------
121+
122+
All SuperFW related files are stored under "/.superfw" at the root of the card.
123+
The following files are usually created:
124+
125+
- .superfw/settings.txt: User settings, loaded on startup.
126+
- .superfw/ui-settings.txt: UI settings, loaded on startup.
127+
- .superfw/recent.txt: Recently played ROMs, in order.
128+
- .superfw/pending-save.txt: SRAM save information (temp file).
129+
- .superfw/pending-sram-test.txt: SRAM test flag (temp file).
130+
131+
Other noteworthy paths:
132+
133+
- .superfw/config/: Per-ROM load configuration.
134+
- .superfw/patches/: Patch cache (created by PatchEngine).
135+
- .superfw/cheats/: Cheat database, contains .cht files.
136+
- .superfw/emulators/: Emulator ROMs, used to play other device's ROMs.
137+
131138
Limits
132139
------
133140

0 commit comments

Comments
 (0)