mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-02-23 05:07:18 +01:00
1a9e292598
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Reworks and splits the documentation. ## Motivation and Context <!--- What does this sample do? What problem does it solve? --> <!--- If it fixes/closes/resolves an open issue, please link to the issue here --> Improves documentation to be more readable. ## How Has This Been Tested? <!-- (if applicable) --> <!--- Please describe in detail how you tested your sample/changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Screenshots <!-- (if appropriate): --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Improvement (non-breaking change that adds a new feature) - [ ] Bug fix (fixes an issue) - [ ] Breaking change (breaking change) - [x] Documentation Improvement - [ ] Config and build (change in the configuration and build system, has no impact on code or features) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. <!--- It would be nice if you could sign off your contribution by replacing the name with your GitHub user name and GitHub email contact. --> Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit Based on the comprehensive summary, here are the release notes: - **New Features** - Added ROM history and favorites functionality - Introduced tabbed interface for file browsing - Implemented ROM information descriptions - Added support for ROM configuration overrides - Enhanced menu settings management - **Documentation** - Expanded user guide and documentation - Added sections on ROM patches, controller PAKs, and emulator support - Improved flashcart and menu customization instructions - **Chores** - Updated documentation structure - Refined code organization and naming conventions - Updated subproject references <!-- end of auto-generated comment: release notes by coderabbit.ai -->
94 lines
3.6 KiB
Markdown
94 lines
3.6 KiB
Markdown
[..](./00_index.md)
|
|
## Initial Setup of SD Card
|
|
|
|
### First Steps
|
|
Connect the SD card to your PC and ensure it is properly formatted to be compatible with your flashcart.
|
|
**WARNING:** Filenames are expected to be written in ASCII, with Western Europe characters fully compatible. Other Unicode characters, such as those from Eastern Europe, Russia, Asia or Middle East regions (to name just a few examples) are not fully supported and may not be displayed.
|
|
|
|
**Note:** It is advised to use ROM's in the Big Endian (default) format. Although the menu auto converts byteswapped ROM's, the load time will be increased.
|
|
|
|
**Note:** On macOS, if you have extracted ROM's from zips run `dot_clean -m /Volumes/SummerCart` to clear those awful dotfiles so they are not shown in the menu.
|
|
|
|
#### Preparations for SC64
|
|
- FAT32 and EXFAT are fully supported.
|
|
- An SD formatted with 128 kiB cluster size is recommended.
|
|
|
|
- Download the latest `sc64menu.n64` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
|
|
- Place your ROM files on the SD card, **in any folder except `menu`**.
|
|
|
|
|
|
#### Preparations for other supported flashcarts
|
|
- FAT32 recommended.
|
|
- An SD formatted with the default cluster size is recommended.
|
|
- Download the latest [menu](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) file specific for your flashcart and place it in the expected location.
|
|
|
|
|
|
### Emulator Support
|
|
see [here](./18_emulators.md)
|
|
|
|
|
|
### 64DD Disk Support
|
|
See [here](./17_64dd.md)
|
|
|
|
|
|
#### So what would the layout of the SD card look like?
|
|
```plaintext
|
|
SD:\
|
|
│
|
|
├── sc64menu.n64
|
|
│
|
|
│
|
|
├── menu\
|
|
│ │
|
|
│ │
|
|
│ ├── 64ddipl\
|
|
│ │ ├── NDDE0.n64
|
|
│ │ ├── NDDJ2.n64
|
|
│ │ └── NDXJ0.n64
|
|
│ │
|
|
│ └── emulators\
|
|
│ ├── neon64bu.rom
|
|
│ ├── sodium64.z64
|
|
│ ├── gb.v64
|
|
│ ├── gbc.v64
|
|
│ ├── smsPlus64.z64
|
|
│ └── Press-F.z64
|
|
│
|
|
├── (a rom).z64
|
|
├── (a rom).n64
|
|
├── (some folder with roms)\
|
|
│ └── (some folder with roms)\
|
|
| └── (some supported ROM files)
|
|
│
|
|
├── (some supported ROM files)
|
|
|
|
|
└── (some folder with 64DD disk images)\
|
|
└── (some 64DD disk images)
|
|
```
|
|
|
|
|
|
## Save Files
|
|
All save files (whether `FlashRam`, `SRAM` or `EEPROM`) will be read from a `/saves` folder located **in the same directory as the ROM**
|
|
and they must share the same file name, but use the `.sav` extension. `.sav` files will be created and modified whenever a ROM file saves to
|
|
the "cartridge save memory".
|
|
|
|
```plaintext
|
|
├── (some folder with roms)\
|
|
├── a_rom.z64
|
|
├── b_rom_whatever.n64
|
|
└── saves\
|
|
├── a_rom.sav
|
|
└── b_rom_whatever.sav
|
|
```
|
|
|
|
### Transfering Saves From An ED64
|
|
If you are transferring a file from a different flashcart, such as the ED64, you must change the file extension to `sav`.
|
|
For example, a save file called `Glover (USA).eep` should have its extension changed to `Glover (USA).sav` to work with N64FlashcartMenu.
|
|
|
|
You may also need to pad/trim the files to their original size:
|
|
- For EEPROM 4Kbit games, remove the padding.
|
|
- For others, use a tool such as [Ninjiteu's N64SaveConverter](https://github.com/Ninjiteu/N64SaveConverter).
|
|
|
|
**WARNING:** Saves created with certain emulators, or created for a different ROM version (as in revisions of the same game)
|
|
or region (as in between NTSC and PAL versions of a same game) may be incompatible.
|