N64FlashcartMenu/docs/19_gamepak_boxart.md

30 lines
1.4 KiB
Markdown
Raw Normal View History

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>
2025-01-20 23:51:08 +00:00
[Return to the index](./00_index.md)
## Game Art Images
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>
2025-01-20 23:51:08 +00:00
To use N64 game box art images, place your PNG files within the `sd:/menu/boxart/` folder.
[develop] Documentation manual (#198) <!--- 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 -->
2025-01-12 23:15:27 +00:00
#### Supported images
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>
2025-01-20 23:51:08 +00:00
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
[develop] Documentation manual (#198) <!--- 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 -->
2025-01-12 23:15:27 +00: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>
2025-01-20 23:51:08 +00:00
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`.
[develop] Documentation manual (#198) <!--- 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 -->
2025-01-12 23:15:27 +00:00
i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
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>
2025-01-20 23:51:08 +00:00
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:
[develop] Documentation manual (#198) <!--- 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 -->
2025-01-12 23:15:27 +00:00
i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.png`.
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>
2025-01-20 23:51:08 +00:00
**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`
[develop] Documentation manual (#198) <!--- 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 -->
2025-01-12 23:15:27 +00: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>
2025-01-20 23:51:08 +00:00
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)