firren-ReadMePEAK icon

ReadMePEAK

Read README, mod guides, and notes in PEAK with a searchable in-game reader.

By firren
Last updated a day ago
Total downloads 40
Total rating 0 
Categories Mods Tools Quality Of Life Client Side
Dependency string firren-ReadMePEAK-0.2.3
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_PEAK-5.4.75301 icon
BepInEx-BepInExPack_PEAK

BepInEx pack for PEAK. Preconfigured and ready to use.

Preferred version: 5.4.75301

README

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.