56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
## ⚠️ Please note that documentation is currently not maintained! If you wish to contribute, please open a ticket on our discord so that an account on this gitea can be created for you.
|
|
|
|
# Hytale Plugin Documentation
|
|
|
|
Comprehensive documentation for Hytale server plugin development.
|
|
|
|
## Access the documentation
|
|
|
|
**https://doc.hytaledev.fr/**
|
|
|
|
## Versioning
|
|
|
|
Documentation versions follow this format:
|
|
```
|
|
v{DOC_VERSION}-HY#{HYTALE_DATE}-{HYTALE_BUILD}
|
|
```
|
|
|
|
Example: `v0.0.1-HY#2026.01.13-dcad8778f`
|
|
|
|
| Part | Description |
|
|
|------|-------------|
|
|
| `v0.0.1` | Documentation version (semantic versioning) |
|
|
| `HY#2026.01.13` | Hytale server version date |
|
|
| `dcad8778f` | Hytale build hash |
|
|
|
|
This ensures documentation is always tied to a specific Hytale server version.
|
|
|
|
## Content
|
|
|
|
The documentation covers all aspects of plugin development:
|
|
|
|
- **Getting Started** - Set up your environment and create your first plugin
|
|
- **Core Concepts** - Registries, assets, codecs and threading
|
|
- **Commands** - Create custom commands with arguments
|
|
- **Events** - Event system and listeners
|
|
- **Entities** - Entities, players and ECS system
|
|
- **World** - Universes, worlds, chunks and blocks
|
|
- **Inventory** - Items, inventories and containers
|
|
- **Tasks** - Scheduled and asynchronous tasks
|
|
- **Effects** - Particles, dynamic lights and entity effects
|
|
- **Reference** - API reference and manifest schema
|
|
|
|
## Languages
|
|
|
|
Documentation is available in:
|
|
- English
|
|
- Français
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Feel free to open an issue or pull request.
|
|
|
|
## License
|
|
|
|
This project is maintained by the Hytale France community.
|