Skip to content

com.hypixel.hytale.builtin.asseteditor

Package: com.hypixel.hytale.builtin.asseteditor

The asset editor module provides a server-side plugin for real-time editing of game assets (models, items, block types, textures, sounds, etc.) through a dedicated editor client. The system supports JSON asset editing with BSON-based incremental updates, undo/redo history, live preview of models/weather/time, and asset pack management. The editor communicates via a custom packet protocol separate from the game client connection.

All types in this package are internal (api_surface: false). They are not part of the public plugin API.

AssetEditorPlugin is the central entry point. It manages editor client connections, asset pack data sources, schema distribution, and coordinates asset updates. EditorClient represents a connected editor session. Packet handling is split between AssetEditorGamePacketHandler (in-game client) and AssetEditorPacketHandler (standalone editor).

TypeKindDescription
AssetEditorPluginclassPlugin entry point and central coordinator
EditorClientclassRepresents a connected editor session
AssetEditorGamePacketHandlerclassHandles editor packets from in-game clients
AssetEditorPacketHandlerclassHandles packets from standalone editor clients
AssetPathrecordImmutable pack ID + path pair
AssetTreeclassSorted file tree for an asset pack
AssetTypeRegistryclassRegistry of asset type handlers
AssetSpecificFunctionalityclassEvent handlers for model/item/weather preview
MessagesclassLocalization message constants
UndoRedoManagerclassPer-asset undo/redo stack manager

Asset Type Handlers (sub-package assettypehandler)

Section titled “Asset Type Handlers (sub-package assettypehandler)”
TypeKindDescription
AssetTypeHandlerabstract classBase handler for loading/unloading assets
JsonTypeHandlerabstract classHandler for JSON-based assets
AssetStoreTypeHandlerclassHandler for asset-store-backed assets
CommonAssetTypeHandlerclassHandler for common assets (textures, models, etc.)
TypeKindDescription
AssetStateenumAsset modification state (CHANGED, NEW, DELETED)
AssetUndoRedoInfoclassUndo/redo command stacks for a single asset
ModifiedAssetclassTracks a modified asset with metadata
TypeKindDescription
DataSourceinterfaceAbstract file system operations for asset packs
StandardDataSourceclassFile-system-backed data source implementation
TypeKindDescription
EditorClientEventabstract classBase event carrying an EditorClient reference
AssetEditorActivateButtonEventclassButton activation in editor UI
AssetEditorAssetCreatedEventclassNew asset created
AssetEditorClientDisconnectEventclassEditor client disconnected
AssetEditorFetchAutoCompleteDataEventclassAuto-complete data request
AssetEditorRequestDataSetEventclassDataset request (e.g. item categories)
AssetEditorSelectAssetEventclassAsset selected in editor
AssetEditorUpdateWeatherPreviewLockEventclassWeather preview lock state change
TypeKindDescription
AssetPathUtilclassPath validation and filename utilities
AssetStoreUtilclassAsset store index lookup utility
BsonTransformationUtilclassBSON document property manipulation
Hydex is an independent community resource. Hytale is a trademark of Hypixel Studios. Hydex is not affiliated with or endorsed by Hypixel Studios.