Scripting

Scripting Hub

Welcome to the JustHostMC Lua Scripting guide.

JustHostMC uses sandboxed Lua scripts as the primary extension point for integrating new Server Types (Providers) and for orchestrating background tasks (Automation).

Because scripts run inside the engine, they are heavily sandboxed and can only interact with the operating system through a strict, permission-gated API.

Please choose a subcategory below to explore the documentation:

1. Architecture & Execution Model

Learn about the gopher-lua sandbox, the execution model, and how the returned launch specs tie into the underlying isolation and container mechanisms (Windows Job Objects / Docker).

2. Provider Scripts

Learn how to define a Server Provider. Details the meta object, the versions() method, and the install(ctx) method which returns the launch specification.

3. Automation Scripts

Learn how to drive running servers. Details lifecycle hooks (on_log, on_start, on_stop, schedule) and the server.* control API.

4. The Host API (jhmc.*)

Comprehensive documentation on the jhmc.* table exposed to scripts. Includes Network, Filesystem, and Process/Java functions.

5. Permissions & Consent

Details the 7 required permission kinds and explains the security consent model for user-imported scripts vs. built-in scripts.

6. Complete Examples

See complete, copy-pasteable examples for both Provider and Automation scripts.