ReadMePEAK

Read README files for your PEAK mods in game.

How to use

1. Install ReadMePEAK with Thunderstore or your usual PEAK mod manager.
2. Launch PEAK with mods enabled.
3. Press F7 to open the mod browser.
4. Search for a mod, select it, and read its guide.

Use Make bigger to expand the reader. Press F7 again or choose Close to dismiss it. The key can be changed in the ReadMePEAK config.

Missing README?

Some mods do not include their README in the files installed with the game. If a mod's guide is missing, copy its README into BepInEx/config/ReadMePEAK/ and name it with that mod's plugin ID followed by .md (for example, com.author.modname.md). Then reopen ReadMePEAK or choose Refresh.

Changelog

0.2.2

• Replace developer build notes in the packaged README with player install and usage instructions.

0.2.1

• Use F7 as the default menu key and migrate the old default F8 setting.
• Refresh the in-game menu styling.
• Add a button to expand the menu and restore its normal size.

0.2.0

• Browse loaded PEAK mods from an in-game list.
• Search mods by name, author ID, and plugin ID.
• Show a selected mod's bundled README or a locally supplied fallback file.
• Open and close the browser with F8.

0.1.0

• Initial in-game text reader prototype.