Skip to content

Commit 2e5c1cc

Browse files
committed
Update README and release version 0.2.1.
1 parent 6613a94 commit 2e5c1cc

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
An **unofficial** Python interpreter for compiled [Yarn Spinner](https://yarnspinner.dev/) programs. _Documentation incomplete._
44

5-
This library currently supports the compiled story format from Yarn Spinner 1.0. Yarn Spinner 2.0 support is in progress.
5+
This library currently supports the compiled story format from Yarn Spinner 1.0. The library has also been tested with basic Yarn Spinner 2.0 code, but lacks the implementation for some of 2.0's new features.
66

77
## Installation
88

@@ -60,11 +60,14 @@ A few gotchas to look out for:
6060
- Make sure to open the compiled story file as a binary file (see the above example, use `open(filename, 'rb')`) in order for it to be properly parsed by the compiled protobuf library.
6161
- Unless you pass `autostart=False` to the runner when creating it, it will automatically start and run to the next choice point.
6262

63-
As of version v0.0.2, all Yarn Spinner 1 opcodes are currently implemented, as well as Yarn Spinner 1's internal standard library of functions and operators. This may certainly change over time, if new opcodes, functions, or operators are added to the language. The current missing features are:
63+
As of version v0.0.2, all Yarn Spinner opcodes are currently implemented, as well as Yarn Spinner 1's internal standard library of functions and operators. As of version v0.2.1, typed versions of these functions (introduced in Yarn Spinner 2) are present, but full YS2 parity has not been verified at this time. The known features currently missing are:
6464

65-
- Inline expressions [(see Yarn docs)](https://yarnspinner.dev/docs/writing/expressions-and-variables/#inline-expressions)
66-
- Localisation tags and Format functions [(see Yarn syntax reference)](https://yarnspinner.dev/docs/syntax/#localisation-tags)
67-
- Full Yarn Spinner 2.0 functionality
65+
- Inline expressions [(see Yarn docs on "Using Variables in Lines")](https://docs.yarnspinner.dev/getting-started/writing-in-yarn/logic-and-variables#using-variables-in-lines)
66+
- Line conditions and the `IsAvailable` flag on options [(see Yarn Docs on "Conditional Options")](https://docs.yarnspinner.dev/getting-started/writing-in-yarn/flow-control#conditional-options)
67+
- Localisation and Line IDs [(see Yarn's Localization docs)](https://docs.yarnspinner.dev/using-yarnspinner-with-unity/assets-and-localization)
68+
- An appropriate replacement for the distinction Yarn makes between Functions and Coroutines in Unity (to allow users to register blocking command handlers via this Python runner independent of Unity)
69+
- Complete implementation of YS2's type system, specifically when performing operations on mismatching types
70+
- This may be challenging, due to Python being a dynamically typed language
6871

6972
## Development
7073

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[metadata]
44
name = yarnrunner-python
5-
version = 0.0.2
5+
version = 0.2.1
66
author = Sam Weaver
77
author_email = sweaver@relaypro.com
88
description = An unofficial Python interpreter for compiled Yarn Spinner programs.

0 commit comments

Comments
 (0)