An unofficial community-maintained documentation site for Hytale modding.
This project provides comprehensive guides, documentation, and resources for modding Hytale - a voxel-based sandbox RPG game built from the ground up with modding and user-generated content at its core.
Hytale is designed with a server-first modding approach, allowing anyone to create and share mods without requiring players to download external client modifications. Whether you're interested in:
- Server Plugins - Java-based programming for deep gameplay modifications
- Data Assets - JSON-driven content like blocks, items, NPCs, and world generation
- Art Assets - Custom models, textures, and sounds using Blockbench
- Visual Scripting - Node-based logic for designers and non-programmers
This documentation aims to help you get started and master Hytale modding.
- Node.js 18.x or higher
- Bun package manager
If you don't have Bun installed, you can install it globally using npm:
npm install -g bunAlternatively, visit bun.sh for other installation methods.
- Create a fork of the repository
- Clone that repository & change your directory into it.
git clone https://github.com/<you>/<fork repo name>.git
cd <fork repo name>- Install dependencies:
bun install- Run the development server:
bun run dev- Open http://localhost:3000 in your browser to view the site.
bun run dev- Start the development serverbun run build- Build the production applicationbun start- Run the production serverbun run types:check- Validate TypeScript types and MDX filesbun run lint- Run ESLint for code quality