summaryrefslogtreecommitdiff
path: root/README.md
blob: 24f734412f631a38d40aeefc31ab823dc6827786 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
### 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