Skip to content

Latest commit

 

History

History
189 lines (115 loc) · 11.7 KB

README.md

File metadata and controls

189 lines (115 loc) · 11.7 KB
Raw

libTAS

Discord Website

GNU/Linux software to give TAS tools to games. Code originates from SuperMeatBoyTaser. It requires a GNU/Linux system with a recent kernel (at least 3.17 for the memfd_create syscall). Supported archs are x86_64 and x86. You will need the Mesa llvm OpenGL driver to support savestates for games using OpenGL.

Discord server: https://discord.gg/3MBVAzU

Website: https://clementgallet.github.io/libTAS/ (still in progress)

Additional documentation on tasvideos.org: https://tasvideos.org/EmulatorResources/LibTAS

Supported Games

Initial work was done to support games using the SDL library (which is the case of many indie games), but other engines are supported now.

By default, you should look for a drm-free version of the game. Games installed through Steam may or may not work. Some Steam games are in fact drm-free, they work without Steam running, or they just need some simple operations. For the other games, there is a "Virtual Steam client" setting in libTAS which implements a dummy Steam client, but it doesn't support every game. Of course, all of this only applies to games that don't have any active protection measure. For more details, check the Game Compatibility page.

There is also initial support for Windows games through wine. Details are given below.

Non-Linux users

If you don't have a Linux system beforehand, there are several options that you can choose:

  • Run libTAS using WSL 2 (Windows Subsystem for Linux) (preferred option)
  • Install a Linux container with Docker (described below)
  • Install Linux on a virtual machine. Grab a virtualization software (e.g. VirtualBox) and a Linux distribution (e.g. Ubuntu). If you have a 64-bit computer, install a 64-bit Linux distribution, which will allow you to run both 32-bit and 64-bit games. Note for Ubuntu users that you need a recent version (17.10 minimum).

Install

You can download the latest stable version of the software in the Releases page. The current dependencies are:

  • libc6, libgcc1, libstdc++6
  • libqt5core5a, libqt5gui5, libqt5widgets5 with Qt version at least 5.6
  • libx11-6, libxcb1, libxcb-keysyms1, libxcb-xinput0, libxcb-xkb1
  • liblua5.4-0
  • ffmpeg
  • file
  • libswresample2 or libswresample3 or libswresample4, libasound2

Installing with the debian package will install all the required packages as well.

There is also an automated build available for the last interim version, 64-bit with dual-arch.

Building

An PKGBUILD is available for Arch Linux on the AUR.

Dependencies

You will need to download and install the following to build libTAS:

  • Deb: apt-get install build-essential automake pkg-config libx11-dev libx11-xcb-dev qtbase5-dev libsdl2-dev libxcb1-dev libxcb-keysyms1-dev libxcb-xinput-dev libxcb-xkb-dev libxcb-randr0-dev libudev-dev liblua5.4-dev libasound2-dev libavutil-dev libswresample-dev ffmpeg
  • Arch: pacman -S base-devel automake pkgconf qt5-base xcb-util-cursor alsa-lib lua ffmpeg sdl2

Cloning

git clone https://github.com/clementgallet/libTAS.git
cd libTAS

Building

./build.sh

autoconf will detect the presence of these libraries and disable the corresponding features if necessary. If you want to manually enable/disable a feature, you must add at the end of the build.sh command:

Be careful that you must compile your code in the same arch as the game. If you have an amd64 system and you only have access to a i386 game, you can cross-compile the code to i386 (see below).

Install

cd build
sudo make install

Dual-arch

If you have an amd64 system and you want to run both i386 or amd64 games, you can install libTAS 32-bit library together with the amd64 build. To do that, you can build using ./build.sh --with-i386, which will produce an additional libtas32.so (32-bit) library together with amd64 builds of libTAS GUI and libtas.so library.

You will need the 32-bit version of libraries libX11, libX11-xcb, libasound, libavutil, libswresample, the 32-bit version of the headers for libavutil, libswresample. You will also need your compiler to be able to cross-compile, by installing g++-multilib if using g++ compiler. When running a game, libTAS will choose automatically the right libtas.so library based on the game arch.

  • Deb: apt-get install libx11-6:i386 libx11-xcb1:i386 libasound2:i386 libavutil56:i386 libavutil-dev:i386 libswresample-dev:i386 libswresample3:i386

Run

To run this program, you can use the program shortcut in your system menu, or open a terminal and enter:

libTAS [game_executable_path [game_cmdline_arguments]]

You can type libTAS -h to have a description of the program options.

The program prompts a graphical user interface where you can start the game or change several options. Details of the different options are available here

There are a few things to take care before being able to run a game. You might want to look at the software usage.

Here are the default controls when the game has started:

  • frame advancing, using the V key
  • pause/play, using the pause key
  • fast forward, using the tab key

Note: the game starts up paused.

Run Windows games through Wine

This is still experimental. To launch Windows games through Wine, you first need to install Wine on your system (it must be located somewhere in $PATH).

To get audio correctly handled, you need to open winetricks, then select "Select the default wineprefix", "Change settings" and check "sound=alsa".

In the game executable field, you must set the Windows .exe executable (both 32-bit and 64-bit are supported, given that you have the wine version for it). It will detect a Windows executable and launch Wine with the right options.

There are still a lot of issues to fix:

  • "Prevent writing to disk" feature does not work, because Wine delegating to another process (wine server) the file handling (#250)
  • Window focus/unfocus doesn't work sometimes and you cannot move the game window (#262). Try alt-tabbing until you get it back
  • "Virtual Steam client" does not work, because we don't hook the loading of the steam_api.dll file (#264)
  • Window repainting (Expose event) does not work, so if you pause the game and drag another window in front of it, it will overwrite what is displayed by the game

Run on Windows using Docker

One option if you have a Windows system is to run a Linux distribution inside a Docker container. This has the advantage of automating package installation and libTAS compilation. On Windows there are currently two possibilities for using Docker: Docker for Windows and Docker Toolbox. There are some requirements for the former (Windows 10 64-bit Pro, Enterprise, or Education), so I will describe the installation process for the later (both should be really close, but I can't test the former).

Install

  • install Docker Toolbox
  • download the Dockerfile somewhere (don't rename the file!).
  • open Docker Quickstart Terminal, and run the command docker build -t libtas /c/path/to/Dockerfile/directory. The path points to the directory containing the Dockerfile, not to the Dockerfile itself. Also, this terminal takes paths in Unix syntax: C:\foo\bar becomes /c/foo/bar. The Docker container build should start.
  • prepare a directory that will contain your games. This directory must be somewhere inside C:/Users/, because it is shared by default by Virtualbox. If you want to share another folder, you can follow this link
  • you need a X11 server to be able to display applications from the Linux container. Install vcxsrv

Run

  • launch Xlaunch, and check "Disable access control" in the Extra settings
  • for the Linux container to find your X11 server, you need your ip address. Type ipconfig in the Docker terminal, and search for ipv4 field.
  • to launch the container, run:
docker run -ti --rm -e DISPLAY="<ip>:0.0" -v /c/Users/path/to/shared/folder:/root/games libtas

You need to use the Unix syntax again for your shared folder path. Relative paths don't work here.

This should open a terminal in your container. You can then enter libTAS to launch the program. If everything goes right, you should see the libtas window appear. If it complains about not been able to open the display, check again your ipv4 field. You can also access to your shared files located inside /root/games path. Because of how Docker works, everything that is modified outside of /root/games will not be preserved on later instances of the container, so be sure to install and save everything inside that directory.

TODO: Figure out how to use Mesa OpenGL.

Run on Linux using Docker

Install

  • install docker through your usual package manager
  • you may want to use docker as a non-root user. To do that, create the docker group: sudo groupadd docker and add the user to the group: sudo usermod -aG docker $USER
  • download the Dockerfile somewhere (don't rename the file!).
  • run the command docker build -t libtas /path/to/Dockerfile/directory. The path points to the directory containing the Dockerfile, not to the Dockerfile itself. The Docker container build should start.

Run

  • to launch the container, run:
docker run --net=host -ti --rm -v /tmp/.X11-unix:/tmp/.X11-unix -v "$XAUTHORITY:/root/.Xauthority:rw" -e DISPLAY libtas

This should open a terminal in your container. You can then enter libTAS to launch the program. If everything goes right, you should see the libtas window appear. If you want to access to your local files, you can add -v $HOME:/home in the command options to map your $HOME directory to /home. Because of how Docker works, everything that is modified outside of this directory will not be preserved on later instances of the container.

Logo

Made by brunovalads.

License

libTAS is distributed under the terms of the GNU General Public License v3.

Copyright (C) 2016-2024 clementgallet
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>

Dear ImGui is licensed under the MIT License

QHexView is licensed under the MIT License