hytale-persistent-data

Store and retrieve persistent Hytale player and entity data via custom component serialization.

13|Updated Feb 14, 2026
One-click install
npx skills add https://github.com/JBurlison/Hytale-Mod-Agent --skill hytale-persistent-data
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hytale-persistent-data
Source: https://github.com/JBurlison/Hytale-Mod-Agent/tree/main/.github/skills/hytale-persistent-data
Command: npx skills add https://github.com/JBurlison/Hytale-Mod-Agent --skill hytale-persistent-data

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a robust system for saving and loading custom data associated with players and entities in Hytale, ensuring that game state and player progress are maintained across sessions.

Core Features & Use Cases

  • Custom Component Creation: Define and serialize complex data structures for entities and players.
  • Codec Serialization: Utilize Hytale's Codec system for efficient BSON serialization of primitive types, collections, and custom objects.
  • Persistence Management: Differentiate between temporary and persistent data storage using addComponent and putComponent.
  • Use Case: Create a PlayerStats component to track player kills, deaths, and playtime, automatically saving this data whenever the player logs out or the server stops.

Quick Start

Use the hytale-persistent-data skill to create a new player stats component for the current player.

Frequently Asked Questions about hytale-persistent-data

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I persist Hytale player data across server sessions?

You can persist complex data structures in Hytale by defining custom components with BuilderCodec. This system uses Hytale's Codec for BSON serialization, ensuring game state and player progress are maintained across sessions.

How does BSON serialization work with the Hytale Codec system?

Hytale's Codec system handles BSON serialization by encoding primitive types, collections, and custom objects. It transforms complex component data structures into a format suitable for reliable storage and retrieval.

What is the difference between temporary and persistent data storage in Hytale?

Temporary data uses addComponent, while persistent data uses putComponent. Using putComponent ensures custom entity data is saved across server sessions via Hytale's Codec serialization.

Can I serialize custom collections and primitive types in Hytale entities?

Yes, you can serialize custom collections and primitive types in Hytale entities. Hytale's Codec system supports complex data structures, custom objects, and primitive types for persistent storage.

Do I need BuilderCodec to register custom components in Hytale?

Yes, you need BuilderCodec to define and register custom components for session persistence. Registering components within the plugin's setup method enables storage and retrieval of persistent player and entity data.