Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Remove deprecated support as want people to use the new functionality.
  • Loading branch information
networkfusion committed Jan 4, 2025
1 parent f6b1c45 commit 696af27
Showing 1 changed file with 10 additions and 27 deletions.
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To add a ROM description (shown when loading a ROM), add a file with the content
[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).
The file line endings must use the linux `LF` endings only (CRLF is not supported) and is limited to 300 characters.

### 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.
Expand All @@ -75,10 +75,6 @@ These must be `PNG` files that use the following dimensions:
* Japanese N64 GamePak boxart sprites: 112x158
* 64DD boxart sprites: 129x112

Supported PNG formats:
* RGB/RGBA color formats
* 8-bit color depth

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`.
i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
Expand All @@ -93,34 +89,21 @@ i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.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 following the new structure, including `boxart_front.png` and fallback images:
* [Link](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)


#### Compatibility mode
If you cannot yet satisfy the correct boxart layout, The menu still has **deprecated** support for filenames containing the Game ID.

**Note:** This will add a noticeable delay for displaying parts of the menu.

Each file must be named according to the 2,3 or 4 letter GamePak ID (matched in this order).
i.e.
* for GoldenEye 4 letters, this would be `sd:/menu/boxart/NGEE.png` and/or `sd:/menu/boxart/NGEP.png`.
* for GoldenEye 3 letters, this would be `sd:/menu/boxart/NGE.png`.
* for GoldenEye 2 letters, this would be `sd:/menu/boxart/GE.png`.


As a starting point, here are some links to boxart packs:
* [Japan Boxart](https://mega.nz/file/KyJR0B6B#ERabLautAVPaqJTIdBSv4ghbudNhK7hnEr2ZS1Q6ub0)
* [American Boxart](https://mega.nz/file/rugAFYSQ#JHfgCU2amzNVpC4S6enP3vg--wtAAwsziKa7cej6QCc)
* [European Boxart](https://mega.nz/file/OmIV3aAK#kOWdutK1_41ffN64R6thbU7HEPR_M9qO0YM2mNG6RbQ)
* [64DD Boxart](https://mega.nz/file/ay5wQIxJ#k3PF-VMLrZJxJTr-BOaOKa2TBIK7c2t4zwbdshsQl40)
As a starting point, here is a link to a boxart pack, that has `boxart_front.png`:
* [boxart](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)


### Menu Settings
The Menu creates a `config.ini` file in `sd:/menu/` which contains various settings that are used by the menu.
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.

### Datel cheats
(Action Replay and GameShark codes)
Supported, but no GUI available (yet) to edit them.


## Flashcart specific

Expand Down

0 comments on commit 696af27

Please sign in to comment.