Luxtorpeda-dev

Steam Play compatibility tool to run games using native Linux engines

Pre-requisites

Compatibility tool will work on any modern 64-bit Linux distribution. All packaged games are compiled for Steam Runtime Soldier environment and require no additional dependencies.

Using Luxtorpeda with Steam native runtime may or may not work, but is not supported.

Installation (using tarball)

This is pre-release quality software, expect bugs and missing features.

The packages.json for the supported packages and getting the latest versions will get updated on each launch of luxtorpeda, without any input needed from the user. New releases of the luxtorpeda client will need to be downloaded manually, but a new release of the client is not required when a package is created or updated, unless that package depends on a new feature (which will be noted in the release notes).

Close Steam.
Download latest version at https://github.com/luxtorpeda-dev/luxtorpeda/releases

Move and unpack tarball to compatibilitytools.d directory (create one if it does not exist):

 $ cd ~/.local/share/Steam/compatibilitytools.d/ || cd ~/.steam/root/compatibilitytools.d/
 $ tar xJf luxtorpeda-56.tar.xz

Start Steam.
In game properties window select "Force the use of a specific Steam Play compatibility tool" and select "Luxtorpeda".

Installation (using GUI)

Download ProtonUp-Qt from here: https://davidotek.github.io/protonup-qt/#download
Run ProtonUp-Qt and select Steam
Click Add Version, select Luxtorpeda and press Install
Restart Steam
In Steam game properties window select "Force the use of a specific Steam Play compatibility tool" and select "Luxtorpeda".

Installation (debug build, from source)

Download the latest version of Rust: https://www.rust-lang.org/ and verify that openssl is installed on your system.

Debian, Ubuntu and variants

   $ sudo apt install libssl-dev

Fedora

   $ sudo dnf install openssl-devel

Arch

   $ sudo pacman -S openssl rust

Close Steam.

Clone the repository, then use makefile to trigger cargo build and install:

$ git clone https://github.com/luxtorpeda-dev/luxtorpeda.git
$ cd luxtorpeda
$ make user-install

Start Steam.
In game properties window select "Force the use of a specific Steam Play compatibility tool" and select "Luxtorpeda (dev)".

Development on Steam Deck

Open desktop mode and download the luxtorpeda repo to a directory on the deck.
Install flatpak org.freedesktop.Sdk/21.08 (should have glibc 2.33, as of current steam deck glibc version).
Run the following: flatpak run --command=bash -d --filesystem=home --share=network org.freedesktop.Sdk//21.08
Install rustup: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Go into the luxtorpeda directory and run cargo build. Then copy target/debug/luxtorpeda into the correct directory.

Configuration

A configuration json file named config.json will be located in the luxtorpeda directory. It has the following parameters:

host_url - This is used to determine where the packages.json file is located remotely, for use in automatic updates of this file.
should_do_update - If this parameter is set to true, then the packages.json file will be updated automatically.
use_controller - If this parameter is set to true, then attempts to access controllers through SDL2. Defaults to true.
disable_default_confirm - Disables default engine confirmation dialog. Defaults to false. This can be done globally in the config.json by setting disable_default_confirm to true, or setting LUX_DISABLE_DEFAULT_CONFIRM=1 %command% in the launch options of a particular game. Setting LUX_DISABLE_DEFAULT_CONFIRM=0 %command% will enable the confirmation if the config variable is set to disabled for that particular game.

Logs will be written to file if LUX_WRITE_LOGGING=1 is set. The log file will be located at ~/.local/state/luxtorpeda/luxtorpeda.log.

User Packages Override

A ~/.config/luxtorpeda/user-packages.json file can be created, which will allow custom package information without having to change the normal packages.json file. This file should have the same format as packages.json, but can have either new games or overrides to existing games. See luxtorpeda-dev#65 for more information.

User Interface

When a prompt appears from the client, it will accept input from controllers, keyboard or mouse. These prompts can include the engine chooser, progress indicator, error notices, and questions. The input works the following way:

Keyboard and Mouse

Keyboard and mouse are always supported, even if a controller is detected.
Keyboard icons will appear in the buttons if no controllers are detected. Keyboard arrows can be used to navigate the choices.

Controllers

SDL2's SDL_GameController is used to detect and accept inputs from controllers, other than the steam controller, so any controller that supports that interface should work.
Controller icons will appear in the buttons if a controller is detected.
- Icons are only available for controllers in the testing list below, with it falling back to the Xbox controller icons if an unknown controller is detected.
- Input with that controller should still work but the icons may be incorrect. If additional controller support is wanted, feel free to open an issue.
The following controllers have been tested:
- Xbox One Controller
- PS4 Controller (PS5 Controller should work and use PS4 icons)
- Switch Pro Controller (Will show icons)
- Steam Controller - The Steam Controller will act as a keyboard and mouse, like in desktop mode.

For using controllers in the engine itself, ensure that Steam Input is enabled, that a gamepad profile has been set, and that the Steam Input controller-specific option has been enabled, such as for Xbox or Playstation controllers.

Steam Deck

Thanks to help with testing from LiamD at GamingOnLinux, luxtorpeda works with the Steam Deck! See more information at https://www.gamingonlinux.com/2022/03/steam-deck-using-luxtorpeda-for-morrowind-warzone-2100-and-x-com/
Gamepad support relies on the steam input settings. If steam input for the game is set as a gamepad, then will show controller icons and work as a controller. Otherwise, can use the touchscreen as a mouse.
Setting a game to use luxtorpeda can be done in desktop or gaming mode, using the compatibility options.

Supported titles

Just click "Play" and Luxtorpeda will download and install the package for you. You need to select Luxtorpeda as a compatibility tool first, of course.

When you launch a game that supports multiple engines, a prompt will appear asking for the engine that should be downloaded and launched. Once the engine has been picked, a second prompt will ask if the engine should become the default. Launches after this if "Yes" is picked in this dialog will not ask for the engine again. A file can be deleted to restore the engine prompt for a particular game. The file will have the following format: ~/.config/luxtorpeda/<app_id>/default_engine_choice.txt

To see a list of supported titles, go to https://luxtorpeda-dev.github.io

Want a specific game?

Check issues to see if we are working on it.

You can also make a package request by creating a new issue

You can also create a package yourself

Development

You can use cargo as with any Rust project; make serves only as a convenient frontend for packaging and triggering longer cargo commands.

ThibaultLemaire/luxtorpeda