source-fs 0.3.0

A virtual filesystem implementation for Source Engine games, handling gameinfo.txt search paths, VPK archives, and cross-platform file resolution.
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

use source_fs::{FileSystem, FileSystemError, FileSystemOptions, providers::{DummyVpk, P2GameInfo, SimpleGameInfo, SimpleWithMount}};
use std::path::Path;

fn create_fs<P: AsRef<Path>>(game_dir: P) -> Result<FileSystem<DummyVpk>, FileSystemError> {
    let options = FileSystemOptions::default();
    FileSystem::<DummyVpk>::load_from_path::<SimpleGameInfo>(game_dir.as_ref(), &options)
}

#[test]
fn simple_game_test() {
    let fs = create_fs("tests/games/simple/game").expect("Failed to create FileSystem");
    assert!(!fs.search_path_dirs().is_empty());

    let data = fs.read("scripts/test.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "Hello world");

    let data = fs.read("other_test.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "File in other_folder");
}

#[test]
fn simple_2_game_test() {
    let fs = create_fs("tests/games/simple_inside").expect("Failed to create FileSystem");
    assert!(!fs.search_path_dirs().is_empty());

    let data = fs.read("scripts/test.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "Hello world\n");

    let data = fs.read("other_test.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "File in other_folder\n");
}

#[test]
fn portal_game_test() {
    let fs = create_fs("tests/games/portal/portal").expect("Failed to create FileSystem");
    assert!(!fs.search_path_dirs().is_empty());

    let data = fs.read("mod_test.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "Mod file in portal/custom/test_mod\n");

    let data = fs.read("nothing.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "nothing\n");

    let data = fs.read("something_hl2", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "123\n");
}

#[test]
fn mount_game_test() {
    let path = Path::new("tests/games/gmod/garrysmod");
    let fs = FileSystem::<DummyVpk>::load_from_path::<SimpleWithMount>(&path, &FileSystemOptions::default()).expect("Failed to create FileSystem");

    // this should be gmod/garrysmod/
    let data = fs.read("cfg/mount.cfg", "game", false);
    assert!(data.is_some());

    // this should be HL2 content in `portal/hl2/` (from mount.cfg)
    let data = fs.read("something_hl2", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "123\n");

}

#[test]
fn portal2_game_test() {
    // Portal 2 has a unique feature: DLC folders.
    // They aren't added to SearchPaths;
    // the game automatically mounts the content if it exists, incrementing the DLC number

    let path = Path::new("tests/games/portal2/portal2");
    let fs = create_fs(&path).expect("Failed to create FileSystem");
    assert!(!fs.search_path_dirs().is_empty());

    let data = fs.read("file1.txt", "game", false);
    assert!(data.is_none());

    let options = FileSystemOptions::default();
    let fs_p2 = FileSystem::<DummyVpk>::load_from_path::<P2GameInfo>(path, &options).expect("Failed to create P2 FileSystem");

    let data = fs_p2.read("file1.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "1\n");

    let data = fs_p2.read("file2.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "2\n");

    let data = fs_p2.read("file3.txt", "game", false);
    assert!(data.is_some());
    assert_eq!(String::from_utf8_lossy(&data.unwrap()), "3\n");

}