From 833339cd017edd1aa1e9f5c91c94dac37ee53d77 Mon Sep 17 00:00:00 2001 From: Scott Anderson <662325+scottanderson@users.noreply.github.com> Date: Tue, 10 Sep 2024 15:47:32 -0400 Subject: [PATCH] Update README --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c4854c..2eb7822 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # gvas2json -Convert between GVAS and JSON or YAML +Convert between GVAS and JSON, TOML, YAML. + +GVAS is the file format used by many Unreal Engine 4 and Unreal Engine 5 games. + +This crate works with games supported by the +[gvas](https://github.com/localcc/gvas/) crate. ## Install @@ -9,14 +14,25 @@ Convert between GVAS and JSON or YAML ## Use -`gvas2json`, `gvas2yaml`, `json2gvas`, and `yaml2gvas` take up to two files as arguments: +This crate includes six command-line utilities: + +- `gvas2json` +- `gvas2toml` +- `gvas2yaml` +- `json2gvas` +- `toml2gvas` +- `yaml2gvas` + +Each utility takes up to two files as arguments: ### Read from an input file, write to an output file ```sh gvas2json slot1.sav -o gvas.json +gvas2toml slot1.sav -o gvas.toml gvas2yaml slot1.sav -o gvas.yaml json2gvas gvas.json -o out.sav +toml2gvas gvas.toml -o out.sav yaml2gvas gvas.yaml -o out.sav ``` @@ -24,13 +40,15 @@ yaml2gvas gvas.yaml -o out.sav ```sh gvas2json slot1.sav > gvas.json -gvas2yaml slot1.sav > gvas.json +gvas2toml slot1.sav > gvas.toml +gvas2yaml slot1.sav > gvas.yaml ``` ### Read from stdin, write to an output file ```sh json2gvas -o out.sav < gvas.json +toml2gvas -o out.sav < gvas.toml yaml2gvas -o out.sav < gvas.yaml ``` @@ -38,8 +56,10 @@ yaml2gvas -o out.sav < gvas.yaml ```sh gvas2json < slot1.sav > gvas.json +gvas2toml < slot1.sav > gvas.toml gvas2yaml < slot1.sav > gvas.yaml json2gvas < gvas.json > out.sav +toml2gvas < gvas.toml > out.sav yaml2gvas < gvas.yaml > out.sav ``` @@ -47,8 +67,10 @@ yaml2gvas < gvas.yaml > out.sav ```sh gvas2json --help +gvas2toml --help gvas2yaml --help json2gvas --help +toml2gvas --help yaml2gvas --help ```