truckersmp-cli

A simple launcher for TruckersMP to play ATS or ETS2 in multiplayer.

truckersmp-cli allows to download TruckersMP and handles starting TruckersMP through Wine while supporting the Windows versions of American Truck Simulator and Euro Truck Simulator 2.

The Windows version of Steam should already be able to run in the same Wine prefix. The Windows versions of ATS and ETS2 can be installed and updated via SteamCMD while all running Steam processes will be stopped to prevent Steam from loosing connection. Your Steam password and guard code are required by SteamCMD once for this to work.

On Linux it's possible to start TruckersMP through Proton. A working native Steam installation is needed for this which has the desired game installed or with an update pending. SteamCMD can use your saved credentials for convenience.

Known issues

• It was reported that "ProMods + ETS2MP" crashes with Proton 5.13 but Proton 5.0 works (issue #147)
• If (default) OpenGL rendering backend is used, game crashes due to a bug in Multiplayer DLL when trying to choose a color for "Player tag" or "Players on the world map" (issue #91)
  • A workaround is to use D3D11 rendering backend by specifying -d (--enable-d3d11)
• If D3D11 rendering backend is used, TruckersMP login screen is not shown without Windows native 64-bit d3dcompiler_47.dll
  • truckersmp-cli provides --activate-native-d3dcompiler-47 option as a workaround: When this is specified with -s (--start), truckersmp-cli downloads/activates the DLL
    • Once the DLL is activated, there's basically no need to specify the option again
    • When downgrading Proton, the native DLL is removed: Then --activate-native-d3dcompiler-47 is needed again

Install

From repository (recommended)

System repository (recommended)

If available install from your repository. Updates will ship through your normal system update process.

Python Package Index

Manual download

You can get the latest pre-built release from the release page and decompress it into the desired folder. This version is capable to update itself by running --self-update so make sure it's placed in a folder where your user has write permissions.

Runtime dependencies

Required

• python in version 3.3 (released in September 2012) or later
• sdl2 in x86_64
• steam either the native Linux version in use with Proton or the Windows Steam in use with Wine

Optional

• pkg_resources (part of setuptools) to get the version information from the Python package
• vdf to automatically detect the steam account with saved credentials
• wine as a possible replacement to Proton

Usage options

Proton versions and AppIDs

Build

1. Clone or download this repository
2. Run make in the main folder to build the injector executable. Bash/zsh completion files will also be generated if genzshcomp is available.
3. Optional run setup.py to manually start the installation process.

Buildtime dependencies

Required

• gcc-mingw-w64 to build the injector executable
• make

Optional

• genzshcomp to generate bash/zsh completions
• git to clone this repo and help developing
• setuptools to run setup.py

bash/zsh completion

If genzshcomp is installed, make generates shell completion files for bash (bash-completion) and zsh. They enable tab-completion of available command-line options.

System-wide installation

• The bash-completion file truckersmp-cli.bash needs to be renamed to truckersmp-cli
• Debian-based systems are using the /usr/share/zsh/vendor-completions/ directory for zsh completions

Per-user installation

bash

Copy truckersmp-cli.bash to $XDG_DATA_HOME/bash-completion/completions/truckersmp-cli.

$ mkdir -p "${XDG_DATA_HOME:-~/.local/share}/bash-completion/completions"
$ cp truckersmp-cli.bash "${XDG_DATA_HOME:-~/.local/share}/bash-completion/completions/truckersmp-cli"

zsh

Copy _truckersmp-cli to a directory that is part of $fpath and run compinit.

Usage examples

Basic

Everything default

To just try out TruckersMP (ETS2) on Linux with nothing already downloaded you can simply run truckersmp-cli which will download everything needed to get you going with Proton and a native Steam installation.

Install and update Euro Truck Simulator 2

$ truckersmp-cli --ets2 --update

Start American Truck Simulator with TruckersMP

$ truckersmp-cli --ats --start

Advanced

Install, update and start TruckersMP (ATS) with Proton from a custom location

$ truckermsp-cli --ats --update --start --gamedir "/path/to/gamedir"

Start TruckersMP (ETS2) using Wine

$ truckersmp-cli --ets2 --start --wine

Make sure that

• The Windows version of Steam is already running in the same Wine prefix or
• The Windows version of Steam is installed in C:\Program Files (x86)\Steam in the same Wine prefix or
• You're specifying the path to the Window version of Steam with --wine-steam-dir

Using a different prefix location

$ truckersmp-cli --ets2 --start --proton --prefixdir "/path/to/prefix"
$ truckersmp-cli --ets2 --start --wine --prefixdir "/path/to/prefix/pfx"

• While the prefix for Wine will point directly to the prefix location, Proton uses a subfolder pfx for the actual prefix and points to the parent folder.
• Your prefix must be 64bits, the mod is not 32bits-compatible.

Rendering backends

OpenGL (default)

• Stable and faster than wined3d. But slower than DXVK.
• Useful if you're not using Vulkan-capable GPU.

Direct3D 11 (DXVK or wined3d)

• Faster than OpenGL when DXVK is used.
  • DXVK requires Vulkan support.
  • DXVK 1.4.6 or newer is needed because older versions have rendering issue. If you're using Proton, use 4.11-10 or newer.
• Proton uses DXVK by default.
  • When using Proton, wined3d can be used by specifying --use-wined3d, but it's not recommended because this is slower than OpenGL.
• Used only when -d or --enable-d3d11 is specified.

Default directories

Game data

Wineprefix

Game logs

Singleplayer mods and ProMods

Season (weather) mods for ETS2MP/ATSMP

See TruckersMP Knowledge Base.

Additional information

• If Steam is running while SteamCMD is being used the Steam client looses all connections and maybe asks for the password and the guard code at the next startup. This script closes all Steam processes before acting with SteamCMD so starting an update with a shortcut out of the Steam client won't work because Steam waits for the script to finish and the script waits for Steam to quit.

Credits

• I was greatly inspired by mewrev's Inject tool and TheUnknownNO's unofficial TruckersMP-Launcher.
• Amit Malik's article on dll injection was also a great help.
• kakurasan and Lucki for the helper script.