Skip to content

Improve usage instructions #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rngesus-wept wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve usage instructions #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
Tabletop Simulator Mod Tools
----------------------------

This is a collection of tools for working Tabletop Simulatator mods.
This is a collection of tools for working Tabletop Simulator mods.

To build a mod::
To install (requires Python 3.7+)::

$ tts repack

This will put the module at ``build/savegame.json``. You can also pass a path for where to build the module.
$ pip install tabletop-tools

To unpack a module::

$ tts unpack <...path/to/savegame.json...>

to unpack a savegame.
to unpack a savegame to your current directory.

To build a mod::

$ tts repack

This will put the module at ``build/savegame.json``. You can also pass a path for where to build the module.


Config
Expand Down