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.
- When Proton is used, DLCs don't work without installing the native version of the game. A pending download is also sufficient. For the details, see issue #253.
- If D3D11 rendering backend is used, TruckersMP login screen is not shown without Windows native 64-bit
d3dcompiler_47.dll
truckersmp-cli
will automatically download and set up the Windows native dll when D3D11 is used
- 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.
- If there are game MOD files with German umlauts
ü
andß
in filename, game crashes on German locale. For the details, see issue #248.
If available install from your repository. Updates will ship through your normal system update process.
Operation | System-wide | Per-user (recommended) |
---|---|---|
Installation | python3 -m pip install truckersmp-cli |
python3 -m pip install --user truckersmp-cli |
Optional dependencies | python3 -m pip install truckersmp-cli[optional] |
python3 -m pip install --user truckersmp-cli[optional] |
Update | python3 -m pip install truckersmp-cli --upgrade |
python3 -m pip install --user truckersmp-cli --upgrade |
Additional information | This usually requires root permission and can interfere with other python packages installed through your normal repository so be careful. | Make sure the binary path (e.g. $HOME/.local/bin ) is in your $PATH . |
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.
python
in version 3.6 (released in December 2016) or latersdl2
in x86_64steam
either the native Linux version in use with Proton or the Windows Steam in use with Wine
pkg_resources
(part ofsetuptools
) to get the version information from the Python packagevdf
to automatically detect the steam account with saved credentialswine
as a possible replacement to Proton
$ truckersmp-cli (options...) [action] [game name]
Name | Description |
---|---|
start |
Start game |
update |
Update/install latest game |
downgrade |
Downgrade game (install game from temporary_X_Y branch) |
updateandstart (or ustart ) |
update + start (Default) |
downgradeandstart (or dstart ) |
downgrade + start |
kill |
Kill running processes in the same Wine prefix |
Name | Game |
---|---|
ets2mp |
ETS2 multiplayer (Default) |
ets2 |
ETS2 singleplayer |
atsmp |
ATS multiplayer |
ats |
ATS singleplayer |
Short option | Long option | Description |
---|---|---|
-h |
--help |
Show help |
-b VERSION |
--beta VERSION |
Set game version to VERSION, useful for downgrading (e.g. temporary_1_35 ) |
-c FILE |
--configfile FILE |
Use alternative configuration file Default: $XDG_CONFIG_HOME/truckersmp-cli/truckersmp-cli.conf |
-f |
--flatpak-steam |
Use Flatpak version of Steam with Proton Note: Currently Steam Runtime is not supported and will be disabled |
-g DIR |
--gamedir DIR |
Choose a different directory for the game files Default: $XDG_DATA_HOME/truckersmp-cli/(Game name)/data |
-i APPID |
--proton-appid APPID |
Choose a different AppID or version name ("X.Y" format) of Proton (Needs an update for changes) |
-l LOG |
--logfile LOG |
Write log into LOG, -vv option is recommendedDefault: Empty string (only stderr) Note: Messages from Steam/SteamCMD won't be written, only from this script See #game-logs for game log locations. |
-m DIR |
--moddir DIR |
Choose a different directory for the mod files Default: $XDG_DATA_HOME/truckersmp-cli/TruckersMP |
-n NAME |
--account NAME |
Steam account name to use |
-o DIR |
--protondir DIR |
Choose a different Proton directory Default: $XDG_DATA_HOME/truckersmp-cli/Proton |
-p |
--proton |
Start the game with Proton Default on Linux if neither Proton or Wine are specified |
-r {auto,dx11,gl} |
--rendering-backend {auto,dx11,gl} |
Choose a rendering backend Default: auto OpenGL is used when rendering-backend is not specified for the game in the configuration file |
-v |
--verbose |
Verbose output none: error, once: info, twice or more: debug |
-w |
--wine |
Start the game with Wine Default on systems other than linux if neither Proton or Wine are specified |
-x DIR |
--prefixdir DIR |
Choose a different directory for the prefix Default: $XDG_DATA_HOME/truckersmp-cli/(Game name)/prefix |
(Not available) | --check-windows-steam |
Check for the Windows Steam version on updating when using Proton |
(Not available) | --disable-proton-overlay |
Disable Steam Overlay when using Proton |
(Not available) | --disable-steamruntime |
Don't use Steam Runtime even when using Proton 5.13 or newer |
(Not available) | --download-throttle SPEED |
Limit download speed to SPEED (KiB/s), disabled if negative value is specified Default: -1 |
(Not available) | --game-options OPTIONS |
Specify ATS/ETS2 options Default: -nointro -64bit Note: If specifying only one option, use --game-options=-option format |
(Not available) | --native-steam-dir |
Choose native Steam installation, useful only if your Steam directory is not detected automatically Default: auto |
(Not available) | --self-update |
Update files to the latest release and quit |
(Not available) | --skip-update-proton |
Skip updating already-installed Proton when updating game with Proton enabled |
(Not available) | --steamruntimedir |
Choose a different Steam Runtime directory for Proton 5.13 or newer |
(Not available) | --use-wined3d |
Use OpenGL-based D3D11 instead of DXVK when using Proton |
(Not available) | --wine-desktop SIZE |
Use Wine desktop, work around resolution issue, mouse clicking won't work in other GUI apps while the game is running, SIZE must be 'WIDTHxHEIGHT' format (e.g. 1920x1080) |
(Not available) | --wine-steam-dir |
Choose a directory for Windows version of Steam Default: C:\Program Files (x86)\Steam in the prefix |
(Not available) | --without-wine-discord-ipc-bridge |
Don't use wine-discord-ipc-bridge for Discord Rich Presence |
(Not available) | --version |
Print version information and quit |
- Clone or download this repository
- Run
make
in the main folder to build the injector executable. Bash/zsh completion files will also be generated. - Optional run
setup.py
to manually start the installation process.
gcc-mingw-w64
to build the injector executablemake
git
to clone this repo and help developingsetuptools
to runsetup.py
make
generates shell completion files for bash (bash-completion) and zsh. They enable tab-completion of available positional arguments and command-line options.
Shell | System-wide search paths |
---|---|
bash | $(pkg-config --variable=completionsdir bash-completion) (e.g. /usr/share/bash-completion/completions/ ), /usr/local/share/bash-completion/completions/ |
zsh | /usr/share/zsh/site-functions/ , /usr/local/share/zsh/site-functions/ |
- The bash-completion file
truckersmp-cli.bash
needs to be renamed totruckersmp-cli
- Debian-based systems are using the
/usr/share/zsh/vendor-completions/
directory for zsh completions
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"
Copy _truckersmp-cli
to a directory that is part of $fpath
and run compinit
.
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.
$ truckersmp-cli update ets2mp
$ truckersmp-cli start atsmp
When the latest game version is not compatible with TruckersMP yet, the user can downgrade the games with truckersmp-cli downgrade [game name]
which installs the latest version that is supported by TruckersMP by determining the Steam game branch name by using TruckersMP Web API.
$ truckersmp-cli downgrade ets2mp
--beta
option can be used to specify the branch name directly.
$ truckersmp-cli --beta temporary_1_39 downgrade ets2mp
If both options are given, the branch name from --beta
option is used.
$ truckermsp-cli --gamedir "/path/to/gamedir" ustart atsmp
$ truckersmp-cli --wine start ets2mp
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
$ truckersmp-cli --proton --prefixdir "/path/to/prefix" start ets2mp
$ truckersmp-cli --wine --prefixdir "/path/to/prefix/pfx" start ets2mp
- 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.
- Stable and faster than wined3d. But slower than DXVK.
- Useful if you're not using Vulkan-capable GPU.
- 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.
- When using Proton, wined3d can be used by specifying
- Used only when
-r dx11
or--rendering-backend dx11
is given.
It's possible to set various game settings and third party programs in a configuration file.
The configuration file format is similar to the INI format known from Windows with several sections [section]
containing key-value-pairs key = value
.
All sections are optional and a key-value-pair has to be in a section.
Boolean values can be {yes,no}
, {true,false}
, {on,off}
and {1,0}
.
The default search path for the file is $XDG_CONFIG_HOME/truckersmp-cli/truckersmp-cli.conf
.
Supported sections are [ats]
, [atsmp]
, [ets2]
and [ets2mp]
.
Settings in [DEFAULT]
will be applied to all game modes if the game mode specific sections exist.
Key-Value-Pair | Description |
---|---|
without-rich-presence = [boolean] |
Disable Discord Rich Presence for the game mode - overriding what is set in third party sections. Default: no |
game-directory = [path] |
Choose a different directory for the game files Default: $XDG_DATA_HOME/truckersmp-cli/(Game name)/data |
prefix-directory = [path] |
Choose a different directory for the prefix Default: $XDG_DATA_HOME/truckersmp-cli/(Game name)/prefix |
game-options = [options] |
Specify ATS/ETS2 options Default: -nointro -64bit |
rendering-backend = {auto,dx11,gl} |
Choose a rendering backend Default: auto (OpenGL is used when this is not specified for the game in the configuration file) |
proton-directory = [path] |
Choose a different Proton directory Default: $XDG_DATA_HOME/truckersmp-cli/Proton |
steamruntime-directory = [path] |
Choose a different Steam Runtime directory for Proton 5.13 or newer |
disable-steamruntime = [boolean] |
Don't use Steam Runtime even when using Proton 5.13 or newer Default: no |
disable-proton-overlay = [boolean] |
Disable Steam Overlay when using Proton Default: no |
log-file = [path] |
Write log into the specified file, -vv option is recommendedDefault: Empty string (only stderr) Note: Messages from Steam/SteamCMD won't be written, only from this script (Game logs are written into My Documents/{ETS2,ATS}MP/logs/client_*.log ) |
truckersmp-directory = [path] |
Choose a different directory for the mod files Default: $XDG_DATA_HOME/truckersmp-cli/TruckersMP |
Third party programs in the configuration file will get started together with the game.
Sections should follow the format [thirdparty.gamemode.programname]
(one game mode) or [thirdparty.programname]
(all game modes).
Key-Value-Pair | Description |
---|---|
executable = /path/to/my.exe |
Path to the executable where the path is either an absolute unix path (/path/to/my.exe ), a relative unix path (program/my.exe ) to $XDG_DATA_HOME/truckersmp-cli/ or an absolute windows path (C:\Program Files (x86)\program\my.exe ) within the prefix. |
Key-Value-Pair | Description |
---|---|
wait = [seconds] |
Set a minimal waiting time before the game will be started so third party programs have enough time to fully start up and log in. |
wants-rich-presence = [boolean] |
Set that a program supports Discord Rich Presence. |
# Common settings
# Game mode specific sections are needed too to apply these settings
[DEFAULT]
# D3D11 will be enabled in all games
rendering-backend = dx11
# Use unofficial version of Proton in all games
proton-directory = /path/to/proton-tkg-6.8
# Disable Steam Runtime as a workaround
disable-steamruntime = true
# Forbid Discord Rich Presence in multiplayer of ETS2
[ets2mp]
without-rich-presence = true
# Even if there are no game specific settings for ATSMP,
# the empty section is needed if the user wants to apply the settings
# in the "[DEFAULT]" section
[atsmp]
# Game mode specific settings for ETS2 singleplayer
[ets2]
# Use custom game options only when starting singleplayer of ATS
[ats]
game-options = -mm_pool_size 600 -nointro -64bit
# Start Trucky together with all game modes (ats, atsmp, ets2, ets2mp)
# and wait at least 45 seconds before starting the game
[thirdparty.trucky]
executable = /home/user/Downloads/trucky/trucky.exe
wait = 45
# Start TrucksBook together with ets2mp while waiting at least 30 seconds
# before starting the game
[thirdparty.ets2mp.trucksbook]
executable = C:\Program Files (x86)\TrucksBook Client\TB Client.exe
wait = 30
# Start a program from "$XDG_DATA_HOME/truckersmp-cli/my program/" and
# set that Discord Rich Presence is supported for this program
[thirdparty.ets2.program]
executable = my program/executable.exe
wants-rich-presence = true
$XDG_CONFIG_HOME/truckersmp-cli/truckersmp-cli.conf
Game | Path |
---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/ |
Game | Path |
---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/ |
Game | Proton | Wine |
---|---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/steamuser/My Documents/American Truck Simulator/profiles/ |
$XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/(os_login_name)/My Documents/American Truck Simulator/profiles/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/steamuser/My Documents/Euro Truck Simulator 2/profiles/ |
$XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/(os_login_name)/My Documents/Euro Truck Simulator 2/profiles/ |
Game | Proton | Wine |
---|---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/steamuser/My Documents/American Truck Simulator/game.log.txt |
$XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/(os_login_name)/My Documents/American Truck Simulator/game.log.txt |
ATSMP | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/steamuser/My Documents/ATSMP/logs/ |
$XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/(os_login_name)/My Documents/ATSMP/logs/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/steamuser/My Documents/Euro Truck Simulator 2/game.log.txt |
$XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/(os_login_name)/My Documents/Euro Truck Simulator 2/game.log.txt |
ETS2MP | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/steamuser/My Documents/ETS2MP/logs/ |
$XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/(os_login_name)/My Documents/ETS2MP/logs/ |
Game | Proton | Wine |
---|---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/steamuser/My Documents/American Truck Simulator/mod/ |
$XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/(os_login_name)/My Documents/American Truck Simulator/mod/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/steamuser/My Documents/Euro Truck Simulator 2/mod/ |
$XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/(os_login_name)/My Documents/Euro Truck Simulator 2/mod/ |
Game | Proton | Wine |
---|---|---|
ATS | $XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/steamuser/My Documents/ATSMP/mod/ |
$XDG_DATA_HOME/truckersmp-cli/American Truck Simulator/prefix/pfx/drive_c/users/(os_login_name)/My Documents/ATSMP/mod/ |
ETS2 | $XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/steamuser/My Documents/ETS2MP/mod/ |
$XDG_DATA_HOME/truckersmp-cli/Euro Truck Simulator 2/prefix/pfx/drive_c/users/(os_login_name)/My Documents/ETS2MP/mod/ |
See TruckersMP Knowledge Base.
- 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.