Intended Use Cases

The intended use case of this library is to generate serialized Raw JSON text format data for the use with Minecraft: Java Edition commands and data files.

Other use cases are not actively worked on by maintainers.

Compatible use cases

Using over the protocol

You may be able to use this library to generate data for text components to transfer over the Minecraft protocol. The Minecraft Protocol accepts Raw JSON text format when receiving text components over the network, but recent versions may use NBT as well.

However, if the component types requires component resolution, then it should not be sent to client because client cannot resolve them, and instead replaces them with a blank text component.

NBT serialization is not being worked on at the moment, but you are free to contribute this to the SharpNbt extension library.

Incompatible use cases

Bedrock Edition

This library will never support (well, unless Mojang made them compatible) Bedrock Edition due to dramatic differences between Java and Bedrock text component formats.