World Configs

World configs control the visual appearance of the arena world — the sky tint colour and the environment biome used for lighting and atmosphere — and can optionally execute commands after the world is created. Each config is stored as an individual JSON file inside the mods/arenapvp/worldsConfig/ directory.

The filename (without .json) is the config ID, which templates reference via the WorldConfig property.

File Location

mods/arenapvp/worldsConfig/
  plains.json
  volcano.json
  oasis.json
  bloodmoon.json

Config Structure

{
  "TintR": 108,
  "TintG": 177,
  "TintB": 94,
  "Environment": "Env_Zone1_Forests",
  "Commands": [
    "time 21 --world %world%",
    "weather set Blood_Moon --world %world%"
  ]
}

Fields

Field	Type	Default	Description
TintR	integer	108	Red component of the world tint colour (0–255)
TintG	integer	177	Green component of the world tint colour (0–255)
TintB	integer	94	Blue component of the world tint colour (0–255)
Environment	string	"Env_Zone1_Plains"	Hytale environment ID that controls lighting, fog and atmosphere
Commands	string[]	[]	Commands to execute as console after the world is created

The tint is a flat color applied to specific blocks defined by Hytale, such as grass. The environment determines the biome of the created world. Commands are executed via the console once the world and prefab are ready, before players teleport.

Commands Placeholders

Placeholder	Replaced with
%world%	The name of the created arena world

Known Environment IDs

Environment ID	Description
Env_Zone1_Plains	Zone 1 — green plains, bright daylight
Env_Zone4_Volcanoes	Zone 2 — warm desert, orange-ish light
Env_Zone2_Oasis	Zone 4 — cold boreal, cool blue tones

tip

You can find all available environment IDs by browsing the assets/Server/Environments directory in the official Hytale game assets.

Assigning to a Template

To link a world config to an arena template, add the WorldConfig property to the template JSON. The value must match the filename (without .json) of a file in worldsConfig/.

templates/CastleCTO.json

{
  "WorldConfig": "plains",
  "Prefab": "arena_4-TCTO.prefab",
  "Presets": ["default-kit", "warrior-kit", "archer-kit"],
  "MaxPlayers": 4,
  "Type": "TCTO",
  "TimeLimit": 240,
  "Goal": 3,
  "CarrierSpeedFactor": 0.7
}

• The WorldConfig property is optional. If omitted, the plugin uses the default tint (108, 177, 94) and environment Env_Zone1_Plains.
• Each template can reference at most one world config.

Default Configs

If the worldsConfig/ directory is empty on first launch, three example files are generated automatically.

Creating a Custom World Config

1. Create a new .json file in mods/arenapvp/worldsConfig/:

worldsConfig/bloodmoon.json

{
  "TintR": 160,
  "TintG": 50,
  "TintB": 50,
  "Environment": "Env_Zone1_Plains",
  "Commands": [
    "time 21 --world %world%",
    "weather set Blood_Moon --world %world%"
  ]
}

2. Reference it from any template:

templates/Forest-FFA.json

{
  "WorldConfig": "bloodmoon",
  "Prefab": "arena_bloodforest.prefab",
  "MaxPlayers": 4,
  "Type": "FFA",
  "TimeLimit": 180,
  "Presets": ["default-kit"]
}

3. Run /arena reload to load the changes without restarting the server.

info

Multiple templates can share the same world config. For example, all your desert-themed maps can reference "WorldConfig": "bloodmoon".