radiatoryang / yarn-weaver

simple tool built in Unity C# to test Yarn files, good for game devs and narrative designers

UPDATE, 18 AUGUST 2021

• you shouldn't use this anymore, it doesn't really support any Yarn syntax since Yarn Spinner v1.0+ basically
• I'm working on newer tools to replace this, but it's slow going sorry
• I'm going to archive this so you know there's no more updates / support planned, sorry

Yarn-Weaver

A simple tool built in Unity C# to playtest / test-run Yarn files! If you're not familiar, Yarn is a Twine-like dialogue scripting engine + node editor tool that you can use for Unity games... I thought playtest functionality would've been integrated into the Yarn editor itself -- but unfortunately it's not there yet, so until then, you can use this tool to fill in that gap!

USAGE

1. keep the Yarn editor window open, and keep the Yarn Weaver window open at the same time
2. when you edit a script in Yarn editor, save it as a yarn.txt (.json is supported too, but it's harder to diff / read in a text editor)
3. ... and then in Yarn Weaver, open the file and/or refresh it to see new changes, and play!

DOWNLOAD

• latest Windows and Mac OSX builds are here: https://github.com/radiatoryang/Yarn-Weaver/releases/
• there might be bugs with the "open file dialog" on certain versions of OSX

IMPORTANT NOTE:

so, YarnSpinner doesn't really know which node in your Yarn file is the "start"... to try to figure it out, YarnWeaver searches your Yarn file for 2 things:

• a node title beginning with the word "Start" (or "start" or "START" or "sTaRt")
• a node title beginning with the filename (e.g. "Sally.json" would prompt a search for a node labeled "Sally")
• ... and if those searches fail, then it just starts with the first node it finds, which usually means the oldest node in your Yarn file

HOW TO CONTRIBUTE

accepting pull requests here: https://github.com/radiatoryang/Yarn-Weaver/issues

ideally, post a comment or reply if you're working on something, so that we don't double-up on work

uses the following:

• Yarn https://github.com/InfiniteAmmoInc/Yarn
• YarnSpinner https://github.com/thesecretlab/YarnSpinner/
• UnityStandaloneFileBrowser https://github.com/gkngkc/UnityStandaloneFileBrowser

license?

MIT

yarn-weaver's Issues

v0.2.0 -- add variable debug / override

variable debug UI: let you manually define / set pre-defined variables for testing purposes, or even edit current variables

I think ExampleVariableStorage already kind of allows for this, we just have to design UI and hook into that stuff

v0.2.0 -- add "jump to node" menu

display a scrollable sidebar that lists all nodes, with an option to jump to any node found in the Yarn script(s)

v0.2.0 -- add folder support

folder support: load an entire folder (and recursively grab all subfolders) of Yarn files at once, and let you jump between all the different files easily within the same session

v0.2.0 -- add transcript / history

transcript: a record of your choices, node changes, variable changes, and any Yarn Commands that would've been executed... and let user copy and paste OR save out their transcript / log file too

starts incorrectly

Here is a test file I made and saved as .json

When I open the file inside YarnWeaver, the text windows "hello" followed by "bye" are displayed, and then the next click presents the choice while on "bye", like this:

if i understand correctly the choice should be present on the first window?

v0.2.0 -- add webGL support + host a demo

webGL support: open a webpage, drag and drop yarn.txt files to load them, host on github pages for this repo?... I think Fernando Ramallo already has this working?...

Alpha shaders invisible on OSX

First, a quick disclaimer: this is the kind of problem I remind myself is likely due to the massive amount of unsupported aftermarket hardware wedged into my 11-year-old Mac Pro, but this issue isn't something I've seen happen in other Unity games or apps so I thought I'd post it in here anyway.

All the transparent background textures are invisible on my Mac, regardless of graphics settings or fullscreen/windowed status. This is the latest build; I will test building on my end and update this if I find anything. (Unless this ticket leads to a lot of "me too", that the correct answer is "that computer sounds sketchy as heck, what do you really expect?")

(This is a Mac Pro 1,1/GeForce 960 GTX/latest Nvidia Web Driver, 346.03.15f09/OSX 10.11.6. It works fine on my Mac Pro 3,1/Radeon 5770/OSX 10.11.6.

v0.2.0 -- display parsing errors / compile errors

hook into Yarn Spinner's error handling somehow, and display errors if the Yarn script is malformed somehow