https://github.com/hboyd2003/configurate-nbt-temp
https://github.com/hboyd2003/configurate-nbt-temp
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hboyd2003/configurate-nbt-temp
- Owner: hboyd2003
- License: other
- Created: 2026-05-26T19:32:46.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2026-06-17T03:13:04.000Z (about 1 month ago)
- Last Synced: 2026-06-17T04:16:17.327Z (about 1 month ago)
- Language: Java
- Size: 110 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Configurate NBT
[Configurate](https://github.com/SpongePowered/Configurate) loaders and serializers for NBT (Named Binary Tag) using [Kyori Adventure NBT](https://github.com/KyoriPowered/adventure).
Supports saving and loading via NBT as well as serializing NBT data into configurate.
### Loaders
- NBT
- SNBT
### Serializers
This library provides BinaryTag serializers that can be used independently with any Configurate loader.
Since NBT needs to maintain type, two different kinds of serializers are provided:
- **Type-Safe Serializers** preserve exact numeric types by appending SNBT-style suffixes (`b`, `s`, `i`, `l`, `f`, `d`).
- **Type-Unsafe Serializers** relies on the configuration loader to deserialize to the correct numeric type. Some
loaders (HOCON, JSON, YAML, etc.) do not preserve type and as such will not deserialize correctly.
For both kinds a static `TypeSerializerCollection` is accessible in `BinaryTagSerializer`
#### A Note on Lists
Adventure NBT lists can support heterogeneity (a list with multiple tag types), but for this a list must be explicitly
created with support for it. When deserializing lists, the deserializer will always presume that a list that
deserializes to one type should be created as a non-heterogeneity supporting list. This means that if a list that
supports heterogeneity but only contains one tag type is serialized upon deserialization, a non-heterogeneity supporting
list will be returned.
## Installation
### Gradle (Kotlin DSL)
```kotlin
repositories {
maven {
name = "hboyd-dev-repo-releases"
url = uri("https://repo.hboyd.dev/releases/")
}
// Required for snapshot releases
maven {
name = "hboyd-dev-repo-snapshots"
url = uri("https://repo.hboyd.dev/snapshots/")
}
}
dependencies {
implementation("dev.hboyd:configurate-nbt:1.0.0")
}
```
## Examples
### Saving using SNBT
```java
// Create a loader for a SNBT file
SNBTConfigurationLoader loader = SNBTConfigurationLoader.builder()
.path(Paths.get("config.snbt"))
.indent(4) // Indentation level
.indentType(SNBTConfigurationLoader.IndentType.SPACE)
.legacyFormat(false)
.build();
// Load and save work the same as binary NBT
ConfigurationNode node = loader.load();
node.node("key").set("value");
loader.save(node);
```
### Saving an `ItemStack` in a YAML file with the Minecraft Paper API
```java
// Create YAML loader
YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
.defaultOptions(o ->
o.serializers(o.serializers()
.childBuilder()
.registerAll(BinaryTagSerializer.TYPE_SAFE_SERIALIZERS)
.build()))
.path(Path.of("example.yml"))
.nodeStyle(NodeStyle.BLOCK)
.build();
// Serialize ItemStack to NBT
CompoundBinaryTag itemStackNBT = inventory.getItemInMainHand().serializeAsBytes();
// Deserialize into Adventure's BinaryTag format
BinaryTag itemStackTag = BinaryTagIO.reader().read(new ByteArrayInputStream(), BinaryTagIO.Compression.GZIP);
// Save into Configurate node and save
ConfigurationNode itemStackTagNode = loader.createNode();
try {
node.node("item").set(CompoundBinaryTag.class, itemStackTag);
loader.save(node);
} catch (IOException e) {
throw new RuntimeException(e);
}
```
# License
This project is licensed under the LGPLv3 License – see the [LICENSE.md](LICENSE.md) file for details