Switch to Yarn Slinger for dialog

Author: janhohenheim

Cargo.lock

@@ -52,6 +52,10 @@ bevy_rapier3d = { version = "0.23", features = [ "serde-serialize", "simd-stable
 bevy_editor_pls = { version = "0.7", optional = true }
 bevy_hanabi = "0.9"
 
+# https://github.com/yarn-slinger/yarn-slinger/issues/172
+bevy_yarn_slinger = { git = "https://github.com/yarn-slinger/yarn-slinger", rev = "d0a4031e51622ad309b23b7dbc81230076af2bb4" }
+bevy_yarn_slinger_example_dialogue_view = { git = "https://github.com/yarn-slinger/yarn-slinger", rev = "d0a4031e51622ad309b23b7dbc81230076af2bb4" }
+
 # keep the following in sync with Bevy's dependencies
 ## https://github.com/bevyengine/bevy/blob/v0.12.1/crates/bevy_winit/Cargo.toml#L31
 winit = { version = "0.28.7", default-features = false }

Cargo.toml

@@ -0,0 +1,10 @@
+title: Follower
+---
+Hello World! To continue the dialogue, click with your mouse or press the spacebar.
+These are options. You can select one by clicking on it or pressing the corresponding number on your keyboard.
+-> Some cool option
+-> Some other cool option
+Now we'll jump to another node!
+<<jump AnotherNode>>
+
+===

assets/dialogs/follower.dlg.ron assets/dialogue/follower.dlg.ron

@@ -1,6 +1,5 @@
 use crate::file_system_interaction::config::GameConfig;
 use crate::file_system_interaction::level_serialization::SerializedLevel;
-use crate::world_interaction::dialog::Dialog;
 use crate::GameState;
 use anyhow::Result;
 use bevy::prelude::*;
@@ -16,7 +15,6 @@ use iyes_progress::{ProgressCounter, ProgressPlugin};
 
 pub(crate) fn loading_plugin(app: &mut App) {
     app.add_plugins(RonAssetPlugin::<SerializedLevel>::new(&["lvl.ron"]))
-        .add_plugins(RonAssetPlugin::<Dialog>::new(&["dlg.ron"]))
         .add_plugins(TomlAssetPlugin::<GameConfig>::new(&["game.toml"]))
         .add_plugins(ProgressPlugin::new(GameState::Loading).continue_to(GameState::Menu))
         .add_loading_state(
@@ -26,7 +24,6 @@ pub(crate) fn loading_plugin(app: &mut App) {
                 .load_collection::<SceneAssets>()
                 .load_collection::<AnimationAssets>()
                 .load_collection::<LevelAssets>()
-                .load_collection::<DialogAssets>()
                 .load_collection::<TextureAssets>()
                 .load_collection::<ConfigAssets>(),
         )
@@ -67,12 +64,6 @@ pub(crate) struct LevelAssets {
     pub(crate) levels: HashMap<String, Handle<SerializedLevel>>,
 }
 
-#[derive(AssetCollection, Resource, Clone)]
-pub(crate) struct DialogAssets {
-    #[asset(path = "dialogs", collection(typed, mapped))]
-    pub(crate) dialogs: HashMap<String, Handle<Dialog>>,
-}
-
 #[derive(AssetCollection, Resource, Clone)]
 pub(crate) struct TextureAssets {
     #[asset(path = "textures/stone_alley_2.jpg")]
@@ -96,7 +87,6 @@ fn show_progress(
     scene_assets: Option<Res<SceneAssets>>,
     animation_assets: Option<Res<AnimationAssets>>,
     level_assets: Option<Res<LevelAssets>>,
-    dialog_assets: Option<Res<DialogAssets>>,
     texture_assets: Option<Res<TextureAssets>>,
     config_assets: Option<Res<ConfigAssets>>,
 ) {
@@ -119,7 +109,6 @@ fn show_progress(
                     ui.checkbox(&mut scene_assets.is_some(), "Scenes");
                     ui.checkbox(&mut animation_assets.is_some(), "Animations");
                     ui.checkbox(&mut level_assets.is_some(), "Levels");
-                    ui.checkbox(&mut dialog_assets.is_some(), "Dialogs");
                     ui.checkbox(&mut texture_assets.is_some(), "Textures");
                     ui.checkbox(&mut config_assets.is_some(), "Config");
                 });

assets/dialogue/follower.yarn

@@ -8,7 +8,6 @@ pub(crate) struct GameConfig {
     pub(crate) camera: Camera,
     pub(crate) characters: Characters,
     pub(crate) player: Player,
-    pub(crate) dialog: Dialog,
 }
 
 #[derive(Debug, Clone, PartialEq, Reflect, Serialize, Deserialize, Default)]
@@ -76,9 +75,3 @@ pub(crate) struct Player {
     pub(crate) min_fov: f32,
     pub(crate) max_fov: f32,
 }
-
-#[derive(Debug, Clone, PartialEq, Reflect, Serialize, Deserialize, Default)]
-#[reflect(Serialize, Deserialize)]
-pub(crate) struct Dialog {
-    pub(crate) base_letters_per_second: f32,
-}

src/file_system_interaction/asset_loading.rs

@@ -2,7 +2,6 @@ use crate::file_system_interaction::level_serialization::{CurrentLevel, WorldLoa
 use crate::level_instantiation::spawning::GameObject;
 use crate::player_control::player_embodiment::Player;
 use crate::world_interaction::condition::ActiveConditions;
-use crate::world_interaction::dialog::{CurrentDialog, DialogEvent};
 use crate::GameState;
 use anyhow::{Context, Error, Result};
 use bevy::prelude::*;
@@ -45,8 +44,6 @@ struct SaveModel {
     #[serde(default, skip_serializing_if = "ActiveConditions::is_empty")]
     conditions: ActiveConditions,
     player_transform: Transform,
-    #[serde(default, skip_serializing_if = "Option::is_none")]
-    dialog_event: Option<DialogEvent>,
 }
 
 #[sysfail(log(level = "error"))]
@@ -55,7 +52,6 @@ fn handle_load_requests(
     mut load_events: EventReader<GameLoadRequest>,
     mut loader: EventWriter<WorldLoadRequest>,
     mut spawner: EventWriter<SpawnEvent<GameObject, Transform>>,
-    mut dialog_event_writer: EventWriter<DialogEvent>,
 ) -> Result<()> {
     for load in load_events.read() {
         let path = match load
@@ -96,9 +92,6 @@ fn handle_load_requests(
         loader.send(WorldLoadRequest {
             filename: save_model.scene,
         });
-        if let Some(dialog_event) = save_model.dialog_event {
-            dialog_event_writer.send(dialog_event);
-        }
         commands.insert_resource(save_model.conditions);
 
         spawner.send(
@@ -128,22 +121,14 @@ fn read_last_save() -> Result<Option<PathBuf>, Error> {
 fn handle_save_requests(
     mut save_events: EventReader<GameSaveRequest>,
     conditions: Res<ActiveConditions>,
-    dialog: Option<Res<CurrentDialog>>,
     player_query: Query<&GlobalTransform, With<Player>>,
     current_level: Res<CurrentLevel>,
 ) -> Result<()> {
-    let dialog = dialog.map(|dialog| dialog.clone());
     for save in save_events.read() {
         for player in &player_query {
-            let dialog_event = dialog.clone().map(|dialog| DialogEvent {
-                dialog: dialog.id,
-                source: dialog.source,
-                page: Some(dialog.current_page),
-            });
             let save_model = SaveModel {
                 scene: current_level.scene.clone(),
                 conditions: conditions.clone(),
-                dialog_event,
                 player_transform: player.compute_transform(),
             };
             let serialized = match ron::to_string(&save_model) {

src/file_system_interaction/config.rs

@@ -1,7 +1,6 @@
 use crate::file_system_interaction::asset_loading::LevelAssets;
 use crate::level_instantiation::spawning::GameObject;
 use crate::world_interaction::condition::ActiveConditions;
-use crate::world_interaction::dialog::CurrentDialog;
 use crate::world_interaction::interactions_ui::InteractionOpportunities;
 use anyhow::{Context, Result};
 use bevy::prelude::*;
@@ -132,7 +131,6 @@ fn load_world(
         });
         commands.insert_resource(InteractionOpportunities::default());
         commands.insert_resource(ActiveConditions::default());
-        commands.remove_resource::<CurrentDialog>();
 
         info!("Successfully loaded scene \"{}\"", load.filename,)
     }

src/file_system_interaction/game_state_serialization.rs

@@ -3,7 +3,7 @@ use crate::level_instantiation::spawning::objects::GameCollisionGroup;
 use crate::level_instantiation::spawning::GameObject;
 use crate::movement::general_movement::{CharacterAnimations, CharacterControllerBundle, Model};
 use crate::movement::navigation::Follower;
-use crate::world_interaction::dialog::{DialogId, DialogTarget};
+use crate::world_interaction::dialog::DialogTarget;
 use bevy::prelude::*;
 use bevy_rapier3d::prelude::*;
 use std::f32::consts::TAU;
@@ -32,7 +32,8 @@ pub(crate) fn spawn(
                 aerial: animations.character_running.clone(),
             },
             DialogTarget {
-                dialog_id: DialogId::new("follower"),
+                speaker: "The Follower".to_string(),
+                node: "Follower".to_string(),
             },
             GameObject::Npc,
         ))

src/file_system_interaction/level_serialization.rs

@@ -62,27 +62,6 @@ pub(crate) enum PlayerAction {
     NumberedChoice0,
 }
 
-impl PlayerAction {
-    pub(crate) fn numbered_choice(index: u8) -> Self {
-        match index {
-            0 => PlayerAction::NumberedChoice0,
-            1 => PlayerAction::NumberedChoice1,
-            2 => PlayerAction::NumberedChoice2,
-            3 => PlayerAction::NumberedChoice3,
-            4 => PlayerAction::NumberedChoice4,
-            5 => PlayerAction::NumberedChoice5,
-            6 => PlayerAction::NumberedChoice6,
-            7 => PlayerAction::NumberedChoice7,
-            8 => PlayerAction::NumberedChoice8,
-            9 => PlayerAction::NumberedChoice9,
-            _ => panic!(
-                "Numbered choice index out of range: got {}, expected 0-9",
-                index
-            ),
-        }
-    }
-}
-
 #[derive(Debug, Clone, Eq, PartialEq, Hash, Actionlike, Reflect, Default)]
 pub(crate) enum CameraAction {
     #[default]

src/level_instantiation/spawning/objects/npc.rs

@@ -1,28 +1,33 @@
 use crate::player_control::camera::IngameCamera;
 use crate::player_control::player_embodiment::Player;
-use crate::world_interaction::dialog::CurrentDialog;
+use crate::world_interaction::dialog::DialogTarget;
 use anyhow::Result;
 use bevy::prelude::*;
 use bevy_mod_sysfail::*;
+use bevy_yarn_slinger_example_dialogue_view::SpeakerChangeEvent;
 
 #[sysfail(log(level = "error"))]
 pub(crate) fn set_camera_focus(
     mut camera_query: Query<&mut IngameCamera>,
-    current_dialog: Option<Res<CurrentDialog>>,
+    mut speaker_change_events: EventReader<SpeakerChangeEvent>,
     player_query: Query<&Transform, With<Player>>,
-    non_player_query: Query<&GlobalTransform, Without<Player>>,
+    dialog_targets: Query<(&Transform, &DialogTarget), Without<Player>>,
 ) -> Result<()> {
-    for mut camera in camera_query.iter_mut() {
-        for player_transform in player_query.iter() {
-            if let Some(ref active_dialogue) = current_dialog {
-                let dialog_target_transform = non_player_query
-                    .get(active_dialogue.source)?
-                    .compute_transform();
-                camera.secondary_target = Some(dialog_target_transform);
-            } else {
-                camera.secondary_target = None;
+    for event in speaker_change_events.read() {
+        for mut camera in camera_query.iter_mut() {
+            for player_transform in player_query.iter() {
+                if event.speaking {
+                    for (dialog_target_transform, dialog_target) in dialog_targets.iter() {
+                        if dialog_target.speaker == event.character_name {
+                            camera.secondary_target = Some(*dialog_target_transform);
+                            camera.target = *player_transform;
+                        }
+                    }
+                } else {
+                    camera.secondary_target = None;
+                }
+                camera.target = *player_transform;
             }
-            camera.target = *player_transform;
         }
     }
     Ok(())

src/player_control/actions.rs

@@ -5,13 +5,14 @@ use crate::player_control::actions::{DualAxisDataExt, PlayerAction};
 use crate::player_control::camera::{CameraUpdateSystemSet, IngameCamera, IngameCameraKind};
 use crate::util::smoothness_to_lerp_factor;
 use crate::util::trait_extension::{F32Ext, TransformExt, Vec3Ext};
-use crate::world_interaction::dialog::CurrentDialog;
+use crate::world_interaction::dialog::DialogTarget;
 use crate::GameState;
 use anyhow::{Context, Result};
 use bevy::prelude::*;
 use bevy_kira_audio::AudioInstance;
 use bevy_mod_sysfail::*;
 use bevy_rapier3d::prelude::*;
+use bevy_yarn_slinger_example_dialogue_view::SpeakerChangeEvent;
 use leafwing_input_manager::prelude::ActionState;
 use serde::{Deserialize, Serialize};
 use std::ops::DerefMut;
@@ -27,7 +28,7 @@ pub(crate) fn player_embodiment_plugin(app: &mut App) {
                 handle_jump,
                 handle_horizontal_movement,
                 handle_speed_effects,
-                rotate_to_speaker.run_if(resource_exists::<CurrentDialog>()),
+                rotate_to_speaker,
                 control_walking_sound,
                 handle_camera_kind,
             )
@@ -147,28 +148,35 @@ fn handle_speed_effects(
 fn rotate_to_speaker(
     time: Res<Time>,
     mut with_player: Query<(&mut Transform, &Velocity), With<Player>>,
-    without_player: Query<&Transform, Without<Player>>,
-    current_dialog: Res<CurrentDialog>,
+    speakers: Query<(&Transform, &DialogTarget), Without<Player>>,
+    mut speaker_change_event: EventReader<SpeakerChangeEvent>,
     config: Res<GameConfig>,
 ) {
     #[cfg(feature = "tracing")]
     let _span = info_span!("rotate_to_speaker").entered();
-    let Ok(speaker_transform) = without_player.get(current_dialog.source) else {
-        return;
-    };
-    let dt = time.delta_seconds();
+    for speaker_change in speaker_change_event.read() {
+        if !speaker_change.speaking {
+            continue;
+        }
+        let dt = time.delta_seconds();
 
-    for (mut transform, velocity) in with_player.iter_mut() {
-        let horizontal_velocity = velocity.linvel.split(transform.up()).horizontal;
-        if horizontal_velocity.is_approx_zero() {
-            let up = transform.up();
-            let target_rotation = transform
-                .horizontally_looking_at(speaker_transform.translation, up)
-                .rotation;
-            let smoothness = config.player.rotate_to_speaker_smoothness;
-            let factor = smoothness_to_lerp_factor(smoothness, dt);
-            let rotation = transform.rotation.slerp(target_rotation, factor);
-            transform.rotation = rotation;
+        for (mut transform, velocity) in with_player.iter_mut() {
+            for (speaker_transform, dialog_target) in speakers.iter() {
+                if dialog_target.speaker != speaker_change.character_name {
+                    continue;
+                }
+                let horizontal_velocity = velocity.linvel.split(transform.up()).horizontal;
+                if horizontal_velocity.is_approx_zero() {
+                    let up = transform.up();
+                    let target_rotation = transform
+                        .horizontally_looking_at(speaker_transform.translation, up)
+                        .rotation;
+                    let smoothness = config.player.rotate_to_speaker_smoothness;
+                    let factor = smoothness_to_lerp_factor(smoothness, dt);
+                    let rotation = transform.rotation.slerp(target_rotation, factor);
+                    transform.rotation = rotation;
+                }
+            }
         }
     }
 }