fomod-oxide 0.1.0

FOMOD mod installer XML parser and evaluator
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

//! # fomod-oxide
//!
//! Parse and evaluate [FOMOD](https://fomod-docs.readthedocs.io/) mod installer configurations.
//!
//! FOMOD is an XML-based format used by mod managers (Mod Organizer 2, Vortex, etc.)
//! to define guided installation wizards for game mods.
//!
//! ## Quick start
//!
//! ```no_run
//! use fomod_oxide::{ModuleConfig, Installer};
//!
//! let xml = std::fs::read_to_string("fomod/ModuleConfig.xml").unwrap();
//! let config = ModuleConfig::parse(&xml).unwrap();
//! let mut installer = Installer::new(config);
//!
//! // Present visible steps to the user, collect selections...
//! for (idx, step) in installer.visible_steps() {
//!     println!("Step {idx}: {}", step.name);
//! }
//!
//! // Record selections and resolve the install plan
//! installer.select(0, 0, vec![0]);
//! let plan = installer.resolve();
//! for op in &plan.operations {
//!     println!("{} -> {}", op.source, op.destination);
//! }
//! ```

pub mod condition;
pub mod config;
pub mod declarative;
pub mod error;
pub mod info;
pub mod installer;

pub use condition::{EvalContext, Evaluate, FileState};
pub use config::ModuleConfig;
pub use declarative::{
    hash_xml, DeclarativeConfig, DeclarativeError, SelectionDiff, SelectionSummary,
    SCHEMA_VERSION,
};
pub use error::FomodError;
pub use info::FomodInfo;
pub use installer::{
    CompletionStatus, FileConflict, FileConflictSource, FileOperation, FlagImpact, InstallPlan,
    Installer, SelectionError, ValidationHint,
};