nbtvis/README.md

33 lines
729 B
Markdown
Raw Normal View History

2023-12-15 00:50:39 +00:00
### nbtvis
Command line visualizer for the minecraft [NBT](https://wiki.vg/NBT) data file format.
#### usage
2023-12-16 04:05:04 +00:00
`nbtvis [OPTIONS]... [INFILE] [OUTFILE]`
2023-12-15 00:50:39 +00:00
2023-12-16 04:05:04 +00:00
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.
2023-12-15 00:50:39 +00:00
2023-12-16 04:09:10 +00:00
#### file types
2023-12-16 04:06:43 +00:00
The current supported file formats are
- `nbt` - Named Binary Tag
- `snbt` - String Named Binary Tag (TODO!!)
- `json` - Java Script Object Notation (lossy)
2023-12-15 00:50:39 +00:00
#### complementation
To build and install run
```
make build
sudo make install
```
2023-12-16 04:05:04 +00:00
The binary will be installed to `/usr/local/bin/nbtvis`
2023-12-15 00:50:39 +00:00
#### license
This project is licensed under the [MIT](https://mit-license.org/) license