modde-games 0.2.1

Game plugin implementations for modde
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

//! Mod scanner for The Witcher 3.

use anyhow::Result;

use crate::scanner_patterns::DirectoryModRule;
use crate::traits::{DiscoveredMod, ModScanner, ScanContext};

/// [`ModScanner`] that discovers installed Witcher 3 mods.
pub struct Witcher3Scanner;

pub static WITCHER3_SCANNER: Witcher3Scanner = Witcher3Scanner;

impl ModScanner for Witcher3Scanner {
    fn scan_directories(&self) -> &[&str] {
        &["mods", "dlc"]
    }

    fn scan_filesystem(&self, ctx: &ScanContext<'_>) -> Result<Vec<DiscoveredMod>> {
        let mut out = Vec::new();
        DirectoryModRule {
            rel_dir: "mods",
            mod_id_prefix: "mod",
            source_location: "mods",
            confidence: 0.9,
            marker_file: None,
            marker_confidence: None,
        }
        .scan(ctx.install_dir, &mut out)?;
        DirectoryModRule {
            rel_dir: "dlc",
            mod_id_prefix: "dlc",
            source_location: "dlc",
            confidence: 0.75,
            marker_file: None,
            marker_confidence: None,
        }
        .scan(ctx.install_dir, &mut out)?;
        Ok(out)
    }

    fn mod_id_footprint(&self, mod_id: &str) -> Option<modde_core::scanner::ModFootprint> {
        if let Some(name) = mod_id.strip_prefix("mod/") {
            return Some(modde_core::scanner::ModFootprint::Directory(format!(
                "mods/{}/",
                name.to_lowercase()
            )));
        }
        let name = mod_id.strip_prefix("dlc/")?.to_lowercase();
        Some(modde_core::scanner::ModFootprint::Directory(format!(
            "dlc/{name}/"
        )))
    }
}