Giter VIP home page Giter VIP logo

yarn-weaver's Introduction

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

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:

license?

MIT

yarn-weaver's People

Contributors

desplesda avatar radiatoryang avatar yangrobertw avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.