ttsmutility - Early Development Preview

This is an all-in-one application for managing Tabletop Simulator mods and save files. The following features are currently supported:

• Scan mods/saves and identify assets that are downloaded or missing (including assets in LuaScript sections)
• Browse Mod info, with integration with Steam Workshop descriptions and BoardGame Geek
• Browse Asset info, including information regarding how the asset is used in the JSON mod
• Download all missing assets from a mod, or individual assets
• Backup Mods and Saves to zip files
• Detect mods that are infected with the TTS script-virus (infected mods have a red name)
• Use Steam Workshop names to compare SHA1 signature to local file in order to detect corrupted files
• Cross platform, tested on Windows 10/11 and Linux (may work on MacOS but currently untested)
• Recover original file names from steamcloud and other cloud providers (where possible)
• Identify potential matches for missing assets using SHA1, filenames, and original file names
• Clickable links for both local and cloud files

Installation

ttsmutility is a Python 3.11 application which uses the Textual TUI framework. After obtaining the source code, it can be installed using the following command (don't include the '$'):

$ pip install .

If you want to play around with the code (many of the screens can be customized by modifying the .md file you can do a editable install by doing:

$ pip install -e .

NOTE: Pip also supports installing directly from a zip file. So, instead of the . you can substitute the zip filename.

Running ttsmutility

Once installed the app can be run by typing:

$ ttsmutility

Configuring ttsmutility Paths

After the first run a config file (configuration.json) is created in the xdg config directory. This is typically ~/.config/ttsmutility (Linux) or C:\Users\[username]\.config\ttsmutility (Windows). TTS paths can be configured there accordingly.

Commandline options

usage: ttsmutility [-h] [-v] [-m MAX_MODS] [--no-log] [--overwrite-log] [--force-refresh] [--skip-asset-scan]

TTSMutility - Tabletop Simulator Mod and Save Utility

options:
  -h, --help            show this help message and exit
  -v, --version         Show version information.
  -m MAX_MODS, --max-mods MAX_MODS
                        Limit number of mods (for faster debuggin)
  --no-log              Disable logging (logfile path specified in config file)
  --overwrite-log       Overwrite the existing log (don't append)
  --force-refresh       Re-process all mod files (useful if bug fix requires a rescan)
  --skip-asset-scan     Do not scan filesystem for new assets during init

Additional ttsmutility Screenshots

Mod Details

Mod Asset List

Asset Detail

Virus Alert

Explorer Tree View

ttscleaner.py - TTS Script Virus Removal Tool

A stand alone tool is also available to remove the TTS virus from Mods and Saves. Please store a backup of your original mod.

$ python .\ttscleaner.py --help
usage: ttscleaner [-h] [-v] [-s] [--no-sig] mod_path

ttscleaner - Tabletop Simulator mod virus removal tool

positional arguments:
  mod_path

options:
  -h, --help     show this help message and exit
  -v, --version  Show version information.
  -s, --scan     Scan and print virus info
  --no-sig       Do not add signature in place of virus

0.0.2

Sample output from default clean option. Note: the tool will not overwrite the mod. Instead it creates a "clean" copy with the file extension ".cleaned".

> python .\ttscleaner.py 'C:\Program Files (x86)\Steam\steamapps\common\Tabletop Simulator\Tabletop Simulator_Data\Mods\Workshop\2967684892.json'
Cleaning mod 'C:\Program Files (x86)\Steam\steamapps\common\Tabletop Simulator\Tabletop Simulator_Data\Mods\Workshop\2967684892.json'
Cleaned 5 infected objects
Saving cleaned mod to 'C:\Program Files (x86)\Steam\steamapps\common\Tabletop Simulator\Tabletop Simulator_Data\Mods\Workshop\2967684892.cleaned'

Sample output from scan operation:

> python .\ttscleaner.py --scan 'C:\Program Files (x86)\Steam\steamapps\common\Tabletop Simulator\Tabletop Simulator_Data\Mods\Workshop\2967684892.json'
Scanning mod 'C:\Program Files (x86)\Steam\steamapps\common\Tabletop Simulator\Tabletop Simulator_Data\Mods\Workshop\2967684892.json'
Virus detected: ObjectStates->"Sample infected cards"->ContainedObjects->"Card"->LuaScript
Virus detected: ObjectStates->"Sample infected cards"->ContainedObjects->"Card"->LuaScript
Virus detected: ObjectStates->"Sample infected cards"->ContainedObjects->"Card"->LuaScript
Virus detected: ObjectStates->"Sample infected cards"->ContainedObjects->"Card"->LuaScript
Virus detected: ObjectStates->"Sample infected cards"->ContainedObjects->"Card"->LuaScript
Detected 5 infected objects