What is the JSON Validator?
The JSON Validator is a tool designed to help Hytale modders and server owners validate their JSON configuration files. It checks your JSON syntax and validates against known schemas for Block definitions, Item definitions, NPC/Entity definitions, and Plugin manifest files. This helps catch errors before you test your content in-game, saving time and preventing configuration issues.
Understanding Hytale JSON structures
Hytale uses JSON files extensively for defining game content. These files control everything from block properties to item behaviors, NPC configurations, and plugin metadata. Each type has specific fields and structures that must be followed for the game to recognize and use your content correctly.
BlockType definitions control how blocks appear and behave in-game:
- Required fields: DrawType, Material, Opacity
- Common fields: Textures, BlockSoundSetId, HitboxType, IsUsable
- Use case: Creating custom blocks for your mod or server
Item definitions specify properties for in-game items:
- Common fields: id, icon, maxStack, itemLevel
- Type fields: weapon, armor, tool, consumable
- Use case: Adding custom weapons, tools, or consumables
NPC definitions use an ECS-based structure for entities:
- Common fields: id, name, type, health, speed
- Components: ai, combat, behaviors
- Use case: Creating custom creatures or NPCs
Plugin manifest files define plugin metadata:
- Required fields: Group, Name, Version, Main
- Optional fields: Description, Authors, Dependencies
- Use case: Creating Hytale plugins
How to use the JSON Validator
Using the JSON Validator is straightforward: select the schema type you're working with, paste or type your JSON, and click Validate. The tool will check syntax, required fields, and field types, then display any errors or warnings. You can load example JSON for each type to see the expected structure.
Frequently Asked Questions
You can validate four types of Hytale JSON files: Block definitions (BlockType), Item definitions, NPC/Entity definitions, and Plugin manifest files. Each type has its own schema with specific required fields and validation rules.
Other server & dev tools
Use these tools together to generate configs, whitelists, and project structures that work well with your validated JSON.
