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

42
docs/README.md
View File

@@ -1,10 +1,12 @@
# 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-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
@@ -46,6 +48,7 @@ Welcome to the Hytale Server modding documentation. This guide provides comprehe
### Creating Your First Mod
1. Create a `manifest.json`:
```json
{
"Group": "com.example",
@@ -56,6 +59,7 @@ Welcome to the Hytale Server modding documentation. This guide provides comprehe
```
2. Create your main class:
```java
public class MyMod extends JavaPlugin {
public MyMod(JavaPluginInit init) {
@@ -85,23 +89,23 @@ NONE -> SETUP -> START -> ENABLED -> SHUTDOWN -> DISABLED
### Available Registries
| Registry | Purpose |
|----------|---------|
| Registry | Purpose |
|-------------------|-----------------|
| `CommandRegistry` | Custom commands |
| `EventRegistry` | Event listeners |
| `EntityRegistry` | Custom entities |
| `AssetRegistry` | Custom assets |
| `TaskRegistry` | Scheduled tasks |
| `EventRegistry` | Event listeners |
| `EntityRegistry` | Custom entities |
| `AssetRegistry` | Custom assets |
| `TaskRegistry` | Scheduled tasks |
### Event Priority
| Priority | Value | Use Case |
|----------|-------|----------|
| FIRST | -21844 | Monitoring/logging |
| EARLY | -10922 | Pre-processing |
| NORMAL | 0 | Standard handling |
| LATE | 10922 | Post-processing |
| LAST | 21844 | Final processing |
| Priority | Value | Use Case |
|----------|--------|--------------------|
| FIRST | -21844 | Monitoring/logging |
| EARLY | -10922 | Pre-processing |
| NORMAL | 0 | Standard handling |
| LATE | 10922 | Post-processing |
| LAST | 21844 | Final processing |
## Package Structure
@@ -120,6 +124,7 @@ com.hypixel.hytale/
## API Highlights
### Events
```java
getEventRegistry().register(PlayerConnectEvent.class, event -> {
Player player = event.getPlayer();
@@ -128,6 +133,7 @@ getEventRegistry().register(PlayerConnectEvent.class, event -> {
```
### Commands
```java
public class MyCommand extends AbstractCommand {
public MyCommand() {
@@ -144,6 +150,7 @@ public class MyCommand extends AbstractCommand {
```
### Entities
```java
public class CustomEntity extends Entity {
public CustomEntity(World world) {
@@ -156,6 +163,7 @@ getEntityRegistry().register("custom", CustomEntity.class, CustomEntity::new);
```
### Configuration
```java
public static final Codec<MyConfig> CODEC = BuilderCodec.of(MyConfig::new)
.with("enabled", Codec.BOOLEAN, c -> c.enabled, true)
@@ -177,6 +185,7 @@ public static final Codec<MyConfig> CODEC = BuilderCodec.of(MyConfig::new)
## Support
For questions and support:
- Check the [Hytale modding forums](#)
- Join the [Discord community](#)
- 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).*