1 unstable release

0.1.0 Oct 15, 2023

#1533 in Game dev

MIT license

41KB
582 lines

bevy_mod_yarn

This is a bevy library for Yarn Spinner, based on the chapter parser (a fork of the yharnam crate).

Usage

See the examples directory for usage (both minimal and "kitchen sink" examples are available).

Note that Yharnam only handles compiled yarn files. Yarn files can be compiled using the Yarn Spinner Console which must be downloaded separately.

The build script (build.rs) in this repository shows an example of how you can automatically compile your yarn files during the build. Note that due to limitations in bevy's asset loader the csv files created by the yarn compiler need to be renamed from the Yarn compiler defaults.

Features

The current feature(s) are available, enabled by default:

  • input-handlers, which includes default input handlers (space to progress through dialogues and numbers 1-3 for selecting options). There are checks to ensure a valid option is pressed. To disable this and provider your own input handlers, set default-features = false.

Dependencies

~21–30MB
~476K SLoC