darkomen 0.5.0

Warhammer: Dark Omen library and CLI in Rust
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::{collections::HashMap, path::PathBuf};

use bevy_app::prelude::*;
use bevy_ecs::prelude::*;
#[cfg(feature = "bevy_reflect")]
use bevy_reflect::prelude::*;

pub struct AssetPathsPlugin;

impl Plugin for AssetPathsPlugin {
    fn build(&self, app: &mut App) {
        app.insert_resource(AssetPaths {
            gameflow_path: PathBuf::from("DARKOMEN/GAMEDATA/GAMEFLOW"),
            banners_path: PathBuf::from("DARKOMEN/GRAPHICS/BANNERS"),
            maps_path: PathBuf::from("DARKOMEN/GRAPHICS/MAPS"),
            pictures_path: PathBuf::from("DARKOMEN/GRAPHICS/PICTURES"),
            sprites_path: PathBuf::from("DARKOMEN/GRAPHICS/SPRITES"),
            books_path: PathBuf::from("DARKOMEN/GRAPHICS/BOOKS"),
            movies_path: PathBuf::from("DARKOMEN/MOVIES"),
            sound_path: PathBuf::from("DARKOMEN/SOUND/SOUND"),
            music_script_path: PathBuf::from("DARKOMEN/SOUND/SCRIPT"),
            music_path: PathBuf::from("DARKOMEN/SOUND/MUSIC"),
            sound_effect_packets_path: PathBuf::from("DARKOMEN/SOUND/H"),
        });
        #[cfg(feature = "bevy_reflect")]
        app.register_type::<AssetPaths>();
    }
}

#[derive(Clone, Resource)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(Resource))]
#[cfg_attr(all(feature = "bevy_reflect", feature = "debug"), reflect(Debug))]
pub struct AssetPaths {
    pub gameflow_path: PathBuf,
    pub banners_path: PathBuf,
    pub maps_path: PathBuf,
    pub pictures_path: PathBuf,
    pub sprites_path: PathBuf,
    pub books_path: PathBuf,
    pub movies_path: PathBuf,
    pub sound_path: PathBuf,
    pub music_script_path: PathBuf,
    pub music_path: PathBuf,
    pub sound_effect_packets_path: PathBuf,
}

impl Default for AssetPaths {
    fn default() -> Self {
        Self {
            gameflow_path: PathBuf::from("DARKOMEN/GAMEDATA/GAMEFLOW"),
            banners_path: PathBuf::from("DARKOMEN/GRAPHICS/BANNERS"),
            maps_path: PathBuf::from("DARKOMEN/GRAPHICS/MAPS"),
            pictures_path: PathBuf::from("DARKOMEN/GRAPHICS/PICTURES"),
            sprites_path: PathBuf::from("DARKOMEN/GRAPHICS/SPRITES"),
            books_path: PathBuf::from("DARKOMEN/GRAPHICS/BOOKS"),
            movies_path: PathBuf::from("DARKOMEN/MOVIES"),
            sound_path: PathBuf::from("DARKOMEN/SOUND/SOUND"),
            music_script_path: PathBuf::from("DARKOMEN/SOUND/SCRIPT"),
            music_path: PathBuf::from("DARKOMEN/SOUND/MUSIC"),
            sound_effect_packets_path: PathBuf::from("DARKOMEN/SOUND/H"),
        }
    }
}

impl AssetPaths {
    pub fn resolve_path(&self, file_path: &str) -> PathBuf {
        let mut placeholders = HashMap::new();
        placeholders.insert("[BOOKS]", &self.books_path);
        placeholders.insert("[BANNERS]", &self.banners_path);
        placeholders.insert("[GAMEFLOW]", &self.gameflow_path);
        placeholders.insert("[MAPS]", &self.maps_path);
        placeholders.insert("[MOVIES]", &self.movies_path);
        placeholders.insert("[PICTURES]", &self.pictures_path);
        placeholders.insert("[SOUND]", &self.sound_effect_packets_path);

        // Bevy asset paths are meant to be virtual paths, not OS paths, so we
        // need to replace backslashes with forward slashes.
        //
        // See https://github.com/bevyengine/bevy/issues/10511.
        let file_path = file_path.replace("\\", "/");

        let file_path = PathBuf::from(file_path);
        let file_path_str = file_path.to_string_lossy();

        for (placeholder, path) in placeholders {
            if file_path_str.starts_with(placeholder) {
                let replaced_path = file_path_str.replacen(placeholder, &path.to_string_lossy(), 1);
                return PathBuf::from(replaced_path);
            }
        }

        file_path
    }
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use super::*;

    macro_rules! test_resolve_path {
        ($name:ident, $input:expr, $expected:expr) => {
            #[test]
            fn $name() {
                let asset_paths = AssetPaths::default();
                let result = asset_paths.resolve_path($input);
                assert_eq!(result, PathBuf::from($expected));
            }
        };
    }

    test_resolve_path!(
        test_books_path,
        "[BOOKS]/hgban.spr",
        "DARKOMEN/GRAPHICS/BOOKS/hgban.spr"
    );
    test_resolve_path!(
        test_banners_path,
        "[BANNERS]/banner.png",
        "DARKOMEN/GRAPHICS/BANNERS/banner.png"
    );
    test_resolve_path!(
        test_no_placeholder,
        "no_placeholder.txt",
        "no_placeholder.txt"
    );
    test_resolve_path!(
        test_backslashes,
        "[BOOKS]\\hgban.spr",
        "DARKOMEN/GRAPHICS/BOOKS/hgban.spr"
    );
}