YML based Dialog Structure

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
  • [ ] Usage
  • [ ] [Custom (De)Serialize implementation](https://serde.rs/impl-serialize.html). The field content: is interpreted as either monolog: or choices:
  • [ ] [Generic type](https://doc.rust-lang.org/reference/items/generics.html) for Condition
  • [ ] [Generic type](https://doc.rust-lang.org/reference/items/generics.html) for an extra field on the DialogNode
  • [ ] [Dynamic Macros](https://stackoverflow.com/a/63849405)
  • [x] Exclude Bevy dependency
  • [ ] Follow all guidelines from Rust API Guidelines
  • [ ] Documentation
    • [ ] Examples use ?, not try!, not unwrap (C-QUESTION-MARK)
    • [x] Crate level docs are thorough and include examples (C-CRATE-DOC)
    • [x] create an example
  • [x] Interoperability
    • [x] Types eagerly implement common traits
    • [x] ...
  • [ ] Future proofing (crate is free to improve without breaking users' code)
    • [ ] Sealed traits protect against downstream implementations (C-SEALED)
    • [x] Structs have private fields (C-STRUCT-PRIVATE)
    • [ ] Newtypes encapsulate implementation details (C-NEWTYPE-HIDE)
    • [ ] Data structures do not duplicate derived trait bounds (C-STRUCT-BOUNDS)

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:

• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

See the very good reasons for including both here.

Inspiration

• Medium: A Tree Structure implemented in Rust.
• Wikipedia: Dialogue Tree
• Wikipedia: Nonlinear Gameplay
• Bevy's SubReddit: Bevy Dialog Discussion

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
• bevydialogsystem
• bevyftodialog / bevyfobdialog