#yaml #dialog #structure #game #serialization #file-format

yml_dialog

A very light base structure to implement an Rust Dialog using YML (file) format

1 unstable release

0.2.3 Aug 18, 2023

#1118 in Game dev

MIT/Apache

43KB
145 lines

YML based Dialog Structure

v0.2.2 MIT/Apache 2.0

Example

complete_example

If you want to compile the code at home, download assets here: disroot's cloud, clone the repo, extract the assets in the root of the repo and run cargo run --example complete_example.

RoadMap

  • fully functional API to implement a dialog system into a (bevy game or any) app

Contribute

Release's format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

This project also follows to A successful Git branching model.

We have to respect all the rust API convention. For the lore, follow all Bevy plugins guidelines.

Run cargo clippy, cargo doc before commit.

License

This project is free, open source and permissively licensed!

All code in this repository is dual-licensed under either:

See the very good reasons for including both here.

Inspiration

I began coding this as a tree strucutre dialog but a graph based is much more suited for a dialog. Maybe after this migration this crate is not needed anymore and will just do a devlog. (and free this name :)

Naming

Accordingly to this discussion, this is not a trivial question.

  • yml-dialog
  • dialog-structure
  • md-to-dialog-tree
  • fto-dialog
  • bevy_dialog
  • bevy_dialog_system
  • bevy_fto_dialog / bevy_fob_dialog

Dependencies

~0.3–1MB
~21K SLoC