Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
scottanderson committed Sep 10, 2024
1 parent f072a53 commit 833339c
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -9,46 +14,63 @@ 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
```

### Read from an input file, write to stdout

```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
```

### Read from stdin, write to stdout

```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
```

### Get help

```sh
gvas2json --help
gvas2toml --help
gvas2yaml --help
json2gvas --help
toml2gvas --help
yaml2gvas --help
```

Expand Down

0 comments on commit 833339c

Please sign in to comment.