stardust

An experimental Tabletop Simulator mod for a popular miniatures game.

Getting Started

Download Node.js and then setup the development tools:

$ npm install

You can then build and start Tabletop Simulator automatically:

$ npm start

It is highly recommended to install and use the Atom Editor with the official Tabletop Simulator plugin at this time. You can make edits, and then when you are ready save over the generated file:

Upon closing Tabletop Simulator, the files in mod will be updated automatically.

Multiplayer sessions

The current workflow is optimized around local (single-player) sessions. To demo with someone else, you will need to use an asset server that is reachable for the other users. Currently, you can use GitHub as the source of the truth:

# Builds dist/Stardust.json, but with assets pointing to:
# `https://raw.githubusercontent.com/swlegion/stardust/master/assets/`
#
# ... this does mean that you cannot use in-progress/local-only assets.
$ npm run build -- --use-github-for-assets

Advanced users

If you are feeling up to it, or don't develop on Windows:

# Builds dist/Stardust.json
$ npm run build

# Creates a link from dist/ to the provided directory (your TTS/Saves directory).
#
# See: https://www.pcgamingwiki.com/wiki/Tabletop_Simulator
#
#   macOS (OS X)	~/Library/Tabletop Simulator/
#   Linux	~/.local/share/Tabletop Simulator/
$ npm run link -- "~/path/to/saves/dir"

# Runs the local asset server
$ npm run serve

You can now load up Tabletop Simulator manually, and open TTSDevLink/Stardust. When you are done making any changes to this save file, you can run the command:

$ npm run extract

... to reflect the changes into the mod/ folder.