hytale-config-files

Define and manage Hytale plugin configuration files with BuilderCodec and Config wrappers.

Updated Jan 19, 2026
One-click install
npx skills add https://github.com/Reign-software/hyforged --skill hytale-config-files-reign-software
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hytale-config-files
Source: https://github.com/Reign-software/hyforged/tree/main/.github/skills/hytale-config-files
Command: npx skills add https://github.com/Reign-software/hyforged --skill hytale-config-files-reign-software

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps plugin developers create and manage configuration files for Hytale, enabling persistent settings that survive server restarts.

Core Features & Use Cases

  • Config-driven: Define configuration data as a Java class with a BuilderCodec to serialize and deserialize fields.
  • Registration and access: Register the config with this.withConfig("Name", MyConfig.CODEC) and access it via config.get() from other classes.
  • Persistence across restarts: Save the defaults using config.save() in setup to ensure the config file is created on first run.
  • Location and scope: Config files are stored in the mods directory and can be loaded or modified at runtime by the plugin.

Quick Start

Register your config by creating a BuilderCodec for your class and wiring it with this.withConfig("MyConfig", MyConfig.CODEC) in your plugin, then call config.save() in setup to create the defaults.

Frequently Asked Questions about hytale-config-files

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

FAQPage Schema
How do I persist Hytale plugin settings across server restarts?

To persist Hytale plugin settings across server restarts, define your configuration data as a Java class, serialize it using a BuilderCodec, and save the defaults with a config.save() call during plugin setup.

What is the best way to create a config file for a Hytale plugin?

The best way to create a Hytale plugin config file is registering a BuilderCodec for your class with this.withConfig("Name", MyConfig.CODEC) and invoking config.save() in setup to write the initial defaults to the mods directory.

How do I access plugin configuration from other classes in Hytale?

You can access plugin configuration from other classes by retrieving the registered config instance via config.get(), allowing runtime loading and modification of the settings stored in your Hytale plugin's mods directory.

Does my Hytale plugin need a BuilderCodec to manage configuration files?

Yes, your Hytale plugin requires a BuilderCodec<T> to serialize and deserialize configuration fields, functioning as the necessary wrapper to register and manage persistent settings via this.withConfig(...).

Why are my Hytale plugin configuration defaults not saving on the first run?

Hytale plugin configuration defaults fail to save on the first run if config.save() is omitted from the setup method, preventing the BuilderCodec from writing the initial file to the mods directory.

Can I modify Hytale plugin configuration files at runtime?

Yes, you can modify Hytale plugin configuration files at runtime by loading the registered config instance and altering its values, utilizing the BuilderCodec to serialize the updated settings back into the mods directory.