Revision (current)
Last Updated by Randomno on 9/3/2023 4:30 PM
[https://www.scummvm.org/|ScummVM] is an executable replacement program focused on running older adventure games and RPGs on modern systems. The Linux version can be used in conjunction with [https://github.com/clementgallet/libTAS|libTAS] to make tool-assisted speedruns of these games.
%%TOC%%
!!! What you'll need
Starting off, make sure you have a game in mind. For a list of compatible games, look at [https://www.scummvm.org/compatibility/|the compatibility page] for the version of ScummVM you want to use. If the compatibility is listed as "Good" or "Excellent", then you're good to go.
* [https://github.com/clementgallet/libTAS/releases|libTAS]
** Remember that the run must sync on an [MovieRules#BeforeStarting|official emulator version] or it will not be accepted.
* [https://www.scummvm.org/downloads/|An official release of ScummVM], preferably the newest available version. Install the {{.deb}} file with the terminal command {{sudo dpkg -i myscummvmfilename.deb}}, substituting the filename with the one you downloaded.
* Data files for your game. For a list of the data files you need, check the game's entry on the [https://wiki.scummvm.org/index.php?title=Category:Supported_Games|ScummVM wiki].
!!! Using with libTAS
You first need to install the game in ScummVM.
* Put the game's data files in a folder by themselves.
* Open ScummVM natively ({{scummvm}} in the terminal).
* Click the "Add Game..." button and choose the folder that you put the data files in.
* If you did this correctly, it should show you the ID and the game name. __Make a note of the ID, you will need this later.__ Click OK and close ScummVM.
Now you can set up libTAS.
* Set the executable path to the ScummVM version you want to use. If you installed it through the terminal or through a {{.deb}} file, it should be {{/usr/games/scummvm}}.
* Set the command-line options to the game ID you noted when you installed the game. If you forgot it, it will just be the "Game Short Name" on the [https://www.scummvm.org/compatibility/|compatibility list].
* __TODO__: Figure out frame rates and any other needed settings
!!! Movie submissions
We allow submissions using ScummVM with libTAS. Please follow these guidelines to ensure your movie is acceptable and can be synced:
* Follow all rules already in place for [EmulatorResources/LibTAS#MovieSubmissions|submitting libTAS movies].
* Make sure your game is listed as "Good" or "Excellent" on the [https://www.scummvm.org/compatibility/|compatibility list], otherwise it may be [MovieRules#GameplayMustBeAccurateToHardware|too poorly reproduced to accept].
* __Make sure your movie starts with no save data!__ Different save data can cause desyncs when run on other systems. Delete or move any relevant save files in {{~/.local/share/scummvm/saves/}}.
* When making a libTAS movie that you plan to submit to TASVideos or upload it to userfiles, depending on the game's original platform, put {{Platform: DOS}} or {{Platform: Windows}} at the very start of the movie annotations, that way the site will recognize your platform properly. If the game you're using has an official Linux release using ScummVM, you can leave this out.
* In your submission, please provide the following:
** libTAS version
** ScummVM version
** Filenames and MD5 hashes of your datafiles (use {{md5sum /path/to/files/*}} in a terminal)