@tts-tools/savefile
Version:
Module to extract a savefile from Tabletop Simulator into multiple files.
20 lines (19 loc) • 748 B
TypeScript
import { SaveFile, TTSObject } from "./model/tts";
/**
* Available options for [[embedSave]].
*/
export interface Options {
/** The path where the scripts and XML files will be included from. */
includePath: string | string[];
metadataField?: string;
}
export declare const readExtractedSave: (path: string, options: Options) => SaveFile;
export declare const readExtractedObject: (path: string, options: Options) => TTSObject;
/**
* Embeds the content of an previously extracted save file and returns a new save file.
*
* @param path The path to an extracted save file.
* @param options The [[Options]] to use.
* @returns The embedded save file.
*/
export declare const embedSave: (path: string, options: Options) => SaveFile;