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

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

@@ -2,21 +2,22 @@
## 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
The server is built on several core systems:
| System | Purpose |
|--------|---------|
| Plugin System | Mod loading, lifecycle management, and dependency resolution |
| System | Purpose |
|-------------------------------|----------------------------------------------------------------|
| Plugin System | Mod loading, lifecycle management, and dependency resolution |
| Entity Component System (ECS) | High-performance entity management with components and systems |
| Event System | Prioritized event dispatching with sync/async support |
| Command System | Player and console command handling |
| Asset System | Game asset loading and registration |
| Codec System | Data serialization/deserialization framework |
| Protocol Layer | Network communication and packet handling |
| Event System | Prioritized event dispatching with sync/async support |
| Command System | Player and console command handling |
| Asset System | Game asset loading and registration |
| Codec System | Data serialization/deserialization framework |
| Protocol Layer | Network communication and packet handling |
## Package Structure
@@ -121,17 +122,17 @@ Plugins go through the following states:
Your plugin has access to several registries for registration:
| Registry | Access Method | Purpose |
|----------|---------------|---------|
| CommandRegistry | `getCommandRegistry()` | Register custom commands |
| EventRegistry | `getEventRegistry()` | Register event listeners |
| EntityRegistry | `getEntityRegistry()` | Register custom entity types |
| BlockStateRegistry | `getBlockStateRegistry()` | Register block states |
| TaskRegistry | `getTaskRegistry()` | Schedule recurring tasks |
| AssetRegistry | `getAssetRegistry()` | Register custom asset types |
| Registry | Access Method | Purpose |
|-----------------------|------------------------------|-------------------------------|
| CommandRegistry | `getCommandRegistry()` | Register custom commands |
| EventRegistry | `getEventRegistry()` | Register event listeners |
| EntityRegistry | `getEntityRegistry()` | Register custom entity types |
| BlockStateRegistry | `getBlockStateRegistry()` | Register block states |
| TaskRegistry | `getTaskRegistry()` | Schedule recurring tasks |
| AssetRegistry | `getAssetRegistry()` | Register custom asset types |
| ClientFeatureRegistry | `getClientFeatureRegistry()` | Register client-side features |
| EntityStoreRegistry | `getEntityStoreRegistry()` | Register ECS entity stores |
| ChunkStoreRegistry | `getChunkStoreRegistry()` | Register chunk data stores |
| EntityStoreRegistry | `getEntityStoreRegistry()` | Register ECS entity stores |
| ChunkStoreRegistry | `getChunkStoreRegistry()` | Register chunk data stores |
## Next Steps