mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-02-20 03:52:47 +01:00
Docs proofread/rewrites (#206)
## Description Proofread and partial rewrite of the docs. ## Motivation and Context Adding more information written in an user-friendly way (not just developer-friendly way), writing materials that were left to do, cleaning up existing materials. ## 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: - [ ] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated multiple documentation files with improved clarity, consistency, and formatting - Refined section titles and headings across various documentation pages - Enhanced explanations and instructions for N64FlashcartMenu features - Improved navigation links and added more descriptive return-to-index references <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Robin Jones <networkfusion@users.noreply.github.com>
This commit is contained in:
Víctor "IlDucci
GitHub
parent
ae9f10cda1
commit
7f97c2ff4e
@ -1,37 +1,36 @@
|
||||
[..](README.md)
|
||||
## User Guide
|
||||
[Return to README](README.md)
|
||||
## N64FlashcartMenu User Guide
|
||||
|
||||
### General
|
||||
- [Getting started](./10_getting_started_sd.md)
|
||||
- [Menu controls](./11_menu_controls.md)
|
||||
- [ROM configuration](./12_rom_configuration.md)
|
||||
- [Datel Cheats](./13_datel_cheats.md)
|
||||
- [ROM patches](./14_rom_patches.md)
|
||||
- [Initial Setup of an SD Card](./10_getting_started_sd.md)
|
||||
- [Basic Joypad Controls](./11_menu_controls.md)
|
||||
- [ROM Configuration](./12_rom_configuration.md)
|
||||
- [Cheats (Gameshark etc.)](./13_datel_cheats.md)
|
||||
- [ROM Patches (Hacks, Fan Translations, etc.)](./14_rom_patches.md)
|
||||
- [Controller PAKs](./15_controller_paks.md)
|
||||
- [Background Images](./16_background_images.md)
|
||||
- [64DD](./17_64dd.md)
|
||||
- [Emulators](./18_emulators.md)
|
||||
- [Boxart](./19_gamepak_boxart.md)
|
||||
- [Autoload N64 ROMs](./22_autoload_roms.md)
|
||||
- [Game Art Images](./19_gamepak_boxart.md)
|
||||
- [Autoloading N64 ROMs](./22_autoload_roms.md)
|
||||
|
||||
### Menus
|
||||
- [File Browser](./31_file_browser.md)
|
||||
- [Menu Settings](./32_menu_settings.md)
|
||||
- [RTC Settings](./33_rtc_settings.md)
|
||||
- [Date-Time (RTC) Settings](./33_rtc_settings.md)
|
||||
- [Menu Information](./35_menu_information.md)
|
||||
- [Flashcart Information](./36_flashcart_information.md)
|
||||
- [N64 Information](./37_n64_information.md)
|
||||
|
||||
### Other
|
||||
- [MP3 player](./41_mp3_player.md)
|
||||
- [Advanced customization](./61_advanced_customization.md)
|
||||
- [Hardware mods](./62_hardware_mods.md)
|
||||
- [MP3 Player](./41_mp3_player.md)
|
||||
- [Advanced Customization](./61_advanced_customization.md)
|
||||
- [N64 Hardware Modifications Compatibility](./62_hardware_mods.md)
|
||||
- [FAQ](./81_faq.md)
|
||||
|
||||
#### Experimental Features
|
||||
Subject to change
|
||||
#### Experimental Features (Subject to change)
|
||||
- [Experimental Features](./65_experimental.md)
|
||||
|
||||
### Developers
|
||||
- [Developer guide](./99_developer_guide.md)
|
||||
- [Developer Guide](./99_developer_guide.md)
|
||||
- [Contributing](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md)
|
||||
@ -1,35 +1,30 @@
|
||||
[..](./00_index.md)
|
||||
## Initial Setup of SD Card
|
||||
[Return to the index](./00_index.md)
|
||||
## Initial Setup of the SD Card
|
||||
|
||||
### First Steps
|
||||
### 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:** It is advised to use ROM files in the Big Endian (default, also called "non-byteswapped") format. Although the menu auto-converts byteswapped ROM files, the load time will increase.
|
||||
|
||||
**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.
|
||||
**Note:** On macOS, if you have extracted ROM's from ZIP or other compressed files, run `dot_clean -m /Volumes/SummerCart` to clear those awful dotfiles. That way, they will not show up 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`**.
|
||||
|
||||
- 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 the [Emulators](./18_emulators.md) page.
|
||||
|
||||
### Emulator Support
|
||||
see [here](./18_emulators.md)
|
||||
|
||||
|
||||
### 64DD Disk Support
|
||||
See [here](./17_64dd.md)
|
||||
|
||||
### 64DD Disk support
|
||||
See the [64DD](./17_64dd.md) page.
|
||||
|
||||
#### So what would the layout of the SD card look like?
|
||||
```plaintext
|
||||
@ -56,8 +51,8 @@ SD:\
|
||||
│
|
||||
├── (a rom).z64
|
||||
├── (a rom).n64
|
||||
├── (some folder with roms)\
|
||||
│ └── (some folder with roms)\
|
||||
├── (some folder with ROMs)\
|
||||
│ └── (some folder with ROMs)\
|
||||
| └── (some supported ROM files)
|
||||
│
|
||||
├── (some supported ROM files)
|
||||
@ -73,7 +68,7 @@ and they must share the same file name, but use the `.sav` extension. `.sav` fil
|
||||
the "cartridge save memory".
|
||||
|
||||
```plaintext
|
||||
├── (some folder with roms)\
|
||||
├── (some folder with ROMs)\
|
||||
├── a_rom.z64
|
||||
├── b_rom_whatever.n64
|
||||
└── saves\
|
||||
@ -81,7 +76,7 @@ the "cartridge save memory".
|
||||
└── b_rom_whatever.sav
|
||||
```
|
||||
|
||||
### Transfering Saves From An ED64
|
||||
### Transferring 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.
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Menu Controls
|
||||
|
||||
### Additional Control Information
|
||||
<!-- Could use a sample screenshot of the controller and labels here -->
|
||||
|
||||
#### Fast scroll
|
||||
Press either the `C-Up` or `C-Down` buttons to scroll by pages, rather than by elements.
|
||||
@ -9,18 +8,18 @@ Press either the `C-Up` or `C-Down` buttons to scroll by pages, rather than by e
|
||||
#### N64FlashcartMenu settings
|
||||
Press the `START` button on the browser screen to open the Settings window.
|
||||
|
||||
From here you can edit some of the N64FlashcartMenu settings,
|
||||
see information about either the console, the flashcart you are using or N64FlashcartMenu itself, and if your cart has Real-Time Clock (RTC) support, you can also change its date and time.
|
||||
From here you can edit some of the N64FlashcartMenu settings, see information about either the console, the flashcart you are using or N64FlashcartMenu itself, and if your cart has Real-Time Clock (RTC) support, you can also change its date and time.
|
||||
|
||||
#### Browser options
|
||||
Press the `R` button to open the Browser Options window. Here you can see a ROM's properties, delete it from your SD card or establish the default folder
|
||||
where N64FlashcartMenu's browser will start in future boots.
|
||||
|
||||
#### Additional ROM information
|
||||
<!-- Could use a sample screenshot here -->
|
||||
Press either the `L` or `Z` button on the ROM information screen to open an additional window that will show additional information about the currently
|
||||
selected ROM file, such as its endianess, regional variant, set clock rate, and much more.
|
||||
selected ROM file, such as its endianness, regional variant, set clock rate, and much more.
|
||||
|
||||
### 64DD ROM
|
||||
### 64DD-related
|
||||
|
||||
#### Expansion disks
|
||||
To load an expansion disk (such as F-Zero X), first browse to the N64 ROM and load it (**but not start it!**), then browse to the 64DD expansion file and press either the `L` or `Z` button.
|
||||
|
||||
@ -1,18 +1,46 @@
|
||||
[..](./00_index.md)
|
||||
## ROM configuration
|
||||
[Return to the index](./00_index.md)
|
||||
## ROM Configuration
|
||||
|
||||
The menu allows overriding the ROM's default configuration that is provided from the internal database.
|
||||
The N64FlashcartMenu allows overriding the ROM's default configuration that is provided from the internal database.
|
||||
|
||||
The internal database is contained within `rom_info.c`.
|
||||
|
||||
The N64FlashcartMenu expects that you are using a flashcart that has an [ultra cic](https://n64brew.dev/wiki/Checking_Integrated_Circuit) available.
|
||||
|
||||
NOTE: Some old ROM hacks may have adjusted the ROM code to manipllate the expected CIC and save type in order to allow compatibility with more available chips (usually 6102) as was used on flashacarts prior to 2018. If it does, you may need to override the internal database using the override settings.
|
||||
|
||||
The internal database is contained within `rom_info.c`
|
||||
|
||||
If you override the defaults and want to go back to the default ones, delete the `<rom name>.ini` file.
|
||||
|
||||
### Overrideable types
|
||||
### Homebrew Header
|
||||
The N64FlashcartMenu fully supports the [homebrew header](https://n64brew.dev/wiki/ROM_Header#Advanced_Homebrew_ROM_Header)
|
||||
|
||||
### Available Overrides
|
||||
|
||||
#### CIC type
|
||||
The Checking Integrated Circuit [CIC](https://n64brew.dev/wiki/Checking_Integrated_Circuit) was a physical security chip used by retail Nintendo 64 game cartridges that prevented unlicensed and pirated game cartridges from running and used in conjunction with the [PIF](https://n64brew.dev/wiki/PIF-NUS).
|
||||
|
||||
WARNING: Changing the CIC type to an unsupported one may result in a blank screen for that particular ROM until you manually delete the override file!
|
||||
|
||||
For more detailed information regarding the various CIC chips, please visit [micro-64.com's game CIC database](http://micro-64.com/database/gamecic.shtml).
|
||||
|
||||
#### Save type
|
||||
Games that have been programmed to include an internal save system might use various types of chips, methods and sizes.
|
||||
|
||||
WARNING: Using the wrong save type can cause unwanted behaviors on games and/or corrupt existing ones!
|
||||
|
||||
For more detailed information regarding the various saving methods, please visit [micro-64.com's game save database](http://micro-64.com/database/gamesave.shtml)
|
||||
|
||||
#### TV Region type
|
||||
<!-- Should we quickly explain regions? -->
|
||||
All ROMs are generally programmed to work with a single type of television output setting, whether it's NTSC, PAL or MPAL or their multiple variants. Forcing the region will generally make the ROM work on your display, however:
|
||||
|
||||
1. Be aware that not every CRT from the 1990s and 2000s is compatible with both NTSC and PAL standards.
|
||||
2. Be aware that flat TVs from late 2010s-2020s might have other issues, such as when a game changes its internal resolution during gameplay (i.e. Resident Evil 2 with Expansion Pak).
|
||||
3. Expect potential side effects:
|
||||
- Speed issues
|
||||
- Audio/visual desynchronization
|
||||
- Other unexpected/unwanted behaviors
|
||||
|
||||
### Autoload
|
||||
See the [Autoload N64 ROMs](./22_autoload_roms.md) page.
|
||||
|
||||
@ -1,16 +1,29 @@
|
||||
[..](./00_index.md)
|
||||
## Datel Cheats
|
||||
AKA InterAct (in certain regions)
|
||||
[Return to the index](./00_index.md)
|
||||
## Datel/InterAct Cheats
|
||||
|
||||
The N64 supports the peripherals
|
||||
The N64FlashcartMenu supports the cheat code types made popular by the peripherals:
|
||||
- GameShark
|
||||
- Action Replay
|
||||
|
||||
It is not advised to connect the physical peripheral with most flashcarts.
|
||||
Another product by Blaze, called the Xploder64/Xplorer64 also existed in some regions, but these codes are less likely to work.
|
||||
|
||||
The menu has underlying support for these codes (when using an expansion pak), but is not yet exposed via the menu graphical user interface.
|
||||
**WARNING**: It is not advised to connect a physical cheat cartridge in conjunction with most flashcarts.
|
||||
|
||||
|
||||
The N64FlashcartMenu can only support cheat codes based on datel carts when also using an Expansion pak.
|
||||
|
||||
Caveats:
|
||||
- Something about cheats and expansion paks.
|
||||
|
||||
The current code types are supported:
|
||||
- 80 (description here)
|
||||
- D0 (description here)
|
||||
- Fx (description here)
|
||||
- ...
|
||||
|
||||
The codes XX are not supported, because...
|
||||
- e.g. they rely on the button.
|
||||
|
||||
```
|
||||
// Example cheat codes for the game "Majoras Mask USA"
|
||||
uint32_t cheats[] = {
|
||||
@ -24,7 +37,7 @@ uint32_t cheats[] = {
|
||||
0x0020,
|
||||
0x803FDA3F,
|
||||
0x0002,
|
||||
// Last 2 entrys must be 0
|
||||
// Last 2 entries must be 0
|
||||
0,
|
||||
0,
|
||||
};
|
||||
@ -32,5 +45,4 @@ uint32_t cheats[] = {
|
||||
|
||||
And pass this array as a boot parameter: `menu->boot_params->cheat_list = cheats;`
|
||||
|
||||
Check [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards GUI support.
|
||||
|
||||
Check the [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards GUI editor support.
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
[..](./00_index.md)
|
||||
## ROM patches
|
||||
[Return to the index](./00_index.md)
|
||||
## ROM Patches (Hacks, Fan Translations, etc.)
|
||||
|
||||
Not yet supported, although you can use various online utilities.
|
||||
At the time of writing, N64FlashcartMenu does not support patching on-the-fly, although you can use various offline and online utilities to patch your games.
|
||||
|
||||
Check the [Pull Requests section](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
|
||||
|
||||
Check [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
|
||||
The aim is to support APS/IPS/BPS/XDELTA patches.
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Controller Paks
|
||||
|
||||
Not yet supported.
|
||||
Check [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
|
||||
<!-- No need for screenshots until the CPak menu is more mature -->
|
||||
At the time of writing, N64FlashcartMenu can only recognize if a Controller Pak is inserted on a Controller. Controller Pak backups, backup restoration and handling are not yet supported.
|
||||
Check the [Pull Requests section](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
[..](./00_index.md)
|
||||
## Background images
|
||||
[Return to the index](./00_index.md)
|
||||
## Background Images
|
||||
|
||||
### Adding a background image
|
||||
Add an image to the SD card. When browsing the menu, select and load the image and then respond to the dialogue message.
|
||||
### How to add a background image
|
||||
First copy an image in .PNG format to anywhere on the SD card. Then when the N64FlashcartMenu is loaded on the N64, browse to the image and then select it to show it on the screen. Press the A Button again to open up the confirmation message, which will ask if you want to set a new background image.
|
||||
<!-- Could use a sample screenshot here -->
|
||||
Press the A Button to confirm and set the image as your new background or press the B Button to cancel and return to the image display screen.
|
||||
|
||||
@ -1,9 +1,12 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## 64DD Disk support
|
||||
|
||||
Specific flashcarts (such as the SummerCart64) support the ability to fully emulate the original 64DD.
|
||||
|
||||
**Note**: It is not yet possible to swap 64DD disks via the menu.
|
||||
Specific flashcarts (such as the [SummerCart64](https://summercart64.dev)) can fully emulate the original 64DD (load, run, save) disks without having a physical device connected to the N64 and don't require conversion ROMs.
|
||||
|
||||
To load and run 64DD disk images, place the required 64DD IPL dumps in the `/menu/64ddipl` folder on the SD card.
|
||||
For more details, follow [this guide on the 64dd.org website](https://64dd.org/tutorial_sc64.html).
|
||||
|
||||
**Note**: It is not yet possible to swap 64DD disks via N64FlashcartMenu.
|
||||
|
||||
### Conversion ROMs
|
||||
The N64Flashcart Menu is able to load and run conversion ROMs (but does not perform saves).
|
||||
|
||||
@ -1,16 +1,12 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Emulators
|
||||
The menu supports mutiple emulators that are compatible with the N64.
|
||||
Current Emulator support includes (NES, SNES, GB, GBC, SMS, GG, CHF) ROMs.
|
||||
N64FlashcartMenu supports multiple emulators that are compatible with the N64. At the time of writing, current emulator support includes NES, SNES, GB, GBC, SMS, GG, and CHF ROMs.
|
||||
|
||||
Emulators should be added to the `/menu/emulators` directory on the SD card.
|
||||
|
||||
N64FlashcartMenu currently supports the following emulators and associated ROM file names:
|
||||
Emulators should be added to the `/menu/emulators` directory on the SD card. N64FlashcartMenu currently supports the following emulators and associated ROM file names:
|
||||
- **NES**: [neon64v2](https://github.com/hcs64/neon64v2/releases) by *hcs64* - `neon64bu.rom`
|
||||
- **SNES**: [sodium64](https://github.com/Hydr8gon/sodium64/releases) by *Hydr8gon* - `sodium64.z64`
|
||||
- **Game Boy**/**GB Color**: [gb64](https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html) by *lambertjamesd* - `gb.v64`/`gbc.v64` ("Download Emulator" button)
|
||||
- **SMS**/**GG**: [smsPlus64](https://github.com/fhoedemakers/smsplus64/releases) by *fhoedmakers* - `smsPlus64.z64`
|
||||
- **Fairchild Channel F**: [Press-F-Ultra](https://github.com/celerizer/Press-F-Ultra/releases) by *celerizer* - `Press-F.z64`
|
||||
|
||||
|
||||
If you are an emulator developer, take a look at this [template pull request](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pull/178)
|
||||
If you are an emulator developer and are interested in adding your emulator, take a look at this [template pull request](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pull/178).
|
||||
|
||||
@ -1,31 +1,29 @@
|
||||
[..](./00_index.md)
|
||||
## Gamepak Boxart
|
||||
|
||||
### GamePak boxart images
|
||||
To use N64 GamePak boxart images, place PNG files within the `sd:/menu/boxart/` folder.
|
||||
[Return to the index](./00_index.md)
|
||||
## Game Box Art Images
|
||||
To use N64 game box art images, place your PNG files within the `sd:/menu/boxart/` folder.
|
||||
|
||||
#### Supported images
|
||||
These must be `PNG` files that use the following dimensions:
|
||||
* Standard N64 GamePak boxart sprites: 158x112
|
||||
* Japanese N64 GamePak boxart sprites: 112x158
|
||||
* 64DD boxart sprites: 129x112
|
||||
Files must be in `PNG` format and use the following dimensions:
|
||||
* American/European N64 box art sprites: 158x112
|
||||
* Japanese N64 box art sprites: 112x158
|
||||
* 64DD box art sprites: 129x112
|
||||
|
||||
They will be loaded by directories using each character (case-sensitive) of the full 4 character Game Code (as identified in the menu ROM information).
|
||||
i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/boxart/N/G/E/E/boxart_front.png`.
|
||||
Images will be loaded by directories using each character (case-sensitive) of the full 4-character Game Code (as identified in the menu ROM information):
|
||||
i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/boxart/N/G/E/E/boxart_front.png`.
|
||||
i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
|
||||
|
||||
To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3 letter IDs instead:
|
||||
To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3-character IDs instead:
|
||||
i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.png`.
|
||||
|
||||
**Warning**: Excluding the region ID may show the wrong boxart.
|
||||
**Note**: For future support, boxart sprites should also include:
|
||||
* `boxart_back.png`
|
||||
* `boxart_top.png`
|
||||
* `boxart_bottom.png`
|
||||
* `boxart_left.png`
|
||||
* `boxart_right.png`
|
||||
* `gamepak_front.png`
|
||||
* `gamepak_back.png`
|
||||
**Warning**: Excluding the region ID may show a box art of the wrong region.
|
||||
**Note**: For future support, box art sprites should also include:
|
||||
- `boxart_back.png`
|
||||
- `boxart_top.png`
|
||||
- `boxart_bottom.png`
|
||||
- `boxart_left.png`
|
||||
- `boxart_right.png`
|
||||
- `gamepak_front.png`
|
||||
- `gamepak_back.png`
|
||||
|
||||
As a starting point, here is a link to a boxart pack, that has `boxart_front.png`:
|
||||
* [third party boxart link](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)
|
||||
As a starting point, here is a link to a box art pack, that has `boxart_front.png`:
|
||||
- [Third party box art](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
[..](./00_index.md)
|
||||
## Autoloading ROMs
|
||||
**Note** using byteswapped ROMs will slowdown the ROM load.
|
||||
[Return to the index](./00_index.md)
|
||||
## Autoloading N64 ROMs
|
||||
You can set up N64FlashcartMenu to load a specific ROM directly instead of booting up the menu's graphical user interface. **NOTE:** byteswapped ROMs will slow down the ROM load process.
|
||||
|
||||
### N64 ROM autoload
|
||||
To use the autoload function, while on the `N64 ROM information` display, press the `R` button on your joypad and select the `Set ROM to autoload` option. When you restart the console, it will now only load the selected ROM rather than the menu.
|
||||
**NOTE:** To return to the menu, hold the joypad `Start` button while powering on the console.
|
||||
### How to enable autoloading
|
||||
To use the autoload function, open the `N64 ROM information` screen on any ROM, then press the `R` Button on your Controller and select the `Set ROM to autoload` option. When you restart the console, N64FlashcartMenu will now only load the selected ROM, rather than the menu itself.
|
||||
**NOTE:** If you want to return to the menu, press and hold the `START` Button on your Controller while turning the console's POWER button to the ON position.
|
||||
|
||||
@ -1,39 +1,38 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## File Browser
|
||||
|
||||
<!-- Could use a beauty screenshot here -->
|
||||
The File Browser allows you to navigate and manage files on your N64 flashcart. Below are the key features and instructions on how to use the File Browser effectively.
|
||||
|
||||
### Features
|
||||
|
||||
- **File and folder Navigation**: Browse through directories and files on your flashcart.
|
||||
- **File Operations**: Perform operations such as delete and show properties.
|
||||
- **File Information**: View detailed information about each file, including size and date modified.
|
||||
- **Load Files**: Load files from the file system.
|
||||
- **File and folder navigation**: Browse through directories and files on your flashcart.
|
||||
- **File operations**: Perform operations such as delete and show properties.
|
||||
- **File information**: View detailed information about each file, including size and date modified.
|
||||
- **Load files**: Load files from the file system.
|
||||
- **Switching tabs (Pre-release only)**: Switch between the file browser, favorites and history tabs.
|
||||
|
||||
### Usage Instructions
|
||||
|
||||
<!-- Maybe all the Control pages could be merged into this section? -->
|
||||
1. **Navigating Files**:
|
||||
- Use the directional Up and Down buttons (C-Up and C-Down for fast scrolling) to move through the list of files and directories.
|
||||
- Press the `A` button to open a directory or load a supported file.
|
||||
- Press the `A` Button to open a directory or load a supported file.
|
||||
|
||||
2. **Performing File Operations**:
|
||||
- Highlight the file or directory you want to operate on.
|
||||
- Press the `R` button to open the operations menu.
|
||||
- Press the `R` Button to open the operations menu.
|
||||
- Select the desired operation (delete, show properties, set as default) and follow the on-screen prompts.
|
||||
|
||||
3. **Viewing Settings menu**:
|
||||
- Press the `Z` button to display the menu.
|
||||
- Press the `Z` Button to display the menu.
|
||||
|
||||
4. **Switching tabs (Pre-release only)**:
|
||||
- Press the `C-Right` and `C-Left` buttons to switch between the file browser, favorites and history tabs.
|
||||
- Press the `C-Right` and `C-Left` Buttons to switch between the file browser, favorites and history tabs.
|
||||
|
||||
### Tips
|
||||
|
||||
- Regularly back up important files to avoid accidental loss.
|
||||
- Make sure you regularly back up important files from the SD Card to your computer to avoid accidental loss.
|
||||
- Familiarize yourself with the button layout to navigate and manage files efficiently.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- If a file operation fails, ensure there is enough space on the SD card and that the file is not write-protected.
|
||||
- For any issues not covered in this guide, refer to the troubleshooting section in the main manual or contact support.
|
||||
- If a file operation fails, make sure there is enough space on the SD card and that the file is not write-protected.
|
||||
- For any issues not covered in this guide, refer to the troubleshooting section in the main manual or contact the support channels on Discord.
|
||||
|
||||
@ -1,16 +1,15 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Menu Settings
|
||||
The Menu creates a `config.ini` file in `sd:/menu/` which contains various settings that are used and can be set within the menu.
|
||||
If required, you can manually adjust the file on the SD card using your computer.
|
||||
|
||||
N64FlashcartMenu automatically creates a `config.ini` file in `sd:/menu/`, which contains various settings that can be set within the menu's Settings editor.
|
||||
If required, you can manually adjust the file (required for some advanced settings) on the SD card using your computer.
|
||||
|
||||
### Show Hidden Files
|
||||
The default is off.
|
||||
Shows any N64FlashcartMenu system-related files. This setting is OFF by default.
|
||||
|
||||
### Use Save Folders
|
||||
The default is on.
|
||||
ON: ROM saves are saved in a seperate subfolder (called saves).
|
||||
Controls whether N64FlashcartMenu should use `/saves` folders to store ROM save data. This setting is ON by default.
|
||||
ON: ROM saves are saved in separate subfolders (called `\saves`, will create one `\saves` subfolder per folder).
|
||||
OFF: ROM saves are saved alongside the ROM file.
|
||||
|
||||
### Sound effects
|
||||
The menu has default sound effects to improve the experience that can be turned on in the settings menu (the default is off).
|
||||
### Sound Effects
|
||||
The menu has default sound effects to improve the user experience. This setting is OFF by default.
|
||||
|
||||
@ -1,6 +1,9 @@
|
||||
[..](./00_index.md)
|
||||
## RTC settings
|
||||
[Return to the index](./00_index.md)
|
||||
## Real-Time Clock Settings
|
||||
|
||||
|
||||
The menu has the ability to set the RTC if the flashcart supports it.
|
||||
Press `A` to change the date and time.
|
||||
|
||||
If your flashcart supports the Real-Time Clock (RTC from herein) feature, N64FlashcartMenu has the ability to read and set it.
|
||||
|
||||
Press the `START` Button on the File Browser and select `Time (RTC) settings` to enter the Adjust Real-Time Clock screen. Here you will see a notice regarding other ways to change the RTC. If your flashcart is compatible, press the `A` Button to display the RTC change prompt.
|
||||
|
||||
Press Up and/or Down on your Control Stick or Directional Buttons to modify the currently selected value, or Left and/or Right to select another value to change. If you are satisfied with the changes, press the `R` Button to save the current time and date and return to the Adjust Real-Time Clock screen. If you want to cancel your changes, press the `B` Button to return to the Adjust Real-Time Clock screen and keep the old RTC values.
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Menu information
|
||||
|
||||
|
||||
This screen will show you various information regarding the N64FlashcartMenu you have booted, such as its version, its build date, and the developer credits.
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Flashcart Information
|
||||
This screen shows the information gathered from the flashcart.
|
||||
|
||||
|
||||
|
||||
This screen shows all the information that N64FlashcartMenu can gather from the flashcart, such as the firmware version and flashcart features that may be supported within the N64FlashcartMenu.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## N64 Information
|
||||
|
||||
|
||||
|
||||
This screen will show information about your N64 console. At the time of writing, it will show the status of the Expansion Pak, 64DD and all the Controller ports.
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
[..](./00_index.md)
|
||||
### MP3 Player
|
||||
The menu is able to play loaded MP3 files.
|
||||
[Return to the index](./00_index.md)
|
||||
## MP3 Player
|
||||
<!-- A screenshot of the MP3 player -->
|
||||
The N64FlashcartMenu includes an MP3 Player that can read MP3 files from the SD Card. At the time of writing, MP3 files must have a sample rate of 44100 Hz or higher.
|
||||
|
||||
Whilst in the menu, select an MP3 file in the File Browser to go to the MP3 Player screen, where the audio playback will begin immediately.
|
||||
|
||||
Here you can pause the playback by pressing the `A` Button, and skip the audio forward or backwards by pressing either `Left` or `Right` on the directional buttons or the Control Stick. When you want to stop the playback and return to the File Browser, press the `B` Button.
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
[..](./00_index.md)
|
||||
[Return to the index](./00_index.md)
|
||||
## Advanced Menu Customization
|
||||
|
||||
### Customizing the font
|
||||
Add a `font64` file to the root directory called "custom.font64". You can build a font64 file with the `libdragon` tools.
|
||||
Advanced customization options are currently [experimental](65_experimental.md).
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
[..](./00_index.md)
|
||||
## N64 Hardware Modifications
|
||||
[Return to the index](./00_index.md)
|
||||
## N64 Hardware Modifications Compatibility
|
||||
|
||||
<!-- TBW by people who can actually speak properly about hardware modifications. -->
|
||||
The following known N64 modifications are supported:
|
||||
- PixelFX HDMI Game ID (works out the box)
|
||||
|
||||
@ -1,11 +1,18 @@
|
||||
[..](./00_index.md)
|
||||
## Experimental features
|
||||
These features are subject to change:
|
||||
[Return to the index](./00_index.md)
|
||||
## Experimental Features (Subject to change)
|
||||
|
||||
### ROM Info descriptions (pre-release only)
|
||||
To add a ROM description (shown when loading a ROM), add a file with the content
|
||||
```
|
||||
### ROM info descriptions (pre-release only)
|
||||
To show a ROM description in the N64 ROM information screen, add a `.TXT` file next to the game ROM file with the same name and the following content:
|
||||
```ini
|
||||
[metadata]
|
||||
description=This is the ROM description that does X Y Z.
|
||||
```
|
||||
The file line endings must use the linux `LF` endings only (CRLF is not supported) ASCII characters only and is limited to 300 characters.
|
||||
Text files must use ASCII characters only, Linux `LF` endings (CRLF is not supported) and the descriptions themselves must be limited to 300 characters.
|
||||
|
||||
### Customizing the font
|
||||
The N64FlashcartMenu allows the ability to test new fonts without recompiling the menu. However the font is explicitly linked to the currently used version of the libdragon SDK.
|
||||
Add a `font64` file to the `sd:/menu/` directory called `custom.font64`.
|
||||
|
||||
<!-- Would be best if we can just link to an actual copy of Mkfont executable file and not expect people to compile libdragon -->
|
||||
You can build a font64 file with `Mkfont`, one of `libdragon`'s tools. At the time of writing, you will need to obtain `libdragon`'s [preview branch artifacts](https://github.com/DragonMinded/libdragon/actions/workflows/build-tool-windows.yml) to find out a copy of the prebuilt Windows executable. [Read its related Wiki page](https://github.com/DragonMinded/libdragon/wiki/Mkfont) for usage information.
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
## Frequently Asked Questions
|
||||
[Return to the index](./00_index.md)
|
||||
## Frequently Asked Questions (FAQ)
|
||||
|
||||
### ROM hack does not work
|
||||
- Most ROM hacks rely on an Expansion PAK, or might be only compatible with an emulator.
|
||||
- Some (very old) hacks override the CIC or save type that are not in the database. (see [here](./12_rom_configuration.md)).
|
||||
### ROM hack (insert hack name here) does not work
|
||||
- Most ROM hacks rely on an Expansion Pak, or might be only compatible with emulators.
|
||||
- Some (very old) hacks override the CIC or save type that is expected from the internal N64FlashcartMenu database. (for more information on how to change the expected types, [read here](./12_rom_configuration.md)).
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
[..](./00_index.md)
|
||||
## Developer documentation
|
||||
[Return to the index](./00_index.md)
|
||||
## Developer Guide
|
||||
|
||||
You can use a dev container in VSCode to ease development.
|
||||
|
||||
### A quickstart video tutorial on how to set up your environment
|
||||
[](http://www.youtube.com/watch?v=h05ufOsRgZU "Devcontainer quickstart guide").
|
||||
### A quick start video tutorial on how to set up your environment
|
||||
[](http://www.youtube.com/watch?v=h05ufOsRgZU "Devcontainer quick start guide").
|
||||
|
||||
|
||||
### How to deploy
|
||||
@ -33,10 +33,10 @@ NOTE: it does not yet work with `F5`: see [this blog post](https://devblogs.micr
|
||||
WORKAROUND: in the dev container terminal, use make directly, i.e.: `make`.
|
||||
The ROM can be found in the `output` directory.
|
||||
|
||||
NOTE: a "release" version of the SC64 menu is called `sc64menu.n64` and can be created for when you want to add it directly to the SDCard. This is generated by running `make all` or running `make sc64`.
|
||||
NOTE: A "release" version of the SC64 menu is called `sc64menu.n64` and can be generated by running `make all` or running `make sc64`. You can then copy the resulting `sc64menu.n64` file to your SD card.
|
||||
|
||||
#### Ares Emulator
|
||||
For ease of development and debugging, the menu ROM can run in the [Ares emulator](https://ares-emu.net/) (without most flashcart features).
|
||||
For ease of development and debugging, the N64FlashcartMenu ROM can run in the [Ares emulator](https://ares-emu.net/) (without most flashcart features).
|
||||
|
||||
* Ensure you have the Ares emulator on your computer.
|
||||
* Load the `N64FlashcartMenu.n64` ROM.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user