Skip to content

MineJason/text

Repository files navigation

MineJason

Nuget

MineJason is a .NET library that provides serialization compatible models for text component format in Minecraft: Java Edition.

Usage

Installation

Use these NuGet packages (click the status badge/icon to get to the package page!)

Name Status & Link
MineJason Nuget
MineJason.Extensions.SharpNbt Nuget

Serialize and deserialize

From version 0.3.1-alpha onwards, you serialize and deserialize the ChatComponent types normally like how you would serialize other types.

The ChatComponent.SerializerOptions is deprecated and removed. Please do not use it. The JsonComponentSerializer class is also deprecated.

Please do not use Newtonsoft.Json, as it is not currently supported. Instead, use System.Text.Json.

Creating components

Create methods in ChatComponent class allows you to create various types of components.

Issues

Please report issues in the issue tracker of this library.

Contributing

Pull requests are welcome. For major changes, please open an issue to discuss what you would like to change first.

Please make sure to update tests as appropriately, and don't forget to check the conventions of this project written in the Contributing guide.

License

The libraries are available under the GNU Lesser General Public License, either version 3 of the license, or (at your opinion) any later version.

Please also see the license of other libraries that this project links to.

The SPDX License ID of this project is LGPL-3.0-or-later.