Struct Arg

pub struct Arg {

    pub script_type: Option<ScriptType>,
    pub output_type: Option<OutputScriptType>,
    pub image_type: Option<ImageOutputType>,
    pub encoding: Option<TextEncoding>,
    pub code_page: Option<u32>,
    pub output_encoding: Option<TextEncoding>,
    pub output_code_page: Option<u32>,
    pub archive_encoding: Option<TextEncoding>,
    pub archive_code_page: Option<u32>,
    pub circus_mes_type: Option<CircusMesType>,
    pub recursive: bool,
    pub backtrace: bool,
    pub escude_fake_compress: bool,
    pub escude_enum_scr: Option<String>,
    pub bgi_import_duplicate: bool,
    pub bgi_disable_append: bool,
    pub bgi_is_sysgrp_arc: Option<bool>,
    pub bgi_img_scramble: Option<bool>,
    pub cat_system_int_encrypt_password: Option<String>,
    pub cat_system_int_exe: Option<String>,
    pub cat_system_image_canvas: bool,
    pub kirikiri_language_index: Option<usize>,
    pub kirikiri_export_comumode: bool,
    pub kirikiri_comumode_json: Option<String>,
    pub kirikiri_remove_empty_lines: bool,
    pub kirikiri_name_commands: Vec<String>,
    pub kirikiri_message_commands: Vec<String>,
    pub image_output_flat: bool,
    pub bgi_compress_file: bool,
    pub bgi_compress_min_len: usize,
    pub emote_pimg_overlay: Option<bool>,
    pub artemis_arc_disable_xor: bool,
    pub artemis_indent: Option<usize>,
    pub artemis_no_indent: bool,
    pub artemis_max_line_width: usize,
    pub artemis_ast_lang: Option<String>,
    pub artemis_txt_blacklist_names: Vec<String>,
    pub artemis_txt_lang: Option<String>,
    pub cat_system_cstl_lang: Option<String>,
    pub zlib_compression_level: u32,
    pub png_compression_level: PngCompressionLevel,
    pub circus_crx_keep_original_bpp: bool,
    pub circus_crx_zstd: bool,
    pub zstd_compression_level: i32,
    pub circus_crx_mode: CircusCrxMode,
    pub circus_crx_canvas: bool,
    pub force_script: bool,
    pub ex_hibit_rld_xor_key: Option<String>,
    pub ex_hibit_rld_xor_key_file: Option<String>,
    pub ex_hibit_rld_def_xor_key: Option<String>,
    pub ex_hibit_rld_def_xor_key_file: Option<String>,
    pub ex_hibit_rld_keys: Option<String>,
    pub ex_hibit_rld_def_keys: Option<String>,
    pub jpeg_quality: u8,
    pub webp_lossless: bool,
    pub webp_quality: u8,
    pub custom_yaml: Option<bool>,
    pub entis_gls_srcxml_lang: Option<String>,
    pub will_plus_ws2_no_disasm: bool,
    pub command: Command,
}

Tools for export and import scripts

Fields

script_type: Option<ScriptType>

Script type

output_type: Option<OutputScriptType>

Output script type

image_type: Option<ImageOutputType>

Available on crate feature image only.

Output image type

encoding: Option<TextEncoding>

Script encoding

code_page: Option<u32>

Available on Windows only.

Script code page

output_encoding: Option<TextEncoding>

Output text encoding

output_code_page: Option<u32>

Available on Windows only.

Output code page

archive_encoding: Option<TextEncoding>

Archive filename encoding

archive_code_page: Option<u32>

Available on Windows only.

Archive code page

circus_mes_type: Option<CircusMesType>

Available on crate feature circus only.

Circus Game

recursive: bool

Search for script files in the directory recursively

backtrace: bool

Print backtrace on error

escude_fake_compress: bool

Available on crate feature escude-arc only.

Whether to use fake compression for Escude archive

escude_enum_scr: Option<String>

Available on crate feature escude only.

The path to the Escude enum script file (enum_scr.bin)

bgi_import_duplicate: bool

Available on crate feature bgi only.

Duplicate same strings when importing into BGI scripts. Enable this will cause BGI scripts to become very large.

bgi_disable_append: bool

Available on crate feature bgi only.

Disable appending new strings to the end of BGI scripts. Disable may cause BGI scripts broken.

bgi_is_sysgrp_arc: Option<bool>

Available on crate features bgi-arc and bgi-img only.

Detect all files in BGI archive as SysGrp Images. By default, only files which name is sysgrp.arc will enabled this.

bgi_img_scramble: Option<bool>

Available on crate feature bgi-img only.

Whether to create scrambled SysGrp images. When in import mode, the default value depends on the original image. When in creation mode, it is not enabled by default.

cat_system_int_encrypt_password: Option<String>

Available on crate feature cat-system-arc only.

CatSystem2 engine int archive password

cat_system_int_exe: Option<String>

Available on crate feature cat-system-arc only.

The path to the CatSystem2 engine executable file. Used to get the int archive password.

cat_system_image_canvas: bool

Available on crate feature cat-system-img only.

Draw CatSystem2 image on canvas (if canvas width and height are specified in file)

kirikiri_language_index: Option<usize>

Available on crate feature kirikiri only.

Kirikiri language index in script. If not specified, the first language will be used.

kirikiri_export_comumode: bool

Available on crate feature kirikiri only.

Export COMU message to extra json file. (for Kirikiri SCN script.) Only CIRCUS’s game have COMU message.

kirikiri_comumode_json: Option<String>

Available on crate feature kirikiri only.

Kirikiri COMU message translation file. (Map<String, String>, key is original text, value is translated text.)

kirikiri_remove_empty_lines: bool

Available on crate feature kirikiri only.

Remove empty lines in Kirikiri KS script.

kirikiri_name_commands: Vec<String>

Available on crate feature kirikiri only.

Kirikiri name commands, used to extract names from ks script.

kirikiri_message_commands: Vec<String>

Available on crate feature kirikiri only.

Kirikiri message commands, used to extract more message from ks script.

image_output_flat: bool

Available on crate feature image only.

Output multiple image as <basename>_<name>.<ext> instead of <basename>/<name>.<ext>

bgi_compress_file: bool

Available on crate feature bgi-arc only.

Whether to compress files in BGI archive when packing BGI archive.

bgi_compress_min_len: usize

Available on crate feature bgi-arc only.

Minimum length of match size for DSC compression. Possible values are 2-256.

emote_pimg_overlay: Option<bool>

Available on crate feature emote-img only.

Whether to overlay PIMG images. (By default, true if all layers are not group layers.)

artemis_arc_disable_xor: bool

Available on crate feature artemis-arc only.

Disable Artemis archive (.pfs) XOR encryption when packing.

artemis_indent: Option<usize>

Available on crate feature artemis only.

Artemis script indent size, used to format Artemis script. Default is 4 spaces.

artemis_no_indent: bool

Available on crate feature artemis only.

Disable Artemis script indent, used to format Artemis script.

artemis_max_line_width: usize

Available on crate feature artemis only.

Max line width in Artemis script, used to format Artemis script.

artemis_ast_lang: Option<String>

Available on crate feature artemis only.

Specify the language of Artemis AST script. If not specified, the first language will be used.

artemis_txt_blacklist_names: Vec<String>

Available on crate feature artemis only.

Artemis Engine blacklist tag names for TXT script. This is used to ignore these tags when finding names in Artemis TXT script.

artemis_txt_lang: Option<String>

Available on crate feature artemis only.

Specify the language of Artemis TXT script. If not specified, the first language will be used.

cat_system_cstl_lang: Option<String>

Available on crate feature cat-system only.

CatSystem2 CSTL script language, used to extract messages from CSTL script. If not specified, the first language will be used.

zlib_compression_level: u32

Available on crate feature flate2 only.

Zlib compression level. 0 means no compression, 9 means best compression.

png_compression_level: PngCompressionLevel

Available on crate feature image only.

PNG compression level.

circus_crx_keep_original_bpp: bool

Available on crate feature circus-img only.

Keep original BPP when importing Circus CRX images.

circus_crx_zstd: bool

Available on crate feature circus-img only.

Use zstd compression for Circus CRX images. (CIRCUS Engine don’t support this. Hook is required.)

zstd_compression_level: i32

Available on crate feature zstd only.

Zstd compression level. 0 means default compression level (3), 22 means best compression.

circus_crx_mode: CircusCrxMode

Available on crate feature circus-img only.

Circus CRX image row type mode

circus_crx_canvas: bool

Available on crate feature circus-img only.

Draw Circus CRX images on canvas (if canvas width and height are specified in file)

force_script: bool

Force all files in archive to be treated as script files.

ex_hibit_rld_xor_key: Option<String>

Available on crate feature ex-hibit only.

ExHibit xor key for rld script, in hexadecimal format. (e.g. 12345678) Use https://github.com/ZQF-ReVN/RxExHIBIT to find the key.

ex_hibit_rld_xor_key_file: Option<String>

Available on crate feature ex-hibit only.

ExHibit rld xor key file, which contains the xor key in hexadecimal format. (e.g. 0x12345678)

ex_hibit_rld_def_xor_key: Option<String>

Available on crate feature ex-hibit only.

ExHibit rld def.rld xor key, in hexadecimal format. (e.g. 12345678)

ex_hibit_rld_def_xor_key_file: Option<String>

Available on crate feature ex-hibit only.

ExHibit rld def.rld xor key file, which contains the xor key in hexadecimal format. (e.g. 0x12345678)

ex_hibit_rld_keys: Option<String>

Available on crate feature ex-hibit only.

Path to the ExHibit rld keys file, which contains the keys in BINARY format. Use https://github.com/ZQF-ReVN/RxExHIBIT to get this file.

ex_hibit_rld_def_keys: Option<String>

Available on crate feature ex-hibit only.

Path to the ExHibit rld def keys file, which contains the keys in BINARY format.

jpeg_quality: u8

Available on crate feature mozjpeg only.

JPEG quality for output images, 0-100. 100 means best quality.

webp_lossless: bool

Available on crate feature webp only.

Use WebP lossless compression for output images.

webp_quality: u8

Available on crate feature webp only.

WebP quality for output images, 0-100. 100 means best quality.

custom_yaml: Option<bool>

Try use YAML format instead of JSON when custom exporting. By default, this is based on output type. But can be overridden by this option.

entis_gls_srcxml_lang: Option<String>

Available on crate feature entis-gls only.

Entis GLS srcxml script language, used to extract messages from srcxml script. If not specified, the first language will be used.

will_plus_ws2_no_disasm: bool

Available on crate feature will-plus only.

Disable disassembly for WillPlus ws2 script. Use another parser to parse the script. Should only be used when the default parser not works well.

command: Command

Command

Trait Implementations

impl Args for Arg

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Arg

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Arg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Arg

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Arg

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.