Python API

All public functions and types are importable from x4_catalog:

from x4_catalog import build_vfs, inspect_asset, scaffold_ware, ...

Sections

Section	Contents
Core Types	CatEntry, DiffOp, ValidationResult, FileValidationReport, ValidationReport, ConflictEntry, ConflictReport
Archive Functions	build_vfs, list_entries, extract_to_disk, pack_catalog, diff_file_sets
Diff Patching	generate_diff, validate_diff_file, validate_diff_directory
Index Functions	build_index, open_index, is_index_stale, find_index_db, db_path_for_game_dir
Discovery Functions	inspect_asset, search_assets, extract_macro
Conflict Detection	check_conflicts
Scaffolding Functions	scaffold_project, scaffold_ware, scaffold_equipment, scaffold_ship
Translation Validation	validate_translations, scaffold_translation
Schema Validation	validate_schema
Schema Extraction	extract_schema_to_db, extract_scriptproperties_to_db

---

Table of contents

• Core Types
• Archive Functions
• Diff Patching Functions
• Index Functions
• Discovery Functions
• Conflict Detection
• Scaffolding Functions
• Translation Validation