nbtvis/README.md
2023-12-15 23:09:10 -05:00

32 lines
729 B
Markdown

### nbtvis
Command line visualizer for the minecraft [NBT](https://wiki.vg/NBT) data file format.
#### usage
`nbtvis [OPTIONS]... [INFILE] [OUTFILE]`
Files will have their filetype auto guessed based on their file extension: `.nbt`, `.snbt`, `.json`, unless one is manually specified. The NBT format is the default.
#### file types
The current supported file formats are
- `nbt` - Named Binary Tag
- `snbt` - String Named Binary Tag (TODO!!)
- `json` - Java Script Object Notation (lossy)
#### complementation
To build and install run
```
make build
sudo make install
```
The binary will be installed to `/usr/local/bin/nbtvis`
#### license
This project is licensed under the [MIT](https://mit-license.org/) license