eigengrau / tts-backup Goto Github PK

TTS-Backup backs up Tabletop simulator save games and mods to a Zip file, bundling locally cached images and models within a single archive.

This only handles saves and mods in JSON format.

A Python 3.3 (or newer) interpreter is required. For Windows users, the ActivePython distribution is recommended.

Alternatively, a binary release for the Windows platform is available here.

Optionally, to use the source distribution, download the current release, and either use pip or easy_install on the archive file, or extract the contents and run python setup.py install.

All content referenced within the mod or save must have been locally cached from within TTS before a backup can be made. Note that when game items are contained within bags, TTS will only locally cache the respective assets once they are removed from the bag.

By default, TTS-Backup will assume that cached data is located in ~/Documents/My Games/Tabletop Simulator.

TTS-Backup is a console application. For stern opponents of the CLI, a minimal GUI is provided.

Usage flags and arguments are as follows:

usage: tts-backup [-h] [--gamedata PATH] [--outname FILENAME] [--dry-run]
                  [--ignore-missing] [--comment COMMENT]
                  FILENAME

Back-up locally cached content from a TTS .json file.

positional arguments:
  FILENAME              The save file or mod in JSON format.

optional arguments:
  -h, --help            show this help message and exit
  --gamedata PATH       The path to the TTS game data directory.
  --outname FILENAME, -o FILENAME
                        The name for the output archive.
  --dry-run, -n         Only print which files would be backed up.
  --ignore-missing, -i  Don’t abort the backup when files are missing.
  --comment COMMENT, -c COMMENT
                        A comment to be stored in the resulting Zip.

TTS-Prefetch downloads assets specified within a TTS JSON save file and stores them within the TTS cache. This is handy if you want to ensure that all mod assets are present, e. g., when several mods have been updated, or when a mod uses bags, which normally require that all pieces are unpacked manually before they are fetched and stored inside the TTS cache.

Cf. above.

By default, TTS-Prefetch will assume that cached data is located in ~/Documents/My Games/Tabletop Simulator.

TTS-Prefetch is a console application. For stern opponents of the CLI, a minimal GUI is provided.

Usage flags and arguments are as follows:

usage: tts-prefetch [-h] [--gamedata PATH] [--dry-run] [--refetch] [--relax]
                    [--timeout TIMEOUT] [--user-agent USER_AGENT]
                    FILENAME [FILENAME ...]

Download assets referenced in TTS .json files.

positional arguments:
  FILENAME              The save file or mod in JSON format.

optional arguments:
  -h, --help            show this help message and exit
  --gamedata PATH       The path to the TTS game data directory.
  --dry-run, -n         Only print which files would be downloaded.
  --refetch, -r         Rewrite objects that already exist in the cache.
  --relax, -x           Do not abort when encountering an unexpected MIME
                        type.
  --timeout TIMEOUT, -t TIMEOUT
                        Connection timeout in s.
  --user-agent USER_AGENT, -a USER_AGENT
                        HTTP user-agent string.