You are viewing a potentially older version of this package. View Latest Version
ReadMePEAK
Read README, mod guides, and notes in PEAK with a searchable in-game reader.ReadMePEAK
Read README files for your PEAK mods in game.
How to use
- Install ReadMePEAK with Thunderstore or your usual PEAK mod manager.
- Launch PEAK with mods enabled.
- Press F7 to open the mod browser.
- 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.