hytale-instances

Manage Hytale instanced worlds via the InstancesPlugin API.

Updated Jan 19, 2026
One-click install
npx skills add https://github.com/Reign-software/hyforged --skill hytale-instances-reign-software
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hytale-instances
Source: https://github.com/Reign-software/hyforged/tree/main/.github/skills/hytale-instances
Command: npx skills add https://github.com/Reign-software/hyforged --skill hytale-instances-reign-software

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide documents how to use Hytale's InstancesPlugin to create, place, and manage instanced worlds, enabling spawning from templates, teleporting players in or out, using return points, and safely removing instances.

Core Features & Use Cases

  • Spawn instanced worlds from templates using spawnInstance and manage their lifecycle within the universe.
  • Teleport players to active or loading instances using dedicated teleport methods.
  • Exit an instance and return to the original world at a defined return point.
  • Safely remove unused or empty instances to free resources.
  • Follow best practices: perform operations inside world.execute(), compute return points with an ISpawnProvider, and use loading-teleport flows to avoid blocking.

Quick Start

Spawn an instance from a template and teleport the player into it.

Frequently Asked Questions about hytale-instances

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I spawn instanced worlds from templates in Hytale?

To spawn instanced worlds from templates in Hytale, use the spawnInstance method within the world.execute() context to safely apply the template and manage the instance lifecycle within the universe.

What is the best way to teleport players into active Hytale instances?

The best way to teleport players into active Hytale instances is using dedicated loading-teleport flows to avoid blocking, ensuring safe execution within the world context during the teleportation process.

How do I return players to their original world after exiting an instance?

To return players to their original world after exiting an instance, compute return points with an ISpawnProvider to define the exact exit location and safely teleport the player back.

Why do I need to use world.execute() for Hytale instance management operations?

You need to use world.execute() for Hytale instance management to ensure world execution context safety, preventing race conditions and maintaining lifecycle integrity during spawning, teleporting, or removing instances.

Can I safely remove empty Hytale instances to free server resources?

Yes, you can safely remove unused or empty Hytale instances to free resources by executing the removal operations within the world context to avoid disrupting active players or loading teleport flows.

Does the Hytale InstancesPlugin support loading-teleport flows to avoid blocking?

Yes, the Hytale InstancesPlugin supports loading-teleport flows as a best practice to avoid blocking, allowing players to teleport to instances that are actively loading without stalling world execution.