Pineapple Fiber is a script that translates Yarn scripts into Typescript files that my custom-built DialogManager could digest. It was made with the purpose of:

1. Making iterations easier by using the VSCode Yarnspinner plugin as a playable prototype of the dialogs
2. Making it more robust and flexible to changes
3. Seeing the dialogs as graph to make dialog writing much easier
4. Less clutter on *.svelte files

To use, just run the script!

How to convert Yarn files to PineappleWeaver compliant typescript files

Run npm run generate-yarn

How does it work?

PineappleFiber-based Yarn File Format

For the latest specs, check out Yarn file format specs.

To make it clear which is Yarn-based definitions and PineappleFiber-based specifications, Yarn definitions are formatted with a blockquote.

Like this!

Project

TODO: note yet implemented

The Yarn project is all Yarn files that are intended to be associated with one another.

In PineappleFiber's world, these are the Typescript files importing each other! We might want this when we have common dialogues between files. We'll need to investigate about this more since we might end up with cyclical dependencies, and I would personally like to put a guard on it.

Lines

The line is the common unit that comprises all elements in a Yarn file. A line is a series of characters terminated by the new line symbol. The new line symbol should be either the \n character or \n. Once chosen, the new line symbol must remain the same throughout the project.

The following Yarn file contains four lines (in order); one header tag line, one header delimiter line, one body dialogue line, one body delimiter line.