ReadMePEAK
Read README, mod guides, and notes in PEAK with a searchable in-game reader.ReadMePEAK
ReadMePEAK adds an in-game browser for the README files that come with your PEAK mods.
In game
- Press F7 to open or close the browser.
- Use Make bigger to expand the reader, then Restore size to return to the normal view.
- Search the loaded mod list by mod name or plugin ID.
- Select a mod to read its README in the right-hand panel.
- Press Refresh to update the list after the game loads mods.
The key can be changed in BepInEx/config/ReadMePEAK.ReadMePEAK.cfg.
README files
ReadMePEAK looks beside each loaded mod plugin for README.md, README.txt, or README.rst. If the README is not included in the files installed with the mod, copy it into BepInEx/config/ReadMePEAK/ and name it with that mod's plugin ID, for example com.author.modname.md. The browser also accepts a file named after the mod's display name.
Thunderstore's package README is often only package listing information, so it may not be present in the installed plugin files. The custom folder is the offline fallback for those mods.
Build
This project uses the PEAK BepInEx 5 template and requires .NET SDK 10 or newer. Build it with:
dotnet build -c Release
The Thunderstore package is written to artifacts/thunderstore/release/. To copy the plugin into your game automatically while developing, copy Config.Build.user.props.template to Config.Build.user.props and adjust the PEAK install path if needed.