openworldformat 0.5.0

The Open World Format Rust reference: the world document, the session fold (log, branches, state), and the ext-physics and ext-cinematography extensions — serde-only, no engine required.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Tour definitions — guided camera/avatar paths through the world.

use serde::{Deserialize, Serialize};

use crate::avatar::PointOfView;

/// How the camera/avatar moves between tour waypoints.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
pub enum TourMode {
    /// Ground-level movement respecting gravity / terrain.
    #[default]
    Walk,
    /// Free-flying camera interpolation.
    Fly,
    /// Instant teleport between waypoints (cut, no interpolation).
    Teleport,
}

/// A single stop along a guided tour.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct TourWaypoint {
    /// Camera / avatar position at this stop.
    pub position: [f32; 3],
    /// Where the camera looks at this stop.
    pub look_at: [f32; 3],
    /// Narrative text shown to the user at this stop.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// How long to pause at this waypoint (seconds) before moving on.
    #[serde(default)]
    pub pause_duration: f32,
}

/// A guided tour — a named, ordered sequence of waypoints through the world.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct TourDef {
    /// Human-readable tour name (e.g., "grand_tour", "scenic_overlook").
    pub name: String,
    /// Brief description of the tour.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Ordered stops along the tour.
    pub waypoints: Vec<TourWaypoint>,
    /// Movement speed between waypoints (units/sec).
    #[serde(default = "default_tour_speed")]
    pub speed: f32,
    /// Movement mode between waypoints.
    #[serde(default)]
    pub mode: TourMode,
    /// If true, this tour starts automatically when the world is loaded.
    #[serde(default)]
    pub autostart: bool,
    /// If true, the tour loops back to the first waypoint after the last.
    #[serde(default)]
    pub loop_tour: bool,
    /// Optional PoV override for this tour (falls back to avatar default).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pov: Option<PointOfView>,
}

fn default_tour_speed() -> f32 {
    3.0
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn tour_roundtrip() {
        let tour = TourDef {
            name: "grand_tour".to_string(),
            description: Some("A scenic tour".to_string()),
            waypoints: vec![
                TourWaypoint {
                    position: [0.0, 1.0, 5.0],
                    look_at: [0.0, 1.5, 0.0],
                    description: Some("Start".to_string()),
                    pause_duration: 3.0,
                },
                TourWaypoint {
                    position: [10.0, 1.0, 0.0],
                    look_at: [5.0, 2.0, -5.0],
                    description: None,
                    pause_duration: 0.0,
                },
            ],
            speed: 2.0,
            mode: TourMode::Walk,
            autostart: false,
            loop_tour: true,
            pov: Some(PointOfView::ThirdPerson),
        };

        let json = serde_json::to_string_pretty(&tour).unwrap();
        let back: TourDef = serde_json::from_str(&json).unwrap();
        assert_eq!(tour, back);
    }

    #[test]
    fn tour_modes() {
        for mode in [TourMode::Walk, TourMode::Fly, TourMode::Teleport] {
            let json = serde_json::to_string(&mode).unwrap();
            let back: TourMode = serde_json::from_str(&json).unwrap();
            assert_eq!(mode, back);
        }
    }
}