mrghosti3 / nbteditor Goto Github PK

Implement functionality to get notifications of file changes and update NBT data (and probably if possible, YML if NBT changes). It should be easily enabled via CLI and opt-in. Flags could --watch with alias -w.

For now possible solution for this is to use inotify (7) syscall via nix crate.

Would specify for the program what data format type for input/output data:

• Compilation: when flag is specified, it will skip reading "magic bytes" and assume data is formatted as specified. If those arguments are not given than it resumes format detection via "magic bytes";
• Decompilation: outputs data in a specified format (zlib/gzip if flags are given or if none than raw NBT).

Currently supported flags:

• --gzip (alias -g) : for gzipped data
• --zlib : for data archived in ZLib standart

Rewriting decompile/compile feature to output data in XML. Initially made output into YAML, but after some time the serde_yaml library would crash (due to OOM or recursion) as the NBT file would be to big.

Solutions:

1. Write custom way to incrementally output XML from NBT. Currently had ran into an issue where it is difficult to properly output structured XML data from Compound tags as the idea of other tags is to be nested in and have name attribute like:

<compound>
    <int name="count">64</int>
    <string name="blockName">dirt</string>
</compound>

3. Write a Serializer from serde crate and use it to incrementally output NBT into an XML file. Having issues understanding how the Serializer might work;
4. Rewrite named-binary-tag crate with better API and data structures that would make easier to accomplish solution nr 1.

Make the program export NBT file into JSON, YAML or any other text based format so that user could edit the export version. After editing, user would run this program to import their changes back into NBT file.

A flag for de-compilation should be added, to write out data to STDOUT instead of file.

Currently the code works with the assumption that the given input is of gzip. But fails to read region files which are raw NBT. There should be a functionality to detect what type of file is passed.

The check order will be:

1. is gzip archive;
2. is xz archive;
3. fallbacks to NBT.

Iterations

• Iteration 1:
  • #6
  • #8
• Iteration 2:
  • #9
  • #10
  • #12
• Iteration 3:
  • #13
  • #17
• Iteration 4:
  • #14
  • #15

Interesting features

• #5
• Small async runtime for watch server;
• Implement incremental reading from NBT file;