snowybunny-PeakAMap icon

PeakAMap

Find out what biomes are currently in rotation and select a map to play with an in-game UI.

Last updated 2 days ago
Total downloads 544
Total rating 1 
Categories Mods Host Only
Dependency string snowybunny-PeakAMap-1.0.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_PEAK-5.4.2403 icon
BepInEx-BepInExPack_PEAK

BepInEx pack for PEAK. Preconfigured and ready to use.

Preferred version: 5.4.2403

README

PeakAMap

Find out what biomes are currently in rotation and select a map to play with an in-game UI.

PeakAMap searches through each map to find out what biomes they have and lets players pick from them. There shouldn't be, but there may be inaccuracies. For performance reasons, the loading and searching is done beforehand and saved in a file included with PeakAMap. If this file is missing or a new patch happens, then PeakAMap will automatically create this file when the game starts. For slower PCs, this process may take 2-4 minutes.

Currently Supports: PEAK 1.54.c

Features

  • Use a UI to Select a Map to Play

    • Biomes of each map are displayed.
    • Choose to play a custom map or to play the daily map.
  • Biomes are Displayed in the HUD During Your Run

    [!TIP] Tip: This feature is optional. If you don't like having extra text on your screen, this feature can be disabled in your .cfg file. Instructions on how to do this is further below.

  • Map Rotation Info is Preloaded for the Suppported PEAK Version

    • Currently supporting PEAK 1.54.c
  • Support for Future Map Patches

    • PeakAMap SHOULD still display correct information when PEAK patches in new maps.
    • If PeakAMap doesn't have data for the current patch or there are issues with the file containing this data, the map rotation info will be loaded, searched, and saved at the game's start

      [!TIP] Tip: This feature is optional. If you're only interested in selecting a map without the biome info or if preloading takes too long. This feature can be disabled in your .cfg file. Instructions on how to do this is further below.

  • Partial Language Support

    • Some phrases/words that were already supported in game will be supported in PeakAMap.
  • Biome Variant and Open Tomb Info

    • Extra information on current maps are stored in the .\BepInEx\plugins\PeakAMap\data\ folder in map_rotation-<version>.json. (Note: The <version> refers to the PEAK game version, not PeakAMap mod version).

      [!NOTE] Note: Only available inside of file. Not shown in game. Currently, you can only view the biome variant and open tomb information in the PeakAMap's data file. There are plans to add a way to display these in game, but it is not supported at the moment.

      [!CAUTION] Caution: DO NOT modify these files. Doing so may cause inaccurate biome information to display in the PeakAMap UI or preloading to start due to failure to read the file.

Installation

Method 1: Using a Mod Manager

  1. Install a Thunderstore-compatible mod manager, such as r2modman or GaleModManager.
  2. Search for BepInExPack_PEAK in your mod manager app and install OR go to BepInEx in Thunderstore and click "Install with Mod Manager" > "Open" > "Install".
  3. Search for PeakAMap in your mod manager app and install OR go to PeakAMap in Thunderstore link and click "Install with Mod Manager" > "Open" > "Install".
  4. Make sure both mods are enabled and run PEAK from of your mod manager and play.

Method 2: Manual Install

  1. Opening PEAK game folder:

    • Open Steam > "Library" > "PEAK" > gears/settings icon > "Manage" > "Browse local files"

    • This should open the PEAK folder. Keep this folder opened as you continue.

  2. Installing BepInEx:

    • Go to BepInEx Thunderstore page > "Manual Download".

    • This downloads a .zip file. Navigate to this (likely in your "Downloads" folder).

    • Extract the .zip file. (DO NOT extract inside of the PEAK game folder.)

    • Open the extracted folder (if it didn't automatically open).

    • Go to BepInExPack_PEAK > Select all its contents > Move everything to the PEAK game folder you kept open in step 1.

    • The final PEAK folder should similar to the following:

    • Now, in the PEAK folder, go to BepInEx > plugins. Keep this folder opened as you continue.

  3. Installing PeakAMap:

    • Go to PeakAMap Thunderstore page > "Manual Download".

    • This downloads a .zip file. Navigate to this (likely in your "Downloads" folder).

    • Extract the .zip file.

    • Open the extracted folder (if it didn't automatically open).

    • Go to plugins > Move PeakAMap folder into the PEAK/BepInEx/plugins folder you kept open in step 2.

    • The final PEAK/BepInEx/plugins folder should similar to the following (there will be more files/folders if you have more mods installed):

  4. Run PEAK from Steam and play.

Configuration:

With the .cfg file, you can:

  • Disable or enable biomes from showing in the HUD.
  • Disable or enable map rotation info from loading at the game's start when data files are missing.

Instructions:

  • Run PEAK with PeakAMap once and quit game.
  • Edit the .cfg file one of two ways:
    1. If you installed PeakAMap with a mod manager, you can edit the .cfg file with your mod manager app.
    2. If you installed PeakAMap manually:
      • Open Steam > "Library" > "PEAK" > gears/settings icon > "Manage" > "Browse local files" > BepInEx > config
      • Open com.github.snowybunny.PeakAMap.cfg.
      • Set the values to "true" or "false" according to your preference.
  • If your game is still running. Quit and relaunch to apply settings.

Extra Screenshots:

Loading screen when data is missing:

Biomes in HUD with Tenderfoot difficulty:

Examples of language support: