Settings
Open the Settings tab above the map. Some settings belong to the game, and are shared with your team. Others are yours alone.
| Saved in | Who it is for | For example |
|---|---|---|
tsumugi.json, in your game |
Everyone on the game | Game Text Area, spelling language, the warning for lines no character says, numbered options, inventory, health hearts |
| Your VS Code settings | You, on this computer | Text size, fonts, colours, saving, tips, shortcuts |
Game Text Area
Your game shows dialogue in a text area. Tell Tsumugi its size, so it can warn you when a line won’t fit, and draw the preview.
- Lines of dialogue it shows: how many lines fit at once.
- Text width, in pixels: the width your game wraps text at.
More text box settings has:
- The game shows the speaker’s name: the name then counts towards each line’s length.
- Lines shown at once: One at a time, or Several together as pages (Nodes and lines). Tsumugi reads this from your game’s code when it can.
- Widest an option can be, in pixels.
Click Save. It is saved in tsumugi.json.
Story Writer
- Text size and Interface size: how big the writing is, and how big the buttons, tabs and panels are.
- Colour each character’s lines: each speaker’s lines get their own light colour.
- Check spelling, and Spelling in: British and American English, British only, or American only.
- Warn about lines no character says: turn this off if your game shows narration with no name.
- Number the options: for games that show 1:, 2:, 3: before options.
- Auto-fix style: keeps spaces, indentation and blank lines tidy while you write.
- Save every 10 seconds: saves the file while you work.
- Show tips while writing: a faint tip at the end of the line, now and then.
Font
Pick the font for your writing. The list has sans-serif, serif and monospace fonts, and OpenDyslexic, made for readers with dyslexia. Another font on this computer… takes the name of any font you have installed.
The preview always uses your game’s own font.
Colours
Pick from a set of standard colours. The background and text follow your VS Code theme.
- Colour theme: changes every colour at once. There are themes for red-green and blue-yellow colour blindness, and one with high contrast.
- Characters: a colour for each character who speaks in this file, or Automatic.
- More colours: event tags, problems, links, options and the line you are writing.
Use the default colours puts them all back.
Inventory and health hearts
These show when your game has items or hearts. They tell the preview how your game draws them.
- Inventory: the functions your game uses to give, take, check and count items, and where it draws them: the object, and the grid of slots.
- Health hearts: the heart sprite (its frames go from full to empty), the variable that fills them, how many there are, and where they go on screen.
Both are saved in tsumugi.json.
The rest
- Check the story before every Git push: see Git and the pre-push check.
- Send anonymous usage info: anonymous counts of how Tsumugi is used. See Licence and privacy.
- Open the full guide.
- Keyboard shortcuts, at the bottom: see Keyboard shortcuts.
VS Code settings
The Settings tab writes these for you. You can also find them in VS Code’s own Settings: search for Tsumugi.
| Setting | What it does |
|---|---|
tsumugi.storyView.textSize |
Size of the writing in the Story Writer. |
tsumugi.storyView.interfaceSize |
Size of the Story Writer’s buttons, tabs and panels. |
tsumugi.storyView.speakerColours |
Gives each character’s lines their own colour. |
tsumugi.storyView.dialogueFont |
The font for your writing. |
tsumugi.storyView.colours |
Colours picked in the Settings tab. |
tsumugi.storyView.shortcuts |
Keyboard shortcuts changed in the Settings tab. |
tsumugi.storyView.autoSave |
Saves the file while the Story Writer has new work. |
tsumugi.storyView.tips |
Shows a faint tip now and then. |
tsumugi.enforceStyle |
Keeps every .yarn file tidy, in the Story Writer and when you save in the text editor. |
tsumugi.spelling.enabled |
Underlines misspelt words. |
tsumugi.spelling.myWords |
Your own words, accepted in every game on this computer. |
tsumugi.prePushCheck |
Checks the story before every Git push. |
tsumugi.usage.share |
Sends anonymous usage counts. |