https://github.com/matanlurey/tts-runner

Node.js utilities library for Tabletop Simulator
https://github.com/matanlurey/tts-runner

node-js runner tabletop-simulator tools

Last synced: 8 days ago
JSON representation

Node.js utilities library for Tabletop Simulator

• Host: GitHub
• URL: https://github.com/matanlurey/tts-runner
• Owner: matanlurey
• Created: 2020-05-03T23:50:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:41:05.000Z (almost 2 years ago)
• Last Synced: 2023-02-28T15:56:51.495Z (over 1 year ago)
• Topics: node-js, runner, tabletop-simulator, tools
• Language: TypeScript
• Size: 1.2 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tts-runner

Node.js library for running [Tabletop Simulator][1].

[1]: https://store.steampowered.com/app/286160/Tabletop_Simulator/

## API

### `launch(options)`

```ts

{

  /**

   * Additional flags to pass when running.

   *

   * Do note, many flags such as `-novid` and `-nosubscription` speed up start

   * times are already set by default. You can ignore this behavior by disabling

   * @see ignoreDefaultFlags.

   *

   * @see https://kb.tabletopsimulator.com/getting-started/launch-options/.

   */

  additionalFlags?: string[];

  /**

   * Whether to pass no flags by default.

   *

   * This will entirely rely on @see additionalFlags.

   */

  ignoreDefaultFlags?: boolean;

  /**

   * Explicit path of the intended Tabletop Simulator binary.

   *

   * * If this `steamAppsPath` is defined, it will be used.

   * * Otherwise, the `STEAM_APPS_PATH` env variable will be used if set.

   * * Otherwise, will attempt to detect the installed steam directory.

   */

  steamAppsPath?: string;

}

```

### `const instance = await launch()`

```ts

{

  /**

   * Process ID number.

   */

  pid: number;

  /**

   * A reference to the spawned @see ChildProcess.

   */

  process: ChildProcess;

  /**

   * Kills the promise, and does any related cleanup work.

   */

  kill;

}

```