maclarian 0.1.3

Larian file format library for Baldur's Gate 3 - PAK, LSF, LSX, GR2, DDS, and more
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

#![allow(non_snake_case)]
//! # `MacLarian`
//!
//! A pure-Rust library for working with Baldur's Gate 3 and Larian Studios file formats.
//!
//! ## Supported Formats
//!
//! - **PAK archives** - Extract, create, and list game asset packages
//! - **LSF/LSX/LSJ** - Binary, XML, and JSON document formats
//! - **GR2** - Granny2 mesh files with `BitKnit` decompression
//! - **Virtual Textures** - GTS/GTP streaming texture extraction
//! - **LOCA** - Localization files
//! - **DDS/PNG** - Texture conversion
//!
//! ## Quick Start
//!
//! ### Working with PAK Archives
//!
//! ```no_run
//! use maclarian::pak::PakOperations;
//!
//! // List contents of a PAK file
//! let files = PakOperations::list("Shared.pak")?;
//! println!("Found {} files", files.len());
//!
//! // Extract a PAK file
//! PakOperations::extract("Shared.pak", "output/")?;
//!
//! // Read a specific file without extracting
//! let data = PakOperations::read_file_bytes("Shared.pak", "Public/Shared/meta.lsx")?;
//! # Ok::<(), maclarian::Error>(())
//! ```
//!
//! ### Converting Document Formats
//!
//! ```no_run
//! use maclarian::converter::convert_lsf_to_lsx;
//!
//! // Convert LSF (binary) to LSX (XML) file
//! convert_lsf_to_lsx("meta.lsf", "meta.lsx")?;
//! # Ok::<(), maclarian::Error>(())
//! ```
//!
//! ### Using the Prelude
//!
//! The prelude provides convenient access to commonly used types:
//!
//! ```no_run
//! use maclarian::prelude::*;
//!
//! // Now you have access to:
//! // - PakOperations, LsfDocument, LsxDocument, LsjDocument
//! // - VirtualTextureExtractor, GtsFile, GtpFile
//! // - Error, Result, and more
//! ```
//!
//! ## Feature Flags
//!
//! - `cli` - Enables the `maclarian` command-line binary

pub mod compression;
pub mod converter;
pub mod error;
pub mod formats;
pub mod gr2_extraction;
pub mod merged;
pub mod mods;
pub mod pak;
pub mod utils;

// Top-level domain modules (promoted from formats/)
pub mod virtual_texture;

// Re-exports for convenience
pub use error::{Error, Result};

/// Prelude module for common imports
pub mod prelude {
    pub use crate::error::{Error, Result};
    pub use crate::formats::common::{TypeId, get_type_name, type_name_to_id};
    pub use crate::formats::gr2::decompress_gr2;
    pub use crate::formats::lsf::{LsfAttribute, LsfDocument, LsfNode};
    pub use crate::formats::lsj::{LsjAttribute, LsjDocument, LsjNode};
    pub use crate::formats::lsx::{LsxAttribute, LsxDocument, LsxNode, LsxRegion};

    // Virtual texture exports (from top-level module)
    pub use crate::virtual_texture::{
        BatchExtractResult as VtBatchResult, GtpFile, GtsExtractResult, GtsFile,
        VirtualTextureExtractor, extract_batch as extract_vt_batch, extract_gts_file,
    };

    // PAK operations
    pub use crate::pak::{
        BatchPakResult, PakOperations, batch_create, batch_extract, find_packable_folders,
        find_pak_files,
    };

    pub use crate::converter;
    pub use crate::converter::gr2_gltf::{
        TexturedGlbResult, convert_gr2_bytes_to_glb_with_textures,
    };
    pub use crate::gr2_extraction::{
        Gr2ExtractionOptions, Gr2ExtractionResult, extract_gr2_with_textures,
        process_extracted_gr2, process_extracted_gr2_to_dir,
    };
    pub use crate::merged::{GameDataResolver, MergedDatabase, MergedResolver, VisualAsset};

    // Mods module exports
    pub use crate::mods::{
        InfoJsonResult, ModValidationResult, generate_info_json, validate_mod_structure,
    };
}

/// The version of the `maclarian` crate.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

// CLI module (feature-gated)
#[cfg(feature = "cli")]
pub mod cli;