mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-02-22 20:57:14 +01:00
7f97c2ff4e
## 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>
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
[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
|
|
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
|
|
|
|
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-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 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 box art pack, that has `boxart_front.png`:
|
|
- [Third party box art](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)
|