Skip to content

JavaScript API Overview

SimpleScripting exposes Hytale server capabilities through safe JavaScript facades. Native classes stay private; mods interact with wrappers that enforce isolation and predictable behavior.

Each wrapper sits on top of a native system:

  • eventscom.hypixel.hytale.event.EventRegistry + event classes
  • commandsCommandRegistry, CommandContext
  • players / PlayerHandlePlayerRef (not exposed directly)
  • worlds / WorldHandleWorld
  • serverHytaleServer, TaskRegistry
  • net → networking helpers (no raw packet APIs)
  • assetsAssetRegistry (limited helper surface)
  • ui → safe message builders (no native Message class)
  • require → module loader for .js files inside a mod
  • SharedServices → cross-mod API bridge
  • db → SQLite database per mod under the SimpleScripting data folder
  • inventory → ItemStack creation, ItemContainerHandle for managing inventories
  • economyExtension API (requires EconomySS plugin) - unified economy interface for VaultUnlocked/EliteEssentials

Each API page lists the wrapper methods, their native counterpart, and usage examples:

You can mix these surfaces freely within a mod. All messaging methods accept plain strings or the ui builders documented below.