hytale/hytale-server
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation; patch ChangeActiveSlotInteraction

Browse Source
This commit is contained in:
luk
2026-02-03 16:44:06 +00:00
parent f8d7b9a781
commit 49a80ebf77
16 changed files with 531 additions and 472 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
docs/00-llm-reference.md
View File

@@ -1,6 +1,7 @@
# Hytale Server API Reference (LLM-Optimized) # Hytale Server API Reference (LLM-Optimized)
This document is a comprehensive API reference for the Hytale Server modding system, optimized for LLM consumption. All class names, method signatures, and JSON structures are validated against the actual codebase. This document is a comprehensive API reference for the Hytale Server modding system, optimized for LLM consumption. All
class names, method signatures, and JSON structures are validated against the actual codebase.
--- ---
@@ -9,7 +10,7 @@ This document is a comprehensive API reference for the Hytale Server modding sys
### Core Classes ### Core Classes
| Class | Package | | Class | Package |
|-------|---------| |------------------|--------------------------------------------------------|
| `JavaPlugin` | `com.hypixel.hytale.server.core.plugin.JavaPlugin` | | `JavaPlugin` | `com.hypixel.hytale.server.core.plugin.JavaPlugin` |
| `PluginBase` | `com.hypixel.hytale.server.core.plugin.PluginBase` | | `PluginBase` | `com.hypixel.hytale.server.core.plugin.PluginBase` |
| `PluginManifest` | `com.hypixel.hytale.common.plugin.PluginManifest` | | `PluginManifest` | `com.hypixel.hytale.common.plugin.PluginManifest` |
@@ -23,6 +24,7 @@ PluginState: NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
``` ```
**Lifecycle Methods (exact names):** **Lifecycle Methods (exact names):**
- `setup()` - Called during initialization, register components here - `setup()` - Called during initialization, register components here
- `start()` - Called after setup, plugin becomes active - `start()` - Called after setup, plugin becomes active
- `shutdown()` - Called during server stop/plugin disable - `shutdown()` - Called during server stop/plugin disable
@@ -51,7 +53,7 @@ PluginState: NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
### Registry Methods on PluginBase ### Registry Methods on PluginBase
| Method | Return Type | | Method | Return Type |
|--------|-------------| |------------------------------|---------------------------------------|
| `getClientFeatureRegistry()` | `ClientFeatureRegistry` | | `getClientFeatureRegistry()` | `ClientFeatureRegistry` |
| `getCommandRegistry()` | `CommandRegistry` | | `getCommandRegistry()` | `CommandRegistry` |
| `getEventRegistry()` | `EventRegistry` | | `getEventRegistry()` | `EventRegistry` |
@@ -80,7 +82,7 @@ MyConfig cfg = config.get();
### Core Interfaces (Package: `com.hypixel.hytale.event`) ### Core Interfaces (Package: `com.hypixel.hytale.event`)
| Interface | Description | | Interface | Description |
|-----------|-------------| |------------------------|-------------------------------------------------|
| `IBaseEvent<KeyType>` | Base event interface | | `IBaseEvent<KeyType>` | Base event interface |
| `IEvent<KeyType>` | Synchronous event, extends IBaseEvent | | `IEvent<KeyType>` | Synchronous event, extends IBaseEvent |
| `IAsyncEvent<KeyType>` | Async event, extends IBaseEvent | | `IAsyncEvent<KeyType>` | Async event, extends IBaseEvent |
@@ -100,6 +102,7 @@ LAST = (short)21844 // Runs last
### EventRegistry Methods (IEventRegistry interface) ### EventRegistry Methods (IEventRegistry interface)
**Sync Registration:** **Sync Registration:**
```java ```java
// Without key (Void key) // Without key (Void key)
EventRegistration register(Class<? super EventType> eventClass, Consumer<EventType> consumer) EventRegistration register(Class<? super EventType> eventClass, Consumer<EventType> consumer)
@@ -111,17 +114,20 @@ EventRegistration register(EventPriority priority, Class<? super EventType> even
``` ```
**Global Registration (receives all keys):** **Global Registration (receives all keys):**
```java ```java
EventRegistration registerGlobal(Class<? super EventType> eventClass, Consumer<EventType> consumer) EventRegistration registerGlobal(Class<? super EventType> eventClass, Consumer<EventType> consumer)
EventRegistration registerGlobal(EventPriority priority, Class<? super EventType> eventClass, Consumer<EventType> consumer) EventRegistration registerGlobal(EventPriority priority, Class<? super EventType> eventClass, Consumer<EventType> consumer)
``` ```
**Unhandled Registration (when no other handler processed):** **Unhandled Registration (when no other handler processed):**
```java ```java
EventRegistration registerUnhandled(Class<? super EventType> eventClass, Consumer<EventType> consumer) EventRegistration registerUnhandled(Class<? super EventType> eventClass, Consumer<EventType> consumer)
``` ```
**Async Registration:** **Async Registration:**
```java ```java
EventRegistration registerAsync(Class<? super EventType> eventClass, Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function) EventRegistration registerAsync(Class<? super EventType> eventClass, Function<CompletableFuture<EventType>, CompletableFuture<EventType>> function)
EventRegistration registerAsyncGlobal(...) EventRegistration registerAsyncGlobal(...)
@@ -131,11 +137,13 @@ EventRegistration registerAsyncUnhandled(...)
### Key Event Classes ### Key Event Classes
**Server Events (`com.hypixel.hytale.server.core.event.events`):** **Server Events (`com.hypixel.hytale.server.core.event.events`):**
- `BootEvent` - IEvent<Void> - `BootEvent` - IEvent<Void>
- `ShutdownEvent` - IEvent<Void> - `ShutdownEvent` - IEvent<Void>
- `PrepareUniverseEvent` - IEvent<Void> - `PrepareUniverseEvent` - IEvent<Void>
**Player Events (`...event.events.player`):** **Player Events (`...event.events.player`):**
- `PlayerConnectEvent` - IEvent<Void> - `PlayerConnectEvent` - IEvent<Void>
- `PlayerSetupConnectEvent` - IEvent<Void>, ICancellable - `PlayerSetupConnectEvent` - IEvent<Void>, ICancellable
- `PlayerDisconnectEvent` - PlayerRefEvent<Void> - `PlayerDisconnectEvent` - PlayerRefEvent<Void>
@@ -146,12 +154,14 @@ EventRegistration registerAsyncUnhandled(...)
- `DrainPlayerFromWorldEvent` - IEvent<String> - `DrainPlayerFromWorldEvent` - IEvent<String>
**World Events (`...universe.world.events`):** **World Events (`...universe.world.events`):**
- `AddWorldEvent` - WorldEvent, ICancellable - `AddWorldEvent` - WorldEvent, ICancellable
- `RemoveWorldEvent` - WorldEvent, ICancellable - `RemoveWorldEvent` - WorldEvent, ICancellable
- `StartWorldEvent` - WorldEvent - `StartWorldEvent` - WorldEvent
- `AllWorldsLoadedEvent` - IEvent<Void> - `AllWorldsLoadedEvent` - IEvent<Void>
**ECS Events (`...event.events.ecs`):** **ECS Events (`...event.events.ecs`):**
- `BreakBlockEvent` - CancellableEcsEvent - `BreakBlockEvent` - CancellableEcsEvent
- `PlaceBlockEvent` - CancellableEcsEvent - `PlaceBlockEvent` - CancellableEcsEvent
- `UseBlockEvent` - EcsEvent (with nested `Pre` implementing ICancellableEcsEvent) - `UseBlockEvent` - EcsEvent (with nested `Pre` implementing ICancellableEcsEvent)
@@ -165,7 +175,7 @@ EventRegistration registerAsyncUnhandled(...)
### Core Classes (Package: `com.hypixel.hytale.server.core.command.system`) ### Core Classes (Package: `com.hypixel.hytale.server.core.command.system`)
| Class | Description | | Class | Description |
|-------|-------------| |-----------------------------|--------------------------------------------|
| `AbstractCommand` | Base command class | | `AbstractCommand` | Base command class |
| `CommandRegistry` | Plugin command registration | | `CommandRegistry` | Plugin command registration |
| `CommandContext` | Execution context | | `CommandContext` | Execution context |
@@ -232,7 +242,7 @@ ArgTypes.forEnum(String name, Class<E> enumClass) // Create enum type
### Core Classes (Package: `com.hypixel.hytale.component`) ### Core Classes (Package: `com.hypixel.hytale.component`)
| Class | Description | | Class | Description |
|-------|-------------| |------------------------------|------------------------------------------|
| `Component<ECS_TYPE>` | Base component interface | | `Component<ECS_TYPE>` | Base component interface |
| `ComponentRegistry` | Component type registration | | `ComponentRegistry` | Component type registration |
| `ComponentType<ECS_TYPE, T>` | Registered component type | | `ComponentType<ECS_TYPE, T>` | Registered component type |
@@ -264,33 +274,39 @@ void registerSystem(ISystem<EntityStore> system)
### Key Built-in Components ### Key Built-in Components
**Transform/Position:** **Transform/Position:**
- `TransformComponent` - Position (Vector3d) and rotation (Vector3f) - `TransformComponent` - Position (Vector3d) and rotation (Vector3f)
- `HeadRotation` - Head rotation angles - `HeadRotation` - Head rotation angles
- `EntityScaleComponent` - Scale modifier - `EntityScaleComponent` - Scale modifier
**Physics:** **Physics:**
- `Velocity` - Velocity vector - `Velocity` - Velocity vector
- `BoundingBox` - Collision box - `BoundingBox` - Collision box
- `CollisionResultComponent` - Collision results - `CollisionResultComponent` - Collision results
- `MovementStatesComponent` - Movement flags (onGround, swimming, etc.) - `MovementStatesComponent` - Movement flags (onGround, swimming, etc.)
**Identity:** **Identity:**
- `UUIDComponent` - Unique identifier - `UUIDComponent` - Unique identifier
- `NetworkId` - Network sync ID - `NetworkId` - Network sync ID
- `DisplayNameComponent` - Display name - `DisplayNameComponent` - Display name
**Visual:** **Visual:**
- `ModelComponent` - 3D model reference - `ModelComponent` - 3D model reference
- `ActiveAnimationComponent` - Current animations - `ActiveAnimationComponent` - Current animations
- `DynamicLight` - Dynamic lighting - `DynamicLight` - Dynamic lighting
**State Flags:** **State Flags:**
- `Invulnerable` - Immune to damage - `Invulnerable` - Immune to damage
- `Intangible` - Non-collidable - `Intangible` - Non-collidable
- `Interactable` - Can be interacted with - `Interactable` - Can be interacted with
- `Frozen` - Frozen state - `Frozen` - Frozen state
**Player-specific:** **Player-specific:**
- `Player` - Core player component - `Player` - Core player component
- `PlayerRef` - Network connection reference - `PlayerRef` - Network connection reference
- `ChunkTracker` - Loaded chunks tracking - `ChunkTracker` - Loaded chunks tracking
@@ -324,7 +340,7 @@ Ref<EntityStore> ref = store.addEntity(holder, AddReason.SPAWN);
### Page System Classes ### Page System Classes
| Class | Package | | Class | Package |
|-------|---------| |------------------------------|----------------------------------------------------------------------------|
| `CustomUIPage` | `com.hypixel.hytale.server.core.entity.entities.player.pages.CustomUIPage` | | `CustomUIPage` | `com.hypixel.hytale.server.core.entity.entities.player.pages.CustomUIPage` |
| `BasicCustomUIPage` | Same package - no event data parsing | | `BasicCustomUIPage` | Same package - no event data parsing |
| `InteractiveCustomUIPage<T>` | Same package - typed event handling | | `InteractiveCustomUIPage<T>` | Same package - typed event handling |
@@ -438,7 +454,7 @@ player.getPageManager().openCustomPage(ref, store, new MyPage(playerRef));
### Window System ### Window System
| Class | Package | | Class | Package |
|-------|---------| |-------------------------------------------|------------------------------------------------------------------------|
| `Window` | `com.hypixel.hytale.server.core.entity.entities.player.windows.Window` | | `Window` | `com.hypixel.hytale.server.core.entity.entities.player.windows.Window` |
| `WindowManager` | Same package | | `WindowManager` | Same package |
| `ContainerWindow`, `CraftingWindow`, etc. | Same package | | `ContainerWindow`, `CraftingWindow`, etc. | Same package |
@@ -457,7 +473,7 @@ DiagramCrafting(3), StructuralCrafting(4), Processing(5), Memories(6)
### Core Classes (Package: `com.hypixel.hytale.codec`) ### Core Classes (Package: `com.hypixel.hytale.codec`)
| Class | Description | | Class | Description |
|-------|-------------| |-------------------|----------------------|
| `Codec<T>` | Base codec interface | | `Codec<T>` | Base codec interface |
| `BuilderCodec<T>` | Builder-based codec | | `BuilderCodec<T>` | Builder-based codec |
| `KeyedCodec<T>` | Key-value codec | | `KeyedCodec<T>` | Key-value codec |
@@ -504,7 +520,7 @@ Codec<MyEnum> ENUM = Codec.enumCodec(MyEnum.class);
### Core Classes ### Core Classes
| Class | Package | | Class | Package |
|-------|---------| |---------------------|-------------------------------------------------------|
| `JsonAsset<K>` | `com.hypixel.hytale.assetstore.JsonAsset` | | `JsonAsset<K>` | `com.hypixel.hytale.assetstore.JsonAsset` |
| `AssetStore<K,T,M>` | `com.hypixel.hytale.assetstore.AssetStore` | | `AssetStore<K,T,M>` | `com.hypixel.hytale.assetstore.AssetStore` |
| `AssetRegistry` | `com.hypixel.hytale.server.core.plugin.AssetRegistry` | | `AssetRegistry` | `com.hypixel.hytale.server.core.plugin.AssetRegistry` |
@@ -512,30 +528,36 @@ Codec<MyEnum> ENUM = Codec.enumCodec(MyEnum.class);
### Key Asset Types (Package: `com.hypixel.hytale.server.core.asset.type`) ### Key Asset Types (Package: `com.hypixel.hytale.server.core.asset.type`)
**Blocks:** **Blocks:**
- `BlockType` - blocktype.config.BlockType - `BlockType` - blocktype.config.BlockType
- `BlockSet` - blockset.config.BlockSet - `BlockSet` - blockset.config.BlockSet
- `BlockSoundSet` - blocksound.config.BlockSoundSet - `BlockSoundSet` - blocksound.config.BlockSoundSet
**Items:** **Items:**
- `Item` - item.config.Item - `Item` - item.config.Item
- `ItemCategory` - item.config.ItemCategory - `ItemCategory` - item.config.ItemCategory
- `CraftingRecipe` - item.config.CraftingRecipe - `CraftingRecipe` - item.config.CraftingRecipe
**Visual:** **Visual:**
- `ModelAsset` - model.config.ModelAsset - `ModelAsset` - model.config.ModelAsset
- `ParticleSystem` - particle.config.ParticleSystem - `ParticleSystem` - particle.config.ParticleSystem
- `EntityEffect` - entityeffect.config.EntityEffect - `EntityEffect` - entityeffect.config.EntityEffect
**Audio:** **Audio:**
- `SoundEvent` - soundevent.config.SoundEvent - `SoundEvent` - soundevent.config.SoundEvent
- `SoundSet` - soundset.config.SoundSet - `SoundSet` - soundset.config.SoundSet
**Environment:** **Environment:**
- `Environment` - environment.config.Environment - `Environment` - environment.config.Environment
- `Weather` - weather.config.Weather - `Weather` - weather.config.Weather
- `Fluid` - fluid.Fluid - `Fluid` - fluid.Fluid
**Gameplay:** **Gameplay:**
- `Projectile` - projectile.config.Projectile - `Projectile` - projectile.config.Projectile
- `GameplayConfig` - gameplay.GameplayConfig - `GameplayConfig` - gameplay.GameplayConfig
@@ -557,7 +579,7 @@ Codec<MyEnum> ENUM = Codec.enumCodec(MyEnum.class);
### Core Classes ### Core Classes
| Class | Package | | Class | Package |
|-------|---------| |---------------|---------------------------------------------------------------------|
| `Universe` | `com.hypixel.hytale.server.core.universe.Universe` | | `Universe` | `com.hypixel.hytale.server.core.universe.Universe` |
| `World` | `com.hypixel.hytale.server.core.universe.world.World` | | `World` | `com.hypixel.hytale.server.core.universe.world.World` |
| `EntityStore` | `com.hypixel.hytale.server.core.universe.world.storage.EntityStore` | | `EntityStore` | `com.hypixel.hytale.server.core.universe.world.storage.EntityStore` |
@@ -591,7 +613,7 @@ boolean paused = world.isPaused();
### Core Classes (Package: `com.hypixel.hytale.server.npc`) ### Core Classes (Package: `com.hypixel.hytale.server.npc`)
| Class | Description | | Class | Description |
|-------|-------------| |---------------|--------------------------------------------|
| `NPCEntity` | entities.NPCEntity - NPC entity class | | `NPCEntity` | entities.NPCEntity - NPC entity class |
| `Role` | role.Role - Behavior definition | | `Role` | role.Role - Behavior definition |
| `Instruction` | instructions.Instruction - Behavior action | | `Instruction` | instructions.Instruction - Behavior action |
@@ -611,7 +633,7 @@ void playAnimation(...)
### Flock System (Package: `com.hypixel.hytale.server.flock`) ### Flock System (Package: `com.hypixel.hytale.server.flock`)
| Component | Description | | Component | Description |
|-----------|-------------| |-------------------|---------------------------|
| `Flock` | Flock leader/group | | `Flock` | Flock leader/group |
| `FlockMembership` | Entity's flock membership | | `FlockMembership` | Entity's flock membership |
@@ -622,7 +644,7 @@ void playAnimation(...)
### Packet System (Package: `com.hypixel.hytale.protocol`) ### Packet System (Package: `com.hypixel.hytale.protocol`)
| Class | Description | | Class | Description |
|-------|-------------| |------------------|--------------------------|
| `Packet` | Base packet interface | | `Packet` | Base packet interface |
| `PacketRegistry` | Packet type registration | | `PacketRegistry` | Packet type registration |
@@ -640,7 +662,7 @@ void playAnimation(...)
### UI Packets ### UI Packets
| Packet | ID | Direction | | Packet | ID | Direction |
|--------|-----|-----------| |-------------------|-----|-----------|
| `SetPage` | 216 | S->C | | `SetPage` | 216 | S->C |
| `CustomHud` | 217 | S->C | | `CustomHud` | 217 | S->C |
| `CustomPage` | 218 | S->C | | `CustomPage` | 218 | S->C |
@@ -649,7 +671,7 @@ void playAnimation(...)
### Window Packets ### Window Packets
| Packet | ID | Direction | | Packet | ID | Direction |
|--------|-----|-----------| |--------------------|-----|-----------|
| `OpenWindow` | 200 | S->C | | `OpenWindow` | 200 | S->C |
| `UpdateWindow` | 201 | S->C | | `UpdateWindow` | 201 | S->C |
| `CloseWindow` | 202 | S->C | | `CloseWindow` | 202 | S->C |
@@ -724,23 +746,29 @@ Place JAR in `earlyplugins/` directory.
### EntityStore Components (130+) ### EntityStore Components (130+)
**Transform:** TransformComponent, HeadRotation, PositionDataComponent, EntityScaleComponent, RotateObjectComponent, SnapshotBuffer **Transform:** TransformComponent, HeadRotation, PositionDataComponent, EntityScaleComponent, RotateObjectComponent,
SnapshotBuffer
**Physics:** Velocity, PhysicsValues, BoundingBox, CollisionResultComponent, KnockbackComponent, MovementStatesComponent, HitboxCollision, Repulsion **Physics:** Velocity, PhysicsValues, BoundingBox, CollisionResultComponent, KnockbackComponent,
MovementStatesComponent, HitboxCollision, Repulsion
**Player:** Player, MovementManager, CameraManager, ChunkTracker, PlayerInput, PlayerSettings, PlayerSkinComponent, PlayerRef **Player:** Player, MovementManager, CameraManager, ChunkTracker, PlayerInput, PlayerSettings, PlayerSkinComponent,
PlayerRef
**NPC:** NPCEntity, ValueStore, StateEvaluator, StepComponent, Timers, FailedSpawnComponent **NPC:** NPCEntity, ValueStore, StateEvaluator, StepComponent, Timers, FailedSpawnComponent
**Combat:** DamageDataComponent, DeathComponent, DeferredCorpseRemoval, CombatActionEvaluator, TargetMemory, DamageMemory **Combat:** DamageDataComponent, DeathComponent, DeferredCorpseRemoval, CombatActionEvaluator, TargetMemory,
DamageMemory
**Visual:** ModelComponent, PersistentModel, PropComponent, DisplayNameComponent, ActiveAnimationComponent, DynamicLight, Nameplate **Visual:** ModelComponent, PersistentModel, PropComponent, DisplayNameComponent, ActiveAnimationComponent,
DynamicLight, Nameplate
**Audio:** AudioComponent, MovementAudioComponent **Audio:** AudioComponent, MovementAudioComponent
**Identity:** UUIDComponent, NetworkId, EntityViewer, Visible, PersistentRefCount **Identity:** UUIDComponent, NetworkId, EntityViewer, Visible, PersistentRefCount
**State Flags:** Frozen, Intangible, Invulnerable, Interactable, RespondToHit, HiddenFromAdventurePlayers, NewSpawnComponent, FromPrefab, FromWorldGen, DespawnComponent **State Flags:** Frozen, Intangible, Invulnerable, Interactable, RespondToHit, HiddenFromAdventurePlayers,
NewSpawnComponent, FromPrefab, FromWorldGen, DespawnComponent
**Teleport:** Teleport, PendingTeleport, TeleportHistory, WarpComponent **Teleport:** Teleport, PendingTeleport, TeleportHistory, WarpComponent
@@ -762,7 +790,8 @@ Place JAR in `earlyplugins/` directory.
### ChunkStore Components (25+) ### ChunkStore Components (25+)
**Structure:** BlockChunk, BlockComponentChunk, EntityChunk, ChunkColumn, ChunkSection, BlockSection, FluidSection, EnvironmentChunk **Structure:** BlockChunk, BlockComponentChunk, EntityChunk, ChunkColumn, ChunkSection, BlockSection, FluidSection,
EnvironmentChunk
**Block State:** BlockState, RespawnBlock, LaunchPad, BlockMapMarker **Block State:** BlockState, RespawnBlock, LaunchPad, BlockMapMarker

7
docs/01-getting-started.md
View File

@@ -2,14 +2,15 @@
## Overview ## Overview
The Hytale Server provides a comprehensive modding API that allows developers to extend and customize the game. This documentation covers the essential systems and APIs available for mod development. The Hytale Server provides a comprehensive modding API that allows developers to extend and customize the game. This
documentation covers the essential systems and APIs available for mod development.
## Architecture Overview ## Architecture Overview
The server is built on several core systems: The server is built on several core systems:
| System | Purpose | | System | Purpose |
|--------|---------| |-------------------------------|----------------------------------------------------------------|
| Plugin System | Mod loading, lifecycle management, and dependency resolution | | Plugin System | Mod loading, lifecycle management, and dependency resolution |
| Entity Component System (ECS) | High-performance entity management with components and systems | | Entity Component System (ECS) | High-performance entity management with components and systems |
| Event System | Prioritized event dispatching with sync/async support | | Event System | Prioritized event dispatching with sync/async support |
@@ -122,7 +123,7 @@ Plugins go through the following states:
Your plugin has access to several registries for registration: Your plugin has access to several registries for registration:
| Registry | Access Method | Purpose | | Registry | Access Method | Purpose |
|----------|---------------|---------| |-----------------------|------------------------------|-------------------------------|
| CommandRegistry | `getCommandRegistry()` | Register custom commands | | CommandRegistry | `getCommandRegistry()` | Register custom commands |
| EventRegistry | `getEventRegistry()` | Register event listeners | | EventRegistry | `getEventRegistry()` | Register event listeners |
| EntityRegistry | `getEntityRegistry()` | Register custom entity types | | EntityRegistry | `getEntityRegistry()` | Register custom entity types |

6
docs/02-plugin-development.md
View File

@@ -37,7 +37,7 @@ The `manifest.json` file must be placed at the root of your JAR:
### Manifest Fields ### Manifest Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
|-------|------|----------|-------------| |------------------------|----------|----------|--------------------------------------------------|
| `Group` | String | Yes | Maven-style group ID (e.g., `com.example`) | | `Group` | String | Yes | Maven-style group ID (e.g., `com.example`) |
| `Name` | String | Yes | Plugin name (unique identifier within group) | | `Name` | String | Yes | Plugin name (unique identifier within group) |
| `Version` | String | Yes | Semantic version (e.g., `1.0.0`) | | `Version` | String | Yes | Semantic version (e.g., `1.0.0`) |
@@ -55,6 +55,7 @@ The `manifest.json` file must be placed at the root of your JAR:
### Plugin Identifier ### Plugin Identifier
Plugins are identified by `Group:Name` format (e.g., `com.example:MyPlugin`). This identifier is used for: Plugins are identified by `Group:Name` format (e.g., `com.example:MyPlugin`). This identifier is used for:
- Dependency resolution - Dependency resolution
- Permission namespacing (`com.example.myplugin.*`) - Permission namespacing (`com.example.myplugin.*`)
- Configuration keys - Configuration keys
@@ -122,7 +123,7 @@ NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
``` ```
| State | Description | | State | Description |
|-------|-------------| |------------|--------------------------------------------------|
| `NONE` | Initial state before any lifecycle methods | | `NONE` | Initial state before any lifecycle methods |
| `SETUP` | `setup()` is executing; register components here | | `SETUP` | `setup()` is executing; register components here |
| `START` | `start()` is executing; plugin becoming active | | `START` | `start()` is executing; plugin becoming active |
@@ -267,6 +268,7 @@ Commands registered by your plugin will have permissions under:
``` ```
For example, if your plugin is `com.example:MyPlugin` and you register a command `spawn`: For example, if your plugin is `com.example:MyPlugin` and you register a command `spawn`:
- Base permission: `com.example.myplugin` - Base permission: `com.example.myplugin`
- Command permission: `com.example.myplugin.command.spawn` - Command permission: `com.example.myplugin.command.spawn`

20
docs/03-event-system.md
View File

@@ -1,6 +1,7 @@
# Event System # Event System
The Hytale event system provides a powerful mechanism for plugins to react to game events. It supports both synchronous and asynchronous events with priority-based dispatching. The Hytale event system provides a powerful mechanism for plugins to react to game events. It supports both synchronous
and asynchronous events with priority-based dispatching.
## Event Architecture ## Event Architecture
@@ -17,7 +18,7 @@ ICancellable // Mixin interface for cancellable events
### Key Classes ### Key Classes
| Class | Description | | Class | Description |
|-------|-------------| |------------------------|--------------------------------------------|
| `IEvent<K>` | Synchronous event interface | | `IEvent<K>` | Synchronous event interface |
| `IAsyncEvent<K>` | Asynchronous event interface | | `IAsyncEvent<K>` | Asynchronous event interface |
| `ICancellable` | Interface for events that can be cancelled | | `ICancellable` | Interface for events that can be cancelled |
@@ -30,14 +31,15 @@ ICancellable // Mixin interface for cancellable events
Events are dispatched to listeners in priority order: Events are dispatched to listeners in priority order:
| Priority | Value | Description | | Priority | Value | Description |
|----------|-------|-------------| |----------|--------|-------------------------------|
| `FIRST` | -21844 | Runs first, before all others | | `FIRST` | -21844 | Runs first, before all others |
| `EARLY` | -10922 | Runs early, after FIRST | | `EARLY` | -10922 | Runs early, after FIRST |
| `NORMAL` | 0 | Default priority | | `NORMAL` | 0 | Default priority |
| `LATE` | 10922 | Runs late, after NORMAL | | `LATE` | 10922 | Runs late, after NORMAL |
| `LAST` | 21844 | Runs last, after all others | | `LAST` | 21844 | Runs last, after all others |
Lower values run first. Use `FIRST` sparingly - typically for monitoring/logging. Use `LAST` for final processing after other plugins have had a chance to modify the event. Lower values run first. Use `FIRST` sparingly - typically for monitoring/logging. Use `LAST` for final processing after
other plugins have had a chance to modify the event.
## Registering Event Listeners ## Registering Event Listeners
@@ -149,7 +151,7 @@ getEventRegistry().register(EventPriority.LAST, PlayerInteractEvent.class, event
### Server Lifecycle Events ### Server Lifecycle Events
| Event | Description | | Event | Description |
|-------|-------------| |------------------------|-------------------------|
| `BootEvent` | Server boot complete | | `BootEvent` | Server boot complete |
| `ShutdownEvent` | Server shutting down | | `ShutdownEvent` | Server shutting down |
| `PrepareUniverseEvent` | Universe initialization | | `PrepareUniverseEvent` | Universe initialization |
@@ -157,7 +159,7 @@ getEventRegistry().register(EventPriority.LAST, PlayerInteractEvent.class, event
### Player Events ### Player Events
| Event | Description | | Event | Description |
|-------|-------------| |-----------------------------|----------------------------------|
| `PlayerConnectEvent` | Player connected to server | | `PlayerConnectEvent` | Player connected to server |
| `PlayerDisconnectEvent` | Player disconnected | | `PlayerDisconnectEvent` | Player disconnected |
| `AddPlayerToWorldEvent` | Player added to a world | | `AddPlayerToWorldEvent` | Player added to a world |
@@ -168,14 +170,14 @@ getEventRegistry().register(EventPriority.LAST, PlayerInteractEvent.class, event
### Entity Events ### Entity Events
| Event | Description | | Event | Description |
|-------|-------------| |-----------------------------|-----------------------------|
| `EntityRemoveEvent` | Entity removed from world | | `EntityRemoveEvent` | Entity removed from world |
| `LivingEntityUseBlockEvent` | Living entity using a block | | `LivingEntityUseBlockEvent` | Living entity using a block |
### World Events ### World Events
| Event | Description | | Event | Description |
|-------|-------------| |------------------------|-----------------------------|
| `AddWorldEvent` | World added to universe | | `AddWorldEvent` | World added to universe |
| `RemoveWorldEvent` | World removed | | `RemoveWorldEvent` | World removed |
| `StartWorldEvent` | World started | | `StartWorldEvent` | World started |
@@ -184,7 +186,7 @@ getEventRegistry().register(EventPriority.LAST, PlayerInteractEvent.class, event
### ECS Events ### ECS Events
| Event | Description | | Event | Description |
|-------|-------------| |---------------------|-------------------|
| `UseBlockEvent` | Block usage event | | `UseBlockEvent` | Block usage event |
| `DiscoverZoneEvent` | Zone discovery | | `DiscoverZoneEvent` | Zone discovery |

6
docs/04-command-system.md
View File

@@ -4,7 +4,8 @@ The Hytale command system allows plugins to register custom commands that can be
## Overview ## Overview
Commands are defined by extending `AbstractCommand` and registered through the plugin's `CommandRegistry`. The system supports: Commands are defined by extending `AbstractCommand` and registered through the plugin's `CommandRegistry`. The system
supports:
- Required and optional arguments - Required and optional arguments
- Subcommands - Subcommands
@@ -270,6 +271,7 @@ Commands automatically receive permissions based on the plugin's base permission
``` ```
For example, if your plugin is `com.example:MyPlugin` and command is `spawn`: For example, if your plugin is `com.example:MyPlugin` and command is `spawn`:
- Permission: `com.example.myplugin.command.spawn` - Permission: `com.example.myplugin.command.spawn`
### Custom Permissions ### Custom Permissions
@@ -304,7 +306,7 @@ public void execute(CommandContext context, Arguments args) {
Commands can be executed by different sender types: Commands can be executed by different sender types:
| Sender Type | Description | | Sender Type | Description |
|-------------|-------------| |----------------|-------------------------------|
| `Player` | In-game player | | `Player` | In-game player |
| `Console` | Server console | | `Console` | Server console |
| `CommandBlock` | Command block (if applicable) | | `CommandBlock` | Command block (if applicable) |

7
docs/05-entity-system.md
View File

@@ -1,6 +1,7 @@
# Entity Component System (ECS) # Entity Component System (ECS)
The Hytale server uses an Entity Component System architecture for managing game entities. This provides high performance and flexibility for handling large numbers of entities with varied behaviors. The Hytale server uses an Entity Component System architecture for managing game entities. This provides high
performance and flexibility for handling large numbers of entities with varied behaviors.
## ECS Concepts ## ECS Concepts
@@ -17,7 +18,7 @@ The ECS pattern separates data (Components) from behavior (Systems):
### Key Classes ### Key Classes
| Class | Description | | Class | Description |
|-------|-------------| |---------------------|--------------------------------------|
| `Component<S>` | Base component interface | | `Component<S>` | Base component interface |
| `ComponentRegistry` | Central registry for component types | | `ComponentRegistry` | Central registry for component types |
| `Store` | ECS data storage | | `Store` | ECS data storage |
@@ -81,7 +82,7 @@ public class HealthComponent implements Component<EntityStore> {
The server provides several built-in components in `EntityStore.REGISTRY`: The server provides several built-in components in `EntityStore.REGISTRY`:
| Component | Description | | Component | Description |
|-----------|-------------| |--------------------------|-----------------------------------|
| `TransformComponent` | Position, rotation, and scale | | `TransformComponent` | Position, rotation, and scale |
| `UUIDComponent` | Unique entity identifier | | `UUIDComponent` | Unique entity identifier |
| `ModelComponent` | Visual model reference | | `ModelComponent` | Visual model reference |

3
docs/06-world-management.md
View File

@@ -1,6 +1,7 @@
# World Management # World Management
The Hytale server supports multiple worlds within a single universe. This guide covers world management, chunk handling, and related systems. The Hytale server supports multiple worlds within a single universe. This guide covers world management, chunk handling,
and related systems.
## Universe ## Universe

19
docs/07-networking.md
View File

@@ -1,6 +1,7 @@
# Networking and Protocol # Networking and Protocol
The Hytale server uses a packet-based networking system for client-server communication. This guide covers the protocol system, packet types, and how to work with networking in your mods. The Hytale server uses a packet-based networking system for client-server communication. This guide covers the protocol
system, packet types, and how to work with networking in your mods.
## Overview ## Overview
@@ -16,7 +17,7 @@ The networking layer is built on QUIC protocol and handles:
## Key Components ## Key Components
| Component | Description | | Component | Description |
|-----------|-------------| |------------------|--------------------------------------------------|
| `Packet` | Base interface for all packets | | `Packet` | Base interface for all packets |
| `PacketRegistry` | Central packet type registration | | `PacketRegistry` | Central packet type registration |
| `PacketHandler` | Manages client connections and packet processing | | `PacketHandler` | Manages client connections and packet processing |
@@ -27,7 +28,7 @@ The networking layer is built on QUIC protocol and handles:
Packets are organized into categories in `com.hypixel.hytale.protocol.packets`: Packets are organized into categories in `com.hypixel.hytale.protocol.packets`:
| Category | Description | | Category | Description |
|----------|-------------| |-----------------|--------------------------------------------------|
| `connection/` | Connection lifecycle (connect, disconnect, ping) | | `connection/` | Connection lifecycle (connect, disconnect, ping) |
| `auth/` | Authentication and session management | | `auth/` | Authentication and session management |
| `player/` | Player-specific packets (movement, actions) | | `player/` | Player-specific packets (movement, actions) |
@@ -164,7 +165,7 @@ for (Player player : Universe.get().getPlayers()) {
### Connection Packets ### Connection Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |----------------------------|-----------|-----------------------------------|
| `ConnectionRequestPacket` | C->S | Client requests connection | | `ConnectionRequestPacket` | C->S | Client requests connection |
| `ConnectionResponsePacket` | S->C | Server accepts/rejects connection | | `ConnectionResponsePacket` | S->C | Server accepts/rejects connection |
| `DisconnectPacket` | Both | Connection termination | | `DisconnectPacket` | Both | Connection termination |
@@ -173,7 +174,7 @@ for (Player player : Universe.get().getPlayers()) {
### Player Packets ### Player Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |------------------------|-----------|----------------------------------|
| `PlayerPositionPacket` | Both | Position update | | `PlayerPositionPacket` | Both | Position update |
| `PlayerInputPacket` | C->S | Player input (movement, actions) | | `PlayerInputPacket` | C->S | Player input (movement, actions) |
| `PlayerActionPacket` | C->S | Player actions | | `PlayerActionPacket` | C->S | Player actions |
@@ -181,7 +182,7 @@ for (Player player : Universe.get().getPlayers()) {
### Entity Packets ### Entity Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |----------------------|-----------|---------------------|
| `EntitySpawnPacket` | S->C | Entity creation | | `EntitySpawnPacket` | S->C | Entity creation |
| `EntityUpdatePacket` | S->C | Entity state update | | `EntityUpdatePacket` | S->C | Entity state update |
| `EntityRemovePacket` | S->C | Entity removal | | `EntityRemovePacket` | S->C | Entity removal |
@@ -190,7 +191,7 @@ for (Player player : Universe.get().getPlayers()) {
### World Packets ### World Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |---------------------|-----------|---------------------|
| `ChunkDataPacket` | S->C | Chunk data transfer | | `ChunkDataPacket` | S->C | Chunk data transfer |
| `BlockChangePacket` | S->C | Block state change | | `BlockChangePacket` | S->C | Block state change |
| `WorldTimePacket` | S->C | World time sync | | `WorldTimePacket` | S->C | World time sync |
@@ -198,7 +199,7 @@ for (Player player : Universe.get().getPlayers()) {
### Inventory Packets ### Inventory Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |-------------------------|-----------|--------------------------|
| `InventoryUpdatePacket` | S->C | Inventory contents | | `InventoryUpdatePacket` | S->C | Inventory contents |
| `SlotChangePacket` | Both | Single slot update | | `SlotChangePacket` | Both | Single slot update |
| `ItemPickupPacket` | S->C | Item pickup notification | | `ItemPickupPacket` | S->C | Item pickup notification |
@@ -285,7 +286,7 @@ player.closeUI();
### UI Packets ### UI Packets
| Packet | Direction | Description | | Packet | Direction | Description |
|--------|-----------|-------------| |-----------------------|-----------|-------------------------------|
| `UIOpenPacket` | S->C | Open a UI screen | | `UIOpenPacket` | S->C | Open a UI screen |
| `UIClosePacket` | S->C | Close UI | | `UIClosePacket` | S->C | Close UI |
| `UIUpdatePacket` | S->C | Update UI data | | `UIUpdatePacket` | S->C | Update UI data |

5
docs/08-asset-system.md
View File

@@ -1,6 +1,7 @@
# Asset System # Asset System
The Hytale asset system manages game assets including blocks, items, models, sounds, particles, and more. This guide covers how to work with assets and create custom content. The Hytale asset system manages game assets including blocks, items, models, sounds, particles, and more. This guide
covers how to work with assets and create custom content.
## Overview ## Overview
@@ -39,7 +40,7 @@ Assets are loaded from:
The server supports many built-in asset types located in `server/core/asset/type/`: The server supports many built-in asset types located in `server/core/asset/type/`:
| Asset Type | Description | | Asset Type | Description |
|------------|-------------| |--------------------|---------------------------------------|
| `BlockType` | Block definitions (stone, dirt, etc.) | | `BlockType` | Block definitions (stone, dirt, etc.) |
| `ItemType` | Item definitions | | `ItemType` | Item definitions |
| `ModelAsset` | 3D model definitions | | `ModelAsset` | 3D model definitions |

3
docs/10-configuration.md
View File

@@ -1,6 +1,7 @@
# Configuration System # Configuration System
The Hytale server provides a robust configuration system for both server settings and plugin configurations. This guide covers how to use and extend the configuration system. The Hytale server provides a robust configuration system for both server settings and plugin configurations. This guide
covers how to use and extend the configuration system.
## Server Configuration ## Server Configuration

6
docs/11-codec-serialization.md
View File

@@ -1,6 +1,7 @@
# Codec and Serialization System # Codec and Serialization System
The Hytale server uses a powerful codec system for data serialization and deserialization. This system is used throughout the codebase for configuration, network packets, asset definitions, and data persistence. The Hytale server uses a powerful codec system for data serialization and deserialization. This system is used
throughout the codebase for configuration, network packets, asset definitions, and data persistence.
## Overview ## Overview
@@ -25,7 +26,8 @@ public interface Codec<T> {
### DataInput/DataOutput ### DataInput/DataOutput
Codecs work with abstract `DataInput` and `DataOutput` interfaces that can represent different formats (JSON, BSON, etc.). Codecs work with abstract `DataInput` and `DataOutput` interfaces that can represent different formats (JSON, BSON,
etc.).
## Primitive Codecs ## Primitive Codecs

3
docs/13-utilities.md
View File

@@ -1,6 +1,7 @@
# Utilities and Common APIs # Utilities and Common APIs
The Hytale server provides a comprehensive set of utility classes and common APIs. This guide covers the most useful utilities for mod development. The Hytale server provides a comprehensive set of utility classes and common APIs. This guide covers the most useful
utilities for mod development.
## Math Utilities ## Math Utilities

6
docs/14-early-plugin-system.md
View File

@@ -1,6 +1,7 @@
# Early Plugin System (Class Transformation) # Early Plugin System (Class Transformation)
The Early Plugin System allows advanced mods to transform Java bytecode before classes are loaded. This is a powerful feature for core modifications that cannot be achieved through the standard plugin API. The Early Plugin System allows advanced mods to transform Java bytecode before classes are loaded. This is a powerful
feature for core modifications that cannot be achieved through the standard plugin API.
## Overview ## Overview
@@ -23,6 +24,7 @@ Early plugins are appropriate when:
- Standard plugin APIs don't provide sufficient access - Standard plugin APIs don't provide sufficient access
**Prefer standard plugins** when possible. Early plugins: **Prefer standard plugins** when possible. Early plugins:
- Are harder to maintain across server updates - Are harder to maintain across server updates
- May conflict with other early plugins - May conflict with other early plugins
- Can introduce hard-to-debug issues - Can introduce hard-to-debug issues
@@ -224,7 +226,7 @@ public int priority() {
``` ```
| Priority | Use Case | | Priority | Use Case |
|----------|----------| |------------|-----------------------------------|
| 1000+ | Critical patches (security fixes) | | 1000+ | Critical patches (security fixes) |
| 100-999 | Core modifications | | 100-999 | Core modifications |
| 0 | Standard transformations | | 0 | Standard transformations |

12
docs/15-ui-system.md
View File

@@ -1,6 +1,7 @@
# UI System # UI System
The Hytale server implements a server-authoritative UI system with two main subsystems: Pages (full-screen UI) and Windows (inventory-style containers). The Hytale server implements a server-authoritative UI system with two main subsystems: Pages (full-screen UI) and
Windows (inventory-style containers).
## Architecture Overview ## Architecture Overview
@@ -20,7 +21,7 @@ UI System
### Core Classes ### Core Classes
| Class | Package | Description | | Class | Package | Description |
|-------|---------|-------------| |------------------------------|---------------------------------------------------------------|-----------------------------------------|
| `CustomUIPage` | `com.hypixel.hytale.server.core.entity.entities.player.pages` | Abstract base for all custom pages | | `CustomUIPage` | `com.hypixel.hytale.server.core.entity.entities.player.pages` | Abstract base for all custom pages |
| `BasicCustomUIPage` | Same | Simple pages without event data parsing | | `BasicCustomUIPage` | Same | Simple pages without event data parsing |
| `InteractiveCustomUIPage<T>` | Same | Pages with typed event handling | | `InteractiveCustomUIPage<T>` | Same | Pages with typed event handling |
@@ -236,6 +237,7 @@ Value<Integer> border = Value.ref("Pages/Dialog.ui", "BorderWidth");
### Encoding Format ### Encoding Format
References are encoded in JSON as: References are encoded in JSON as:
```json ```json
{ {
"$Document": "Common/Button.ui", "$Document": "Common/Button.ui",
@@ -509,7 +511,7 @@ public enum HudComponent {
### Page Packets ### Page Packets
| Packet | ID | Direction | Description | | Packet | ID | Direction | Description |
|--------|-----|-----------|-------------| |-------------------|-----|-----------|-------------------|
| `SetPage` | 216 | S->C | Set built-in page | | `SetPage` | 216 | S->C | Set built-in page |
| `CustomHud` | 217 | S->C | Update HUD | | `CustomHud` | 217 | S->C | Update HUD |
| `CustomPage` | 218 | S->C | Send custom page | | `CustomPage` | 218 | S->C | Send custom page |
@@ -518,7 +520,7 @@ public enum HudComponent {
### Window Packets ### Window Packets
| Packet | ID | Direction | Description | | Packet | ID | Direction | Description |
|--------|-----|-----------|-------------| |--------------------|-----|-----------|----------------|
| `OpenWindow` | 200 | S->C | Open window | | `OpenWindow` | 200 | S->C | Open window |
| `UpdateWindow` | 201 | S->C | Update window | | `UpdateWindow` | 201 | S->C | Update window |
| `CloseWindow` | 202 | S->C | Close window | | `CloseWindow` | 202 | S->C | Close window |
@@ -528,7 +530,7 @@ public enum HudComponent {
## Known UI Documents ## Known UI Documents
| Path | Purpose | | Path | Purpose |
|------|---------| |----------------------------|---------------------|
| `Pages/DialogPage.ui` | Dialog/conversation | | `Pages/DialogPage.ui` | Dialog/conversation |
| `Pages/BarterPage.ui` | Trading interface | | `Pages/BarterPage.ui` | Trading interface |
| `Pages/ShopPage.ui` | Shop interface | | `Pages/ShopPage.ui` | Shop interface |

20
docs/README.md
View File

@@ -1,10 +1,12 @@
# Hytale Server Modding Documentation # Hytale Server Modding Documentation
Welcome to the Hytale Server modding documentation. This guide provides comprehensive information for creating mods and extensions for the Hytale Server. Welcome to the Hytale Server modding documentation. This guide provides comprehensive information for creating mods and
extensions for the Hytale Server.
## LLM Reference ## LLM Reference
**[LLM-Optimized API Reference](00-llm-reference.md)** - Complete API reference with exact class names, method signatures, and JSON structures. Use this for quick lookups. **[LLM-Optimized API Reference](00-llm-reference.md)** - Complete API reference with exact class names, method
signatures, and JSON structures. Use this for quick lookups.
## Documentation Index ## Documentation Index
@@ -46,6 +48,7 @@ Welcome to the Hytale Server modding documentation. This guide provides comprehe
### Creating Your First Mod ### Creating Your First Mod
1. Create a `manifest.json`: 1. Create a `manifest.json`:
```json ```json
{ {
"Group": "com.example", "Group": "com.example",
@@ -56,6 +59,7 @@ Welcome to the Hytale Server modding documentation. This guide provides comprehe
``` ```
2. Create your main class: 2. Create your main class:
```java ```java
public class MyMod extends JavaPlugin { public class MyMod extends JavaPlugin {
public MyMod(JavaPluginInit init) { public MyMod(JavaPluginInit init) {
@@ -86,7 +90,7 @@ NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
### Available Registries ### Available Registries
| Registry | Purpose | | Registry | Purpose |
|----------|---------| |-------------------|-----------------|
| `CommandRegistry` | Custom commands | | `CommandRegistry` | Custom commands |
| `EventRegistry` | Event listeners | | `EventRegistry` | Event listeners |
| `EntityRegistry` | Custom entities | | `EntityRegistry` | Custom entities |
@@ -96,7 +100,7 @@ NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
### Event Priority ### Event Priority
| Priority | Value | Use Case | | Priority | Value | Use Case |
|----------|-------|----------| |----------|--------|--------------------|
| FIRST | -21844 | Monitoring/logging | | FIRST | -21844 | Monitoring/logging |
| EARLY | -10922 | Pre-processing | | EARLY | -10922 | Pre-processing |
| NORMAL | 0 | Standard handling | | NORMAL | 0 | Standard handling |
@@ -120,6 +124,7 @@ com.hypixel.hytale/
## API Highlights ## API Highlights
### Events ### Events
```java ```java
getEventRegistry().register(PlayerConnectEvent.class, event -> { getEventRegistry().register(PlayerConnectEvent.class, event -> {
Player player = event.getPlayer(); Player player = event.getPlayer();
@@ -128,6 +133,7 @@ getEventRegistry().register(PlayerConnectEvent.class, event -> {
``` ```
### Commands ### Commands
```java ```java
public class MyCommand extends AbstractCommand { public class MyCommand extends AbstractCommand {
public MyCommand() { public MyCommand() {
@@ -144,6 +150,7 @@ public class MyCommand extends AbstractCommand {
``` ```
### Entities ### Entities
```java ```java
public class CustomEntity extends Entity { public class CustomEntity extends Entity {
public CustomEntity(World world) { public CustomEntity(World world) {
@@ -156,6 +163,7 @@ getEntityRegistry().register("custom", CustomEntity.class, CustomEntity::new);
``` ```
### Configuration ### Configuration
```java ```java
public static final Codec<MyConfig> CODEC = BuilderCodec.of(MyConfig::new) public static final Codec<MyConfig> CODEC = BuilderCodec.of(MyConfig::new)
.with("enabled", Codec.BOOLEAN, c -> c.enabled, true) .with("enabled", Codec.BOOLEAN, c -> c.enabled, true)
@@ -177,6 +185,7 @@ public static final Codec<MyConfig> CODEC = BuilderCodec.of(MyConfig::new)
## Support ## Support
For questions and support: For questions and support:
- Check the [Hytale modding forums](#) - Check the [Hytale modding forums](#)
- Join the [Discord community](#) - Join the [Discord community](#)
- Report issues on [GitHub](#) - Report issues on [GitHub](#)
@@ -187,4 +196,5 @@ Contributions to this documentation are welcome. Please submit pull requests wit
--- ---
*This documentation is for Hytale Server modding. For official Hytale information, visit [hytale.com](https://hytale.com).* *This documentation is for Hytale Server modding. For official Hytale information,
visit [hytale.com](https://hytale.com).*

3
src/com/hypixel/hytale/server/core/modules/interaction/interaction/config/none/ChangeActiveSlotInteraction.java
View File

@@ -14,6 +14,7 @@ import com.hypixel.hytale.server.core.entity.EntityUtils;
import com.hypixel.hytale.server.core.entity.InteractionContext; import com.hypixel.hytale.server.core.entity.InteractionContext;
import com.hypixel.hytale.server.core.entity.InteractionManager; import com.hypixel.hytale.server.core.entity.InteractionManager;
import com.hypixel.hytale.server.core.entity.LivingEntity; import com.hypixel.hytale.server.core.entity.LivingEntity;
import com.hypixel.hytale.server.core.event.events.ecs.ChangeHotbarSlotEvent;
import com.hypixel.hytale.server.core.meta.DynamicMetaStore; import com.hypixel.hytale.server.core.meta.DynamicMetaStore;
import com.hypixel.hytale.server.core.meta.MetaKey; import com.hypixel.hytale.server.core.meta.MetaKey;
import com.hypixel.hytale.server.core.modules.interaction.interaction.CooldownHandler; import com.hypixel.hytale.server.core.modules.interaction.interaction.CooldownHandler;
@@ -21,7 +22,7 @@ import com.hypixel.hytale.server.core.modules.interaction.interaction.config.Int
import com.hypixel.hytale.server.core.modules.interaction.interaction.config.RootInteraction; import com.hypixel.hytale.server.core.modules.interaction.interaction.config.RootInteraction;
import com.hypixel.hytale.server.core.modules.interaction.interaction.config.data.Collector; import com.hypixel.hytale.server.core.modules.interaction.interaction.config.data.Collector;
import com.hypixel.hytale.server.core.universe.world.storage.EntityStore; import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
import com.hypixel.hytale.server.core.event.events.ecs.ChangeHotbarSlotEvent;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
public class ChangeActiveSlotInteraction extends Interaction { public class ChangeActiveSlotInteraction extends Interaction {