N64FlashcartMenu/docs/65_experimental.md
Víctor "IlDucci 7f97c2ff4e
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

1.3 KiB

Return to the index

Experimental Features (Subject to change)

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:

[metadata]
description=This is the ROM description that does X Y Z.

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.

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 to find out a copy of the prebuilt Windows executable. Read its related Wiki page for usage information.