HyJS - Scripting for Hytale

Unlock the true potential of your Hytale server with HyJS, the ultimate scripting solution inspired by the legendary KubeJS. Whether you're a server owner looking to add custom features or a mod developer wanting to leverage the power of JavaScript/TypeScript, HyJS has you covered!

✨ Features at a Glance

📜 Modern Scripting: Full support for JavaScript and TypeScript.
⚡ High Performance: TypeScript is transpiled on-the-fly with lightning-fast Sucrase.
🛠️ Developer Friendly: Built-in ProbeJS functionality! Generate .d.ts files for your favorite IDE (VS Code, IntelliJ) and enjoy full autocompletion.
📦 Mod Integration: Bundle scripts directly inside your .zip or .jar mods. Perfect for adding custom logic to your Hytale content.
🎮 Deep Game Access:
- Event System: Hook into player, block, world, and entity events.
- Command API: Create complex commands with arguments and permissions in seconds.
- ECS Systems: Integrate directly with Hytale's Entity Component System.
- Persistent Data: Save global data that stays even after a server restart.
🔝 Priority Loading: Fine-grained control over which scripts load first.
⚡ Hot Reload: Use the /hyjs reload command to easily refresh all your scripts.

🚀 Getting Started

Simply drop HyJS into your mods folder and start your server. HyJS will automatically create the necessary folders for your scripts.

Script Folders:

Pandaismyname1_HyJS/scripts/startup: For early initialization logic.
Pandaismyname1_HyJS/scripts/server: For your main game logic and events.

Pro Tip: Run /hyjs generate in-game to get full TypeScript definitions for the Hytale API!

🤝 Community & Documentation

Join the revolution of Hytale scripting! HyJS makes modding accessible and powerful. Check out our Gitlab for documentation and examples.

HyJS is not an official Hytale product. It is a community-made mod for the Hytale server.