The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-02-22 12:47:15 +01:00
Code Issues Packages Projects Releases Wiki Activity
N64FlashcartMenu/docs/18_emulators.md

13 lines
1.2 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)
[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
## Emulators
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
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.
[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
Emulators should be added to the `/menu/emulators` directory on the SD card. N64FlashcartMenu currently supports the following emulators and associated ROM file names:
[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
- **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`
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
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).
Reference in New Issue Copy Permalink