@ianlucas/vrf-decompiler
    Preparing search index...

    Interface DecompilerArgs

    interface DecompilerArgs {
        all?: boolean;
        block?: string;
        debug?: boolean;
        gltfAnimationList?: string;
        gltfExportAnimations?: boolean;
        gltfExportExtras?: boolean;
        gltfExportFormat?: "gltf" | "glb";
        gltfExportMaterials?: boolean;
        gltfMeshList?: string;
        gltfTexturesAdapt?: boolean;
        help?: boolean;
        input?: string;
        output?: string;
        recursive?: boolean;
        recursiveVpk?: boolean;
        textureDecodeFlags?: string;
        threads?: number;
        toolsAssetInfoShort?: boolean;
        version?: boolean;
        vpkCache?: boolean;
        vpkDecompile?: boolean;
        vpkDir?: boolean;
        vpkExtensions?: string;
        vpkFilepath?: string;
        vpkList?: boolean;
        vpkVerify?: boolean;
    }
    Index

    Properties

    all? block? debug? gltfAnimationList? gltfExportAnimations? gltfExportExtras? gltfExportFormat? gltfExportMaterials? gltfMeshList? gltfTexturesAdapt? help? input? output? recursive? recursiveVpk? textureDecodeFlags? threads? toolsAssetInfoShort? version? vpkCache? vpkDecompile? vpkDir? vpkExtensions? vpkFilepath? vpkList? vpkVerify?

    Properties

    all?: boolean

    Print the content of each resource block in the file.

    Can be specified using --all or -a.

    block?: string

    Print the content of a specific block, example: DATA, RERL, REDI, NTRO.

    Can be specified using --block or -b.

    debug?: boolean

    Print debug information.

    gltfAnimationList?: string

    Comma-separated list of animations to include in glTF export, example: "idle,dropped". Requires --gltf_export_animations. By default includes all animations.

    Can be specified using --gltf_animation_list.

    gltfExportAnimations?: boolean

    Whether to export animations during glTF exports.

    Can be specified using --gltf_export_animations.

    gltfExportExtras?: boolean

    Export additional Mesh properties into glTF extras.

    Can be specified using --gltf_export_extras.

    gltfExportFormat?: "gltf" | "glb"

    Exports meshes/models in given glTF format. Must be either 'gltf' or 'glb'.

    Can be specified using --gltf_export_format.

    gltfExportMaterials?: boolean

    Whether to export materials during glTF exports.

    Can be specified using --gltf_export_materials.

    gltfMeshList?: string

    Comma-separated list of meshes to include in glTF export. By default includes all meshes in a model.

    Can be specified using --gltf_mesh_list.

    gltfTexturesAdapt?: boolean

    Whether to perform any glTF spec adaptations on textures (e.g. split metallic map).

    Can be specified using --gltf_textures_adapt.

    help?: boolean

    Show help information.

    Can be specified using --help.

    input?: string

    Input file to be processed. With no additional arguments, a summary of the input(s) will be displayed.

    Can be specified using --input or -i.

    output?: string

    Output path to write to. If input is a folder (or a VPK), this should be a folder.

    Can be specified using --output or -o.

    recursive?: boolean

    If specified and given input is a folder, all subdirectories will be scanned too.

    Can be specified using --recursive.

    recursiveVpk?: boolean

    If specified along with --recursive, will also recurse into VPK archives.

    Can be specified using --recursive_vpk.

    textureDecodeFlags?: string

    Decompile textures with specified decode flags. Options: "none", "auto", "foceldr". Default: "auto".

    Can be specified using --texture_decode_flags.

    threads?: number

    If higher than 1, files will be processed concurrently.

    Can be specified using --threads.

    toolsAssetInfoShort?: boolean

    Whether to print only file paths for tools_asset_info files.

    Can be specified using --tools_asset_info_short.

    version?: boolean

    Show version information.

    Can be specified using --version.

    vpkCache?: boolean

    Use cached VPK manifest to keep track of updates. Only changed files will be written to disk.

    Can be specified using --vpk_cache.

    vpkDecompile?: boolean

    Decompile supported resource files.

    Can be specified using --vpk_decompile or -d.

    vpkDir?: boolean

    Print a list of files in given VPK and information about them.

    Can be specified using --vpk_dir.

    vpkExtensions?: string

    File extension(s) filter, example: "vcss_c,vjs_c,vxml_c".

    Can be specified using --vpk_extensions or -e.

    vpkFilepath?: string

    File path filter(s), supports comma-separated values. Example: "panorama/,sounds/" or "scripts/items/items_game.txt".

    Can be specified using --vpk_filepath or -f.

    vpkList?: boolean

    Lists all resources in given VPK. File extension and path filters apply.

    Can be specified using --vpk_list or -l.

    vpkVerify?: boolean

    Verify checksums and signatures.

    Can be specified using --vpk_verify.

    Settings

    Member Visibility

    On This Page

    Properties