﻿========================================================================
  JoshPack for R.E.P.O.  (v0.2.31)  --  Single-Player Install Guide
========================================================================

WHAT THIS IS
------------
JoshPack is one mod that bundles a bunch of quality-of-life tweaks for
R.E.P.O.: better map + scroll-wheel zoom, a scanner, enemy health/damage
display, unbreakable valuables, protected (indestructible-until-grabbed)
health packs sized to enemy difficulty (now color-coded orange/yellow so
you can spot them next to store packs), "liquidate" found shop items for
cash at extraction, per-upgrade caps, a confirm button at extraction
points, a single-player pause (the Escape menu actually freezes the game),
a rainbow (or color of your choice) for your head's dot on the map when you
die, and more. This guide gets it running for single-player.

You already have Thunderstore Mod Manager ("TMM") and R.E.P.O. installed,
so this only takes a couple of minutes.


WHAT'S IN THIS ZIP
------------------
  INSTALL.txt   <- this file
  JoshPack\     <- the mod itself (a folder with 3 files). You copy this
                   whole folder into the game's plugins folder in Step 3.


------------------------------------------------------------------------
STEP 1 - Make a profile (recommended)
------------------------------------------------------------------------
  1. Open Thunderstore Mod Manager and pick R.E.P.O.
  2. Create a NEW profile (name it e.g. "JoshPack") so this stays separate
     from any other mods you run. Select that profile.


------------------------------------------------------------------------
STEP 2 - Install the 3 required libraries (from Thunderstore)
------------------------------------------------------------------------
JoshPack needs these 3 free mods. Installing them ALSO auto-installs
BepInEx (the mod loader), so do this first.

In TMM's "Online" tab, search for and Download each one:

    * REPOLib      by Zehs        (tested with 4.2.0)   <- REQUIRED.
                                     JoshPack will not load without it.
    * MenuLib      by nickklmao   (tested with 2.5.4)   <- for the
                                     in-game settings menu.
    * REPOConfig   by nickklmao   (tested with 1.2.6)   <- for the
                                     in-game settings menu.

If TMM offers to install dependencies (such as BepInEx), say YES.


------------------------------------------------------------------------
STEP 3 - Add JoshPack itself
------------------------------------------------------------------------
JoshPack is a private build (not on Thunderstore), so you add it by hand:

  1. In TMM, open your profile's folder on disk. Look for
     "Settings" -> "Browse profile folder"  (or the button that opens
     the profile folder). It opens a File Explorer window.
  2. In that window, go into:   BepInEx\plugins
  3. Copy the "JoshPack" folder from THIS zip into that "plugins" folder.

  When done it should look like:
     ...\profiles\JoshPack\BepInEx\plugins\JoshPack\JoshPack.dll
     ...\profiles\JoshPack\BepInEx\plugins\JoshPack\com.github.zehsteam.ExtractionPointConfirmButton.dll
     ...\profiles\JoshPack\BepInEx\plugins\JoshPack\extractionpointconfirmbutton_assets

  (All 3 files live inside the JoshPack folder. Don't rename them.)


------------------------------------------------------------------------
STEP 4 - Play
------------------------------------------------------------------------
  1. Back in TMM, click "Start modded"  (NOT the normal Steam launch).
  2. Start a single-player game. Done!


------------------------------------------------------------------------
CHANGING SETTINGS
------------------------------------------------------------------------
  * In-game: open the mod config menu (provided by REPOConfig) from the
    game's settings screen and find the JoshPack sections.
  * Or edit the file directly:
        BepInEx\config\josh.repo.joshpack.cfg
    (inside your profile folder). It's created the first time you launch
    with JoshPack, and it starts with sensible single-player defaults.


------------------------------------------------------------------------
TROUBLESHOOTING
------------------------------------------------------------------------
  * "Nothing happened / mods didn't load":
      - Make sure you clicked "Start modded" in TMM, not the Steam button.
      - Make sure REPOLib is installed (Step 2).
  * Check the log for confirmation:
        BepInEx\LogOutput.log
      Look for the line:   JoshPack v0.2.31 loaded.
  * Game version: this build was tested on R.E.P.O. v0.4.4.3. If your game
    has auto-updated to a newer version, most things should still work; the
    log will print a note if the version differs.

------------------------------------------------------------------------
Note: The 3 libraries come from Thunderstore (so they stay updated and
properly credited); only JoshPack is copied in by hand because it's a
private build shared between friends.
========================================================================
