A modern dialogue executor and tree parser using YAML.

Last update: Aug 3, 2022

Related tags

Overview

A modern dialogue executor and tree parser using YAML.

This crate is for building(ex), importing/exporting(ex), and walking(ex) dialogue trees.

convo promises an emphasis on documentation and user-friendliness, but also performance. All retrievals, searches, and side-effects to the conversation tree are in O(1) constant time.

Sections

Sections
Motivation
State
Using convo
Getting Started
Contributing
- Help needed
License

Motivation

The intent is to safely import and export conversation trees, as well as walk complex conversations easily and efficiently. Conversations resemble a traditional dialogue tree model, and can be cyclic. YAML format makes creating dialogue trees intuitive and easy, even without a formal editor (but a GUI editor will come eventually).

State

convo is usable and in active development. Future releases will follow SemVer compatibility.

Using convo

The easiest way to use convo is by adding the lone dependency to your Cargo.toml file:

convo = "0.1.2"

Getting Started

Terminology

Tree - the parent container for a conversation tree.
Node - a node in a conversation tree which acts as a fork of decisions by wrapping prompting dialogue and a list of path options (called Links).
Link - a uni-directional path to a [Node].

Examples

Check out these important examples:

Formatting Rules

For specific rules and formatting information, please check FORMATTING.md

Issues

Don't hesitate to file an issue or contact @simbleau by e-mail or @ThomasHoutart by e-mail.

Contributing

I encourage all contributions by pull request. Please check the issues first if you'd like to help.

The Rust code of conduct applies.

Help needed

Create examples using the serde-yaml crate for serialization and deserialization.
Create a GUI for editing and creating convo files.

License

This project is dual-licensed under both Apache 2.0 and MIT licenses.

Comments

Make data structure pieces consistently named

CTree, Node, and Link do not have consistent naming.

Options: -CTree, CNode, CLink or -Tree, Node, Link or (maybe) create unique terms: Convo(Tree), Fork(Node), Link/Path
enhancement

opened by simbleau 1
Change backing data structure to preserve order.
Looking for a data structure which has O(1) search/get time, O(1) amortized insertion time, not horrible memory requirement - O(n) at worst, and orders by insertion time.

Potential options/research required:

HashMap (currently used; No insertion ordering)

BTreeMap

Linked-Hash-Map crate

IndexMap

bug
opened by simbleau 1
Update Rust crate text_io to 0.1.12
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | text_io | dev-dependencies | patch | 0.1.10 -> 0.1.12 |

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Mend Renovate. View repository job log here.
opened by renovate[bot] 0
Update Rust crate indexmap to 1.9
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | indexmap | dependencies | minor | 1.8 -> 1.9 |

Release Notes

bluss/indexmap

v1.9.0

Compare Source

v1.8.2

Compare Source

v1.8.1

Compare Source

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Mend Renovate. View repository job log here.
opened by renovate[bot] 0
Update github/codeql-action action to v2
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | github/codeql-action | action | major | v1 -> v2 |

Release Notes

github/codeql-action

v2

Compare Source

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Update actions/checkout action to v3
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions/checkout | action | major | v2 -> v3 |

Release Notes

actions/checkout

v3

Compare Source

Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory

Bumped various npm package versions

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Update actions-rs/toolchain digest to 88dc235
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions-rs/toolchain | action | digest | 16499b5 -> 88dc235 |

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Update Rust crate indexmap to 1.8
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | indexmap | dependencies | minor | 1.7 -> 1.8 |

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Update Rust crate text_io to 0.1.10
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | text_io | dev-dependencies | patch | 0.1.8 -> 0.1.10 |

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Configure Renovate
Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

Cargo.toml (cargo)

Configuration Summary

Based on the default config's presets, Renovate will:

Start dependency updates only once this onboarding PR is merged

Enable Renovate Dependency Dashboard creation

If semantic commits detected, use semantic commit type fix for dependencies and chore for all others

Ignore node_modules, bower_components, vendor and various test/tests directories

Autodetect whether to pin dependencies or maintain ranges

Rate limit PR creation to a maximum of two per hour

Limit to maximum 10 open PRs at any time

Group known monorepo packages together

Use curated list of recommended non-monorepo package groupings

Fix some problems with very old Maven commons versions

Ignore spring cloud 1.x releases

Ignore web3j 5.0.0 release

Ignore http4s digest-based 1.x milestones

Use node versioning for @types/node

Limit concurrent requests to reduce load on Repology servers until we can fix this properly, see issue 10133

Do not upgrade from Alpine stable to edge

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

With your current configuration, Renovate will create 2 Pull Requests:

Update Rust crate text_io to 0.1.10

Schedule: ["at any time"]

Branch name: renovate/text_io-0.x

Merge into: main

Upgrade text_io to 0.1.10

Update Rust crate indexmap to 1.8

Schedule: ["at any time"]

Branch name: renovate/indexmap-1.x

Merge into: main

Upgrade indexmap to 1.8

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by WhiteSource Renovate. View repository job log here.
opened by renovate[bot] 0
Update actions-rs/toolchain digest to 16499b5
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions-rs/toolchain | action | digest | 88dc235 -> 16499b5 |

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.
opened by renovate[bot] 0
Dependency Dashboard
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

[ ] Update actions-rs/toolchain digest to 16499b5

Detected dependencies

cargo

Cargo.toml

indexmap 1.9

yaml-rust 0.4.5

text_io 0.1.12

github-actions

.github/workflows/build.yml

actions/checkout v3

.github/workflows/clippy.yml

actions/checkout v3

actions-rs/toolchain v1@88dc2356392166efad76775c878094f4e83ff746

github/codeql-action v2

[ ] Check this box to trigger a request for Renovate to run again on this repository
opened by renovate[bot] 0

Validation addition: Ensure links have proper references

Example:

root: valid
nodes:
  valid:
    dialogue: "This is a totally valid node"
  valid_with_bad_link:
    dialogue: "This is a totally valid node"
    links:
      - valid: "This is a valid link"
      - invalid_link: "This is an invalid link because `invalid_link` does not exist"

bug

opened by simbleau 0

Releases(v0.1.2)

v0.1.2(Jul 4, 2021)
Added

Initial Release of Convo

Changed

Fixed repository link in Cargo.toml

Fixed

Nothing

Source code(tar.gz)
Source code(zip)