Commands

Open the Command Palette (⌘ ⇧ P) and type Tsumugi to see them. Some show only while a .yarn file is open.

Writing

Command What it does
Tsumugi: Open in Story Writer Opens the .yarn file in the Story Writer.
Tsumugi: Open as Yarn Text Opens the file in VS Code’s text editor, beside the one you are in.
Tsumugi: New Story File… Makes a new .yarn file in your game and opens it. Asks first.
Tsumugi: Game Text Area Sets how many lines your text area shows, and how wide it is.

Checking and testing

Command What it does
Tsumugi: Check the Story Checks every story file in the game. Changes nothing.
Tsumugi: Start the Game Here (when testing) Run in GameMaker starts at the node your cursor is in.
Tsumugi: Start the Game from the Beginning Takes the test start away again.

Your game

Command What it does
Tsumugi: Set up this project Makes a first tsumugi.json from your game. Asks first.
Tsumugi: Reload Game Project Reads your game again. Usually not needed: Tsumugi notices changes by itself.

Help

Command What it does
Tsumugi: Open the Full Guide (step by step) Opens the guide in the Story Writer.
Tsumugi: Get Started Opens the Get Started page.
Tsumugi: Privacy Policy Shows the privacy policy in VS Code.

Licence

Command What it does
Tsumugi: Licence Status Shows your trial or licence, and your computer code.
Tsumugi: Enter Licence Key… Adds the licence key from your receipt.
Tsumugi: Buy a Licence Opens the page to buy one.
Tsumugi: Remove Licence Key Frees this computer’s place, so you can use the licence on another one.
Tsumugi: Update Tsumugi Now Installs the newest version.

See Licence and privacy.

Other places to find them

  • The Tsumugi sidebar: Story files, with buttons for Open the full guide, New story file…, Check every story file, and Set up this project until your game has a tsumugi.json.
  • The status bar: where Run starts, while a test start is set, and your trial or licence when it needs you.
  • The editor’s title bar: Open in Story Writer on a .yarn file.
  • Right-click in a .yarn file: Start the Game Here (when testing).
  • Quick fixes: adding words to the game’s dictionary, or to your own words (Editing .yarn as text).

Tsumugi’s commands have no keys of their own. Give one a key in VS Code’s Keyboard Shortcuts.