ghorsington / H3VR.Sideloader

[WIP] A plugin to sideload textures, meshes and prefabs to allow easy modification of guns
GNU Lesser General Public License v3.0
2 stars 2 forks source link
bepinex h3vr modding mods plugin sideloader

H3VR.Sideloader

Swap textures, materials, meshes and prefabs effortlessly

What is this?

H3VR.Sideloader is a BepInEx plugin for Hot Dogs, Horseshoes & Hand Grenades that allows to

How do I get it?

Requirements

Download these archives into the same folder:

Installation

Example video for the impatient

Full guide:

  1. Downloaded the requirements above and place them into the same folder
  2. Extract the downloaded folders into the game folder (<STEAM folder>/steamapps/common/H3VR) while following the README of each requirement!

    • It's recommended that you run the game now at least once. That way BepInEx initializes all the folders and configuration files.
    • Optional Enable the debug console by opening <H3VR folder>/BepInEx/config/BepInEx.cfg, finding and setting

      [Logging.Console]
      
      Enabled = true
  3. Create a Mods folder in H3VR folder (optional, will get generated manually as well)
  4. Run the game once for sideloader to initialize

How does it work?

Sideloader makes mod installation easy: all mods are packaged into single .h3mod (or .hotmod) files that are simple to install.
Each h3mod contains a special manifest file that provides necessary information for sideloader for asset swapping and additional metadata that can be useful in future mod managers.

How do I install a mod?

Quick tutorial video for the impatient

Simply take .h3mod or .hotmod that you obtained and place it into <H3VR Game Folder>/Mods folder. Refer to Steam guide on how to find your H3VR game folder.

Launch the game and you should have your mods installed an available!

How do I create a mod?

Textures (weapon and item skins):

Download latest SkinPacker.
Run the tool, fill the required info and press Pack h3mod.

Tutorial video

Meshes, materials, prefabs: WIP, there is no tool yet to do this automatically.
Refer to the wiki for info on how to create these packages manually.

Custom objects (weapons, spawner IDs): WIP, there is no tool yet to do this automatically.
Refer to the wiki for WIP info about creating new weapons.