Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 4.5 KB

INSTALL.md

File metadata and controls

100 lines (64 loc) · 4.5 KB
Raw

Installing ModTek v3

Note ModTek v3 or later does not have a ModTekInjector.exe anymore, and instead it uses UnityDoorstop, which is based on hooking via libraries. OS platforms (Windows, Linux, Mac) and game distribution platforms (Steam, GOG) are supported.

Warning For ModTek to work properly, BATTLETECH should be installed outside of the program files folder structure, as that is protected by UAC and therefore interferes with ModTek.

Installation of ModTek is straightforward for Windows. You download the ModTek.zip file and extract it to the directory of the game.

  1. Download the latest stable release from github.
  2. Extract the contents of the zip as-is to BATTLETECH/ so that the Mods/ folder in the zip appears as BATTLETECH/Mods/ and the UnityDoorstop files (winhttp.dll etc..) appear directly under BATTLETECH/.

Note BATTLETECH/ refers to the installation folder where BattleTech.exe can be found.

On game startup, ModTek decorates the version number found in the bottom left corner of the main menu with /W MODTEK. If you don't see this something has gone wrong.

Linux

The Modtek zip also contains the UnityDoorstop script run.sh and the hooking libraries to run the game with.

Steam on Linux

Note These instructions are based on the Steam Guide for BepInEx.

Instead of running the run.sh script directly, you need to ask Steam to run it for you.

Right mouse click on the game in the Steam library -> Properties... -> SET LAUNCH OPTIONS.

Launch options for Linux:

./run.sh %command%

GOG on Linux

GOG installs into battletech/game/. Extract the zip file into the same directory as the Battletech executable.

Modify the start.sh script from GOG to execute the run.sh script supplied by ModTek/UnityDoorstop instead of BattleTech.

#chmod +x "BattleTech"
#./"BattleTech"
./run.sh

Proton/Wine on Linux

Using Proton or Wine is also supported, make sure the winhttp.dll from UnityDoorstop is loaded by setting the override to native, builtin.

mono crash on Linux

If a crash happens with the following error

Receiving unhandled NULL exception
#0  0x007f981f25cab9 in mini_get_debug_options
#1  0x007f982693674c in init_mono

Add a file /etc/sysctl.d/01-disable-aslr.conf with contents

kernel.randomize_va_space = 0

macOS

Note The installation instructions for macOS are similar to Linux, only differences are listed here.

The base installation folder is the Contents/Resources directory within the .app Application packages. For a standard Steam installation that means the following path:

~/"Library/Application Support/Steam/steamapps/common/BATTLETECH/BattleTech.app/Contents/Resources/"

Steam on macOS

Launch options for macOS need to contain the absolute path to the run script. In a terminal, run this from the same location where the run script is:

echo "\"$(pwd)/run.sh\" %command%"

The launch options should then look something like this:

"/Users/ReplaceThisByYourUsername/Library/Application Support/Steam/steamapps/common/BATTLETECH/BattleTech.app/Contents/Resources/run.sh" %command%

Enabling or Disabling

Obsolete Please report if this feature still works and/or if this is still in use.

ModTek 0.7.6 or higher can be enabled or disabled from within the in-game mods menu. If ModTek is enabled, the "MODS ENABLED" check box will always be set to enabled. To disable ModTek look through the mod list until you find 'ModTek', and disable that 'mod'. Restart the game, and only the in-game mod-loader will be used. Repeat the process but enable the 'ModTek' mod to re-enable an external ModTek install.

Warning You must restart the game to enable or disable an external ModTek!

What is UnityDoorstop and what those files like winhttp.dll

Unity DoorStop provides a set of files that trick Unity into loading ModTek, but without modifying the game files. The old way was asking the user to run a ModTekInjector.exe manually, which modified the game so it loaded ModTek. In cases of updates, the old way required the user to "verify" the game files and re-install mods, but using UnityDoorstop this is not necessary anymore.