search

swlegion / tts

Table Top Simulator Mod for Star Wars: Legion
MIT License
45 stars 27 forks source link
community-project mod star-wars star-wars-legion table-top-simulator tts

readme

Tabletop Simulator Mod for Star Wars: Legion

CI

This project is a community-contributed open source mod for Tabletop Simulator, emulating some features and game play of Star Wars Legion. It is periodically updated to the Steam Workshop.

Star Wars: Legion and all related properties and text are owned by Fantasy Flight Games, Lucasfilm Ltd., and/or Disney.

Screenshot of the Game

Getting Started

If you're brand new to either Star Wars: Legion, or playing on TTS, Ben VanDonge (also known as "Mbweha" in various online communities) has a series of tutorials on YouTube that are great resources. We highly recommend viewing before being more involved.

Contributing

As a community run project, artwork, scripting, table design and more is a 100% volunteer project, and we could use your support! You will need the following tools to make most (but not all) contributions to the mod:

  1. A Git or GitHub client to make copies of this repository.
  2. NodeJS
  3. Tabletop Simulator

You'll notice we do not store the "save file" (JSON) in this repository, as historically that made concurrent edits and collaboration much more difficult: instead we have a series of scripts that "compile" it on demand from individual scripts and objects.

WARNING: Currently only Windows-based development is fully supported.

Once you've cloned the repository, you can build the mod:

# Install all NodeJS required dependencies.
npm install

# Creates a symbolic link to your TTS save folder, and compiles the mod.
npm start

For subsequent updates, you can just use compile on-demand:

# Files in "mod/**" are combined and output in "dist/" (linked to your saves).
npm run compile

# Optional, instruct TTS to reload automatically.
npm run compile -- --reload

If you make any edits to the save file directly, you will need to reflect (extract) the changes into the mod/** folder:

# This is a rarer workflow, but still supported.
npm run extract

Please file a bug if any part of this process does not work as expected.

Join the Community

Currently our only support channel is joining The Legion Discord (TLD) and using the #tts-chat and #tts-bugs-and-feature-requests channels, which are open to all players.

Support Channels

Frequent contributors may be invited to a private Discord.