diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Cargo.toml | 24 | ||||
| -rw-r--r-- | LICENSE-0BSD | 5 | ||||
| -rw-r--r-- | LICENSE-APACHE | 201 | ||||
| -rw-r--r-- | LICENSE-MIT | 21 | ||||
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | src/actor/components.rs | 52 | ||||
| -rw-r--r-- | src/actor/events.rs | 72 | ||||
| -rw-r--r-- | src/actor/mod.rs | 95 | ||||
| -rw-r--r-- | src/actor/resources.rs | 8 | ||||
| -rw-r--r-- | src/actor/systems.rs | 121 | ||||
| -rw-r--r-- | src/lib.rs | 21 | ||||
| -rw-r--r-- | src/systems.rs | 32 | ||||
| -rw-r--r-- | src/util.rs | 88 | ||||
| -rw-r--r-- | src/widgets.rs | 181 |
15 files changed, 944 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..f4832bb --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,24 @@ +[package] +name = "bevy_terminal_dialog" +version = "0.1.0" +edition = "2021" + +[dependencies] +bevy_terminal_display = "0.4" +yarnspinner = "0.3" +textwrap = "0.16" +zalgo = "0.2" +arbitrary-chunks = "0.4" +unicode-segmentation = "1.11" +anyhow = "1.0" +downcast-rs = "1.2" +lazy_static = "1.5" + +[dependencies.bevy_basic_interaction] +git = "https://github.com/exvacuum/bevy_basic_interaction.git" +tag = "v0.1.0" + +[dependencies.bevy] +version = "0.14" +default-features = false + diff --git a/LICENSE-0BSD b/LICENSE-0BSD new file mode 100644 index 0000000..7a39b21 --- /dev/null +++ b/LICENSE-0BSD @@ -0,0 +1,5 @@ +Copyright (C) 2024 by Silas Bartha silas@exvacuum.dev + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..2ad6853 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Silas Bartha + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..dcc255f --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Silas Bartha + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e00de1 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# bevy_terminal_dialog +> [!WARNING] +> This library is highly experimental and not intended for use by literally anyone ever. I will eventually clean this readme up, but for now don't worry about it. + +## Compatibility + +| Crate Version | Bevy Version | +|--- |--- | +| 0.1 | 0.14 | + +## Installation + +If enough people (like literally 1 person) want this on crates.io I'll consider putting it up there, but for now just add the GitHub URL to your `Cargo.toml`: + +```toml +[dependencies.bevy_terminal_dialog] +git = "https://github.com/exvacuum/bevy_terminal_dialog" +``` + +## License + +This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license. diff --git a/src/actor/components.rs b/src/actor/components.rs new file mode 100644 index 0000000..43987c0 --- /dev/null +++ b/src/actor/components.rs @@ -0,0 +1,52 @@ +//! Components related to actors + +use bevy::{prelude::*, utils::HashMap}; +use yarnspinner::{compiler::{Compiler, File}, core::{Library, LineId}, runtime::{Dialogue, MemoryVariableStorage, StringTableTextProvider}}; + +/// Main actor component, holds state about dialogue along with the dialogue runner itself +#[derive(Component)] +pub struct Actor { + /// Whether this actor is currently conversing + pub active: bool, + /// Yarnspinner dialogue runner + pub dialogue: Dialogue, + /// Yarnspinner dialogue metadata + pub metadata: HashMap<LineId, Vec<String>>, +} + +impl Actor { + /// Create a new actor from the given source code, starting on the given start node, and with + /// the given function library + pub fn new(file_name: &str, source: &[u8], start_node: &str, function_library: &Library) -> Self { + let compilation = Compiler::new() + .add_file(File { + source: String::from_utf8_lossy(source).into(), + file_name: file_name.into(), + }) + .compile() + .unwrap(); + + let mut base_language_string_table = std::collections::HashMap::new(); + let mut metadata = HashMap::new(); + + for (k, v) in compilation.string_table { + base_language_string_table.insert(k.clone(), v.text); + metadata.insert(k, v.metadata); + } + + let mut text_provider = StringTableTextProvider::new(); + text_provider.extend_base_language(base_language_string_table); + + let mut dialogue = Dialogue::new(Box::new(MemoryVariableStorage::new()), Box::new(text_provider)); + dialogue.library_mut().extend(function_library.clone()); + dialogue.add_program(compilation.program.unwrap()); + dialogue.set_node(start_node).unwrap(); + + Self { + active: false, + dialogue, + metadata, + } + } +} + diff --git a/src/actor/events.rs b/src/actor/events.rs new file mode 100644 index 0000000..e24e7f3 --- /dev/null +++ b/src/actor/events.rs @@ -0,0 +1,72 @@ +//! Actor-related events + +use bevy::prelude::*; +use yarnspinner::{core::LineId, runtime::{Command, DialogueOption, Line, OptionId}}; + +/// Event called by user to progress dialogue +#[derive(Debug, Event)] +pub enum ContinueDialogueEvent { + /// Continue to next line of dialogue for given actor entity + Continue(Entity), + /// Submit option selection to given actor entity + SelectedOption { + /// Target actor entity + actor: Entity, + /// Selected option ID + option: OptionId + }, +} + +/// Event called by plugin in response to a corresponding yarnspinner dialogue events +/// +/// The user should catch these events to update UI, and never call it directly. +#[derive(Event)] +pub enum DialogueEvent { + /// Recieved new line of dialogue + Line { + /// Actor entity + actor: Entity, + /// Line of dialogue received + line: Line, + }, + /// Dialogue complete + DialogueComplete { + /// Actor entity + actor: Entity, + }, + /// Encountered an option selection + Options { + /// Actor entity + actor: Entity, + /// Options to select from + options: Vec<DialogueOption>, + }, + /// Triggered a yarnspinner command + Command { + /// Actor entity + actor: Entity, + /// Triggered command + command: Command, + }, + /// Node started + NodeStart { + /// Actor entity + actor: Entity, + /// Name of started node + name: String, + }, + /// Node complete + NodeComplete { + /// Actor entity + actor: Entity, + /// Name of completed node + name: String, + }, + /// Received line hints + LineHints { + /// Actor entity + actor: Entity, + /// Lines affected + lines: Vec<LineId>, + }, +} diff --git a/src/actor/mod.rs b/src/actor/mod.rs new file mode 100644 index 0000000..3ecc32e --- /dev/null +++ b/src/actor/mod.rs @@ -0,0 +1,95 @@ +//! NPCs containing their own individual yarnspinner contexts +// TODO: Split off into own crate? + +use std::sync::{Arc, Mutex}; + +use bevy::{prelude::*, utils::HashMap}; +use lazy_static::lazy_static; +use resources::FunctionLibrary; +use yarnspinner::core::YarnValue; + +pub mod components; +pub mod events; +pub mod resources; +mod systems; + +lazy_static! { + /// Custom yarnspinner variable storage + /// Stores variables as <instance>.<varname> + /// Global variables are stored in the "global" instance + pub static ref DIRWORLD_VARIABLE_STORAGE: Arc<Mutex<DirworldVariableStorage>> = + Arc::new(Mutex::new(DirworldVariableStorage::default())); +} + +/// Plugin which controls the behavior of actors +pub struct ActorPlugin; + +impl Plugin for ActorPlugin { + fn build(&self, app: &mut App) { + let mut function_library = FunctionLibrary::default(); + function_library.add_function("get_string", get_string); + function_library.add_function("get_number", get_number); + function_library.add_function("get_bool", get_bool); + + app.add_systems( + Update, + (systems::handle_dialog_initiation, systems::progress_dialog, systems::handle_variable_set_commands), + ) + .insert_resource(function_library) + .add_event::<events::ContinueDialogueEvent>() + .add_event::<events::DialogueEvent>(); + } +} + +fn get_string(instance_name: &str, var_name: &str) -> String { + if let Some(YarnValue::String(value)) = DIRWORLD_VARIABLE_STORAGE + .lock() + .unwrap() + .get(instance_name, var_name) + { + value + } else { + "".into() + } +} + +fn get_number(instance_name: &str, var_name: &str) -> f32 { + if let Some(YarnValue::Number(value)) = DIRWORLD_VARIABLE_STORAGE + .lock() + .unwrap() + .get(instance_name, var_name) + { + value + } else { + 0.0 + } +} + +fn get_bool(instance_name: &str, var_name: &str) -> bool { + if let Some(YarnValue::Boolean(value)) = DIRWORLD_VARIABLE_STORAGE + .lock() + .unwrap() + .get(instance_name, var_name) + { + value + } else { + false + } +} + +/// Variable Storage +#[derive(Default, Debug)] +pub struct DirworldVariableStorage(pub HashMap<String, YarnValue>); + +impl DirworldVariableStorage { + /// Set value of instance variable (use "global" for global) + pub fn set(&mut self, instance_name: &str, var_name: &str, value: YarnValue) { + self.0.insert(format!("{instance_name}.{var_name}"), value); + } + + /// Get value of instance variable (use "global" for global) + pub fn get(&self, instance_name: &str, var_name: &str) -> Option<YarnValue> { + self.0.get(&format!("{instance_name}.{var_name}")).cloned() + } +} + diff --git a/src/actor/resources.rs b/src/actor/resources.rs new file mode 100644 index 0000000..76ead59 --- /dev/null +++ b/src/actor/resources.rs @@ -0,0 +1,8 @@ +//! Actor-related resources + +use bevy::prelude::*; +use yarnspinner::core::Library; + +/// Library of yarnspinner function callbacks +#[derive(Resource, Deref, DerefMut, Default, Debug)] +pub struct FunctionLibrary(pub Library); diff --git a/src/actor/systems.rs b/src/actor/systems.rs new file mode 100644 index 0000000..a719858 --- /dev/null +++ b/src/actor/systems.rs @@ -0,0 +1,121 @@ +use bevy::prelude::*; +use bevy_basic_interaction::events::InteractionEvent; +use yarnspinner::core::YarnValue; + +use super::{ + components::Actor, + events::{ContinueDialogueEvent, DialogueEvent}, DIRWORLD_VARIABLE_STORAGE, +}; + +pub fn handle_dialog_initiation( + mut event_reader: EventReader<InteractionEvent>, + mut actor_query: Query<(Entity, &mut Actor)>, + mut event_writer: EventWriter<ContinueDialogueEvent>, +) { + for InteractionEvent { interactable, .. } in event_reader.read() { + if let Ok((actor_entity, mut actor)) = actor_query.get_mut(*interactable) { + actor.active = true; + event_writer.send(ContinueDialogueEvent::Continue(actor_entity)); + } + } +} + +pub fn progress_dialog( + mut event_reader: EventReader<ContinueDialogueEvent>, + mut actor_query: Query<&mut Actor>, + mut event_writer: EventWriter<DialogueEvent>, +) { + for event in event_reader.read() { + let actor_entity = match event { + ContinueDialogueEvent::Continue(actor) => actor, + ContinueDialogueEvent::SelectedOption { actor, .. } => actor, + }; + + if let Ok(mut actor) = actor_query.get_mut(*actor_entity) { + if let ContinueDialogueEvent::SelectedOption { option, .. } = event { + actor.dialogue.set_selected_option(*option).unwrap(); + } + if actor.dialogue.current_node().is_none() { + actor.dialogue.set_node("Start").unwrap(); + } + match actor.dialogue.continue_() { + Ok(events) => { + info!("BATCH"); + for event in events { + info!("Event: {:?}", event); + match event { + yarnspinner::prelude::DialogueEvent::Line(line) => { + event_writer.send(DialogueEvent::Line { + actor: *actor_entity, + line, + }); + } + yarnspinner::prelude::DialogueEvent::DialogueComplete => { + event_writer.send(DialogueEvent::DialogueComplete { + actor: *actor_entity, + }); + } + yarnspinner::prelude::DialogueEvent::Options(options) => { + event_writer.send(DialogueEvent::Options { + actor: *actor_entity, + options, + }); + } + yarnspinner::runtime::DialogueEvent::Command(command) => { + event_writer.send(DialogueEvent::Command { + actor: *actor_entity, + command, + }); + } + yarnspinner::runtime::DialogueEvent::NodeStart(name) => { + event_writer.send(DialogueEvent::NodeStart { + actor: *actor_entity, + name, + }); + } + yarnspinner::runtime::DialogueEvent::NodeComplete(name) => { + event_writer.send(DialogueEvent::NodeComplete { + actor: *actor_entity, + name, + }); + } + yarnspinner::runtime::DialogueEvent::LineHints(lines) => { + event_writer.send(DialogueEvent::LineHints { + actor: *actor_entity, + lines, + }); + } + } + } + } + Err(err) => error!("{:?}", err), + } + } + } +} + +pub fn handle_variable_set_commands( + mut event_reader: EventReader<DialogueEvent>, + mut event_writer: EventWriter<ContinueDialogueEvent>, +) { + for event in event_reader.read() { + if let DialogueEvent::Command { command, actor } = event { + if command.name != "set_var" { + continue; + } + + event_writer.send(ContinueDialogueEvent::Continue(*actor)); + + if command.parameters.len() != 3 { + warn!("Incorrect number of parameters passed to set command: {}", command.parameters.len()); + continue; + } + + if let YarnValue::String(instance_name) = &command.parameters[0] { + if let YarnValue::String(var_name) = &command.parameters[1] { + DIRWORLD_VARIABLE_STORAGE.lock().unwrap().set(instance_name, var_name, command.parameters[2].clone()); + } + } + } + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..c11e51f --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,21 @@ +#![warn(missing_docs)] + +//! Bevy plugin providing a yarnspinner-based dialog system for the bevy_terminal_display plugin +//! and dirworld plugin. + +use bevy::prelude::*; + +mod systems; +pub mod widgets; +pub mod util; +pub mod actor; + +/// Plugin which provides dialog functionality +pub struct TerminalDialogPlugin; + +impl Plugin for TerminalDialogPlugin { + fn build(&self, app: &mut App) { + app.add_plugins(actor::ActorPlugin) + .add_systems(Startup, systems::setup); + } +} diff --git a/src/systems.rs b/src/systems.rs new file mode 100644 index 0000000..444e99f --- /dev/null +++ b/src/systems.rs @@ -0,0 +1,32 @@ +use bevy::prelude::*; +use bevy_terminal_display::widgets::components::Widget; + +use super::widgets::{DialogBox, DialogBoxWidget, InteractTooltip, InteractTooltipWidget, OptionsBox, OptionsBoxWidget}; + +pub fn setup(mut commands: Commands) { + commands.spawn(( + InteractTooltip, + Widget { + enabled: false, + depth: 0, + widget: Box::new(InteractTooltipWidget), + }, + )); + + commands.spawn(( + DialogBox, + Widget { + enabled: false, + depth: 0, + widget: Box::<DialogBoxWidget>::default(), + }, + )); + commands.spawn(( + OptionsBox, + Widget { + enabled: false, + depth: 0, + widget: Box::<OptionsBoxWidget>::default(), + }, + )); +} diff --git a/src/util.rs b/src/util.rs new file mode 100644 index 0000000..bac2a4e --- /dev/null +++ b/src/util.rs @@ -0,0 +1,88 @@ +//! Utilities related to the dialog widget display + +use bevy_terminal_display::ratatui::style::{Color, Style, Stylize}; +use yarnspinner::runtime::MarkupValue; +use zalgo::{Generator, GeneratorArgs, ZalgoSize}; + +/// Splits a marked-up yarnspinner line into sections of text and their corresponding ratatui styles +pub fn style_line(line: &yarnspinner::runtime::Line) -> Vec<(String, Style)> { + if line.attributes.is_empty() { + return vec![(line.text_without_character_name(), Style::new())]; + } + + let mut line_segments = Vec::<(String, Style)>::new(); + let mut attributes = line.attributes.clone(); + attributes.sort_by_key(|attribute| attribute.position); + line_segments.push(( + line.text[..attributes[0].position].to_string(), + Style::new(), + )); + for (i, attribute) in attributes.iter().enumerate() { + let mut attrib_text = line.text_for_attribute(&attribute).to_string(); + let mut style = Style::new(); + match attribute.name.as_str() { + "style" => { + for (property_name, property_value) in attribute.properties.iter() { + match property_name.as_str() { + "bold" => { + if let MarkupValue::Bool(value) = property_value { + if *value { + style = style.bold(); + } + } + } + "italic" => { + if let MarkupValue::Bool(value) = property_value { + if *value { + style = style.italic(); + } + } + } + "color" => { + if let MarkupValue::Integer(value) = property_value { + style = style.fg(Color::Indexed(*value as u8)) + } + } + "zalgo" => { + if let MarkupValue::Bool(value) = property_value { + if *value { + let mut generator = Generator::new(); + let mut out = String::new(); + let args = + GeneratorArgs::new(true, true, true, ZalgoSize::Mini); + generator.gen(&attrib_text, &mut out, &args); + attrib_text = out; + } + } + } + "bg" => { + if let MarkupValue::Integer(value) = property_value { + style = style.bg(Color::Indexed(*value as u8)) + } + } + _ => (), + } + } + } + _ => (), + } + if attribute.name != "character" { + line_segments.push((attrib_text, style)) + } + + if let Some(next_attribute) = attributes.get(i + 1) { + line_segments.push(( + line.text[attribute.position + attribute.length..next_attribute.position] + .to_string(), + Style::new(), + )); + } + } + let last_attribute = attributes.last().unwrap(); + line_segments.push(( + line.text[last_attribute.position + last_attribute.length..].to_string(), + Style::new(), + )); + + line_segments +} diff --git a/src/widgets.rs b/src/widgets.rs new file mode 100644 index 0000000..52eff3c --- /dev/null +++ b/src/widgets.rs @@ -0,0 +1,181 @@ +//! bevy_terminal_display widgets for dialog boxes + +use bevy::prelude::*; +use bevy_terminal_display::{crossterm, ratatui::{layout::{Alignment, Constraint, Flex, Layout}, style::Style, text::{Line, Span}, widgets::{Block, Borders, Clear, HighlightSpacing, List, ListItem, ListState, Padding, Paragraph, Wrap}}, widgets::TerminalWidget}; +use yarnspinner::runtime::DialogueOption; +use unicode_segmentation::UnicodeSegmentation as _; +use arbitrary_chunks::ArbitraryChunks as _; + +/// Interaction tooltip widget marker +// TODO: Move tooltip out of this crate? +#[derive(Component)] +pub struct InteractTooltip; + +/// Interaction tooltip widget +pub struct InteractTooltipWidget; + +impl TerminalWidget for InteractTooltipWidget { + fn render( + &mut self, + frame: &mut bevy_terminal_display::ratatui::Frame, + rect: bevy_terminal_display::ratatui::prelude::Rect, + ) { + let text = Paragraph::new("E") + .block( + Block::new() + .borders(Borders::ALL) + .padding(Padding::horizontal(1)), + ) + .alignment(Alignment::Center); + let [area] = Layout::horizontal([Constraint::Length(5)]) + .flex(Flex::Center) + .areas(rect); + let [area] = Layout::vertical([Constraint::Length(3)]) + .flex(Flex::Center) + .areas(area); + frame.render_widget(Clear, area); + frame.render_widget(text, area); + } +} + +/// Dialog box widget marker +#[derive(Component)] +pub struct DialogBox; + +/// Dialog box widget +#[derive(Default)] +pub struct DialogBoxWidget { + /// Name of speaking character + pub character: Option<String>, + /// Chunks of text and corresponding styles representing the currently spoken line + pub text: Vec<(String, Style)>, +} + +impl TerminalWidget for DialogBoxWidget { + fn render( + &mut self, + frame: &mut bevy_terminal_display::ratatui::Frame, + rect: bevy_terminal_display::ratatui::prelude::Rect, + ) { + let text = Paragraph::new(bevy_terminal_display::ratatui::text::Line::from( + self.text + .iter() + .map(|(text, style)| Span::styled(text, *style)) + .collect::<Vec<_>>(), + )) + .wrap(Wrap { trim: true }) + .block({ + let mut block = Block::new() + .borders(Borders::ALL) + .padding(Padding::horizontal(1)); + if let Some(character) = &self.character { + block = block.title(character.clone()); + } + block + }); + let [area] = Layout::horizontal([Constraint::Max(100)]) + .flex(Flex::Center) + .areas(rect); + let [area] = Layout::vertical([Constraint::Max(10)]) + .flex(Flex::End) + .areas(area); + frame.render_widget(Clear, area); + frame.render_widget(text, area); + } +} + +/// Option selection box widget marker +#[derive(Component)] +pub struct OptionsBox; + +/// Option selection box widget +#[derive(Default)] +pub struct OptionsBoxWidget { + /// State of ratatui list widget + pub state: ListState, + /// Available dialog options + pub options: Vec<(DialogueOption, Vec<(String, Style)>)>, +} + +impl TerminalWidget for OptionsBoxWidget { + fn render( + &mut self, + frame: &mut bevy_terminal_display::ratatui::Frame, + rect: bevy_terminal_display::ratatui::prelude::Rect, + ) { + let terminal_size = crossterm::terminal::size().unwrap(); + let box_size: u16 = if terminal_size.0 > 40 { 20 } else { 10 }; + let items = self + .options + .iter() + .map(|option| { + let option_spans = option + .1 + .iter() + .map(|(text, style)| Span::styled(text, *style)) + .collect::<Vec<_>>(); + let string_chunks = textwrap::wrap( + &Line::from(option_spans.clone()).to_string(), + textwrap::Options::new(box_size as usize), + ) + .into_iter() + .map(|chunk| chunk.graphemes(true).count()) + .collect::<Vec<_>>(); + + let line = Line::from(option_spans); + let graphemes = line.styled_graphemes(Style::default()).collect::<Vec<_>>(); + + let mut final_string_chunks = vec![]; + let mut i = 0; + for string_chunk in string_chunks { + final_string_chunks.push(string_chunk); + i += string_chunk; + if let Some(grapheme) = graphemes.get(i) { + if grapheme.symbol == " " { + final_string_chunks.push(1); + i += 1; + } + } + } + + let mut chunked_graphemes = graphemes + .arbitrary_chunks(&final_string_chunks) + .collect::<Vec<_>>(); + chunked_graphemes.retain(|chunk| !(chunk.len() == 1 && chunk[0].symbol == " ")); + + let line = chunked_graphemes + .into_iter() + .map(|chunk| { + Line::from( + chunk + .iter() + .map(|grapheme| { + Span::styled(grapheme.symbol.to_string(), grapheme.style) + }) + .collect::<Vec<_>>(), + ) + }) + .collect::<Vec<_>>(); + ListItem::new(line) + }) + .collect::<Vec<_>>(); + + let height = items.iter().fold(0, |acc, item| acc + item.height()); + + let outer_block = Block::bordered().padding(Padding::horizontal(1)); + let list = List::new(items) + .block(outer_block) + .highlight_symbol("-> ") + .highlight_spacing(HighlightSpacing::Always); + + let [area] = Layout::horizontal([Constraint::Length(box_size + 7)]) + .flex(Flex::Center) + .areas(rect); + let [area] = Layout::vertical([Constraint::Length(height as u16 + 2)]) + .flex(Flex::Center) + .areas(area); + + frame.render_widget(Clear, area); + frame.render_stateful_widget(list, area, &mut self.state); + } +} |