msg-tool

msg-tool is a command-line tool for exporting, importing, packing, and unpacking script files.

How to Compile

git clone https://github.com/lifegpc/msg-tool
cargo build --release  # Build with all features enabled
cargo build --release --no-default-features --features=circus  # Build with only specific features enabled. See supported types below.

Exit Codes

By default, msg-tool will always return exit code 0 unless a exit signal is received (such as Ctrl+C).
You can use the --exit-code / -x option to specify a non-zero exit code when some jobs failed.
If all jobs failed, you can use the --exit-code-all-failed / -X option to specify a different exit code.

Basic Usage

Extract messages from script files

msg-tool export <input> [output]

Some script files cannot be detected automatically. You can specify the type of script file with the --script-type / -t option.

msg-tool export -t <script-type> <input> [output]

If the script file is an image file, you can specify the output type of the image file with the --image-type / -i option.

msg-tool export -i webp <input> [output]

If the script file is an archive file, it will be unpacked and will try to extract messages/images/audio from the unpacked files. If you don't want to extract, please use the unpack command.

If the input is a directory, all script files in the directory will be processed. (The -r / --recursive option is needed if you want to process files in subdirectories.)

Import data into script files

msg-tool import <input> <output> <patched>

Pack files into an archive

msg-tool pack <input> -t <archive-type> [output]
# Pack multiple files/folders into an archive
# If output is not specified, the archive file will be named with the first input's name with the appropriate extension.
# Use --dep-file xxxx.d to generate a dep file for other build systems. (such as ninja)
msg-tool pack-v2 -t <archive-type> -o <output> <input1> <input2> ...

Unpack an archive file

msg-tool unpack <input> [output]

Some archive files cannot be detected automatically. You can specify the type of archive file with the --script-type / -t option.

Create a new script file

msg-tool create -t <script-type> <input> <output>

Supported Output Script Types

• json - GalTransl's JSON format
• m3t / m3ta - A simple text format that supports both original/llm/translated messages.
• yaml - Same as json, but in YAML format.
• po/pot - Gettext PO/POT format.

Supported Image Types

Supported Script Types

Artemis Engine

Buriko General Interpreter / Ethornell

CatSystem2

Circus

Emote

Entis GLS engine

Escu:de

ExHibit

Favorite

HexenHaus

Kirikiri

Musica

Silky Engine

Softpal

WillPlus / AdvHD

Yaneurao Itufuru