Troubleshooting

The Story Writer is locked

Run Tsumugi: Licence Status to see why.

The trial ended: enter a licence key, or buy one (Licence and privacy).
Can’t reach the licence server: check your internet connection, then click Try again.
Update needed: click Update now.

Your story is safe. Click Open as Yarn text to keep working in the meantime.

The sidebar shows no story files

Open the folder that holds your game’s .yyp file, not a folder inside it.
Story files are the .yarn files in datafiles, unless tsumugi.json lists others under dialogue.
Run Tsumugi: Reload Game Project.

A file says “not in the game yet”

Your game can’t play it yet. Add it to Included Files, and load it in your game’s code. See How Tsumugi reads your game.

A change in GameMaker doesn’t show

Tsumugi reads the game again by itself when a file changes. If it misses one, run Tsumugi: Reload Game Project.

GameMaker asks to reload the project

That is normal after Tsumugi adds something to your game. Say yes, so GameMaker sees it.

The preview says there is no room to draw

Tsumugi draws the room your text area or your areas are in. If it can’t find one, add "preview": { "room": "rYourRoom" } to tsumugi.json.

The preview’s text is the wrong size or font

The preview uses your game’s default Scribble font. Check that the font exists in your project, and set Game Text Area in Settings. If Tsumugi finds no font, it says so, and can’t measure lines.

Every line of narration is underlined

Tsumugi is asking which character says it. If your game shows narration with no name, untick Warn about lines no character says in Settings.

A name is underlined as misspelt

In the Story Writer, point at it, then Add to dictionary (for everyone on the game) or Just for me. In the text editor, use the light bulb (Editing .yarn as text). See Nodes and lines.

A Git push was stopped

Something in the story would break the game. The push lists each problem, with its file and line. Fix them, then push again. To push once without the check, use git push --no-verify. See Git and the pre-push check.

Undo didn’t take a change back

The Story Writer’s undo covers what you did in the Story Writer. A change made outside it (in the text editor, by Git, or by a rename) is undone with VS Code’s own undo. VS Code’s Timeline keeps the file as it was at each save.

Report a bug

Click Report a bug at the top right of any docs page, or email [email protected]. Please tell us:

what happened, and what you expected,
how to make it happen again,
your Tsumugi version (in the Extensions view),
your editor and its version,
Windows, macOS or Linux.

A small .yarn file that shows the problem helps a lot. Never send us anything you don’t want to share.