qpak 1.0.0

An unofficial Quake PAK file manipulation tool
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

use clap::{Parser, Subcommand};
use std::path::PathBuf;

/// Command-line arguments parsing for qpak
#[derive(Parser)]
#[command(author, version, about)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Command,
}

/// Available commands for the qpak CLI
#[derive(Subcommand)]
pub enum Command {
    Pack (PackCommand),
    Unpack (UnpackCommand),
    List (ListCommand),
}

/// Creates a new PAK file from a directory
#[derive(Parser)]
pub struct PackCommand {
    /// Directory to copy files from
    pub source_dir: PathBuf,
    /// PAK file to create
    pub pak_file: PathBuf,
}

/// Extracts a PAK file into a directory
#[derive(Parser)]
pub struct UnpackCommand {
    /// PAK file to unpack
    pub pak_file: PathBuf,
    /// Directory to unpack to. Default: The current directory
    pub dest_dir: Option<PathBuf>,
}

/// Describes a PAK file
#[derive(Parser)]
pub struct ListCommand {
    /// PAK file to list
    pub pak_file: PathBuf,
}

/// TODO
/// Inserts a file or directory (recursively) into a PAK file
#[derive(Parser)]
pub struct InsertCommand {
    /// Forces overwriting of existing files in PAK
    #[arg(short, long, default_value_t = false)]
    pub force: bool,

    /// File or directory to copy (recursively) into the PAK file
    pub source_path: PathBuf,

    /// PAK file to insert into
    pub pak_file: PathBuf,

    /// Path prefix prepended to all inserted files. Default: The root path of the PAK file
    pub pak_path_prefix: Option<PathBuf>,
}