Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 6.18 KB

INSTALL.md

File metadata and controls

115 lines (80 loc) · 6.18 KB
Raw

Installation Instructions

Useful Links

These are the links of the temporary home of the mod while the mod owners are unable to update the official repo.

Client - Automatic Installation

If you want to avoid the headache of manual installation at the cost of downloading a mod manager, I recommend r2modman, since it will automatically bundle the mod dependency for this mod.

  1. Install r2modman.
  2. Select Valheim, select a profile, go to the "online" mods tab, and search "ValheimPlus_Grantapher_Temporary"
  3. Click it, click "Download", select the latest version, start the game, verify the title screen, and then quit the game.
    • This will generate a configuration file for you.
  4. Configure the mod options, see the configuring section below.
  5. Start the game again, this time for real!

Manual Installation

Important exceptions

If any of these sections don't apply to you, skip them.

Hosted Server

If your server host automatically installs ValheimPlus for you, there is a chance it is installing the wrong version, which is broken with the current Valheim game. In this case, choose one of the installation ZIPs with Renamed in the filename.

The only difference is that the mod file has a different filename ValheimPlusGrantapher.dll, this is so that it doesn't get overwritten by your server host when it overwrites ValheimPlus.dll. Upon loading mods, BepInEx will recognize the two mods are the same and select the one with the newest version (ValheimPlusGrantapher.dll).

Unix

If you are running the game on Unix, your installation comes with two extra files compared to its Windows counterparts. For details on the additional steps you need to take, search for the text "Configuration (Linux" on the BepInExPack_Valheim page.

General Instructions

  1. Download the appropriate archive from the latest github release.

  2. Locate your game folder manually or start your Steam client and right-click the Valheim game. You can then right click the game in your library and select Manage -> browse local files for Steam to open your game folder.

    Browse Local Files Image

  3. Copy the contents of the zip into the game folder, overwriting any existing files.

  4. Start the game, verify the title screen, then exit it.

    • This will generate a configuration file for you.

  5. Configure the mod options, see the configuring section below.

  6. Start the game again, this time for real!

Verify the Installation

The title screen and logs will mostly verify that the mod is working before you load into the game.

Current Version Information

In the current mod release, you should have the following versions:

  • Valheim version 0.219.13 (n-32)
  • BepInEx version 5.4.22.0
    • BepInExPack_Valheim version 5.4.2202
      • This can be verified via logs only.
      • All the GitHub releases come with this version bundled.
      • Thunderstore supports having this dependency and installing it for you via a mod manager.
  • ValheimPlus version 0.9.15.0
    • (Grantapher) will be appended to the title screen (not the log) to signify that it is not the official mod.

For more info on compatibility of various V+ and Valheim versions, check out COMPATIBILITY.md.

Title Screen

The top left and bottom right corners of the title screen shows BepInEx, Valheim, and ValheimPlus version information. Make sure your version numbers match the current version information above.

Top Left:

Top Left

Bottom right:

Bottom right

Logs

When running Valheim with BepInExPack_Valheim installed, a log should automatically be opened when you start the game. If not, it can be found at %USERPROFILE%\AppData\LocalLow\IronGate\Valheim\Player.log on Windows.

Here are some sample logs that contain version information:

The BepInEx version is generally the first line of the player.log

[Message:   BepInEx] BepInEx 5.4.21.0 - valheim (3/28/2023 9:32:11 PM)

Followed by the BepInExPack_Valheim version if it is greater than version 5.4.2103.

[Message:   BepInEx] User is running BepInExPack Valheim version 5.4.2105 from Thunderstore

After that, the ValheimPlus version can be found below it.

[Info   :   BepInEx] Loading [Valheim Plus 0.9.9.13]

[Info   :Valheim Plus] ValheimPlus [0.9.9.13] is up to date.

Finally, after ValheimPlus has loaded, at some point Valheim itself will log its version.

[Info   : Unity Log] 03/28/2023 23:14:38: Valheim version:0.215.2

Configuration

Locate the configuration file and edit it with a text editor.

File Location

Installation Method Location
Manual Installation <game folder>/BepInEx/config/valheim_plus.cfg
R2ModMan %APPDATA%/r2modmanPlus-local/Valheim/profiles/<profile_name>/BepInEx/config/valheim_plus.cfg (replace <profile_name> with the name of your profile)
Thunderstore %APPDATA%/Thunderstore Mod Manager/DataFolder/Valheim/profiles/<profile_name>/BepInEx/config/valheim_plus.cfg (replace <profile_name> with the name of your profile)