Hytale Commands

https://www.hytalecommands.com
Admin
Hytale Commands is a comprehensive reference and toolset for every console command and parameter in...
Tokens:18,780
Snippets:72
Trust Score:3.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Prefab Spawner Properties

Source: https://www.hytalecommands.com/prefabspawner

Retrieves and prints the properties of the target prefab spawner block.

```APIDOC
## GET /prefabspawner/get

### Description
Retrieves and prints the properties of the target prefab spawner block.

### Method
GET

### Endpoint
`/prefabspawner get`

### Parameters
This command does not take any parameters.

### Response
#### Success Response (200)
- **message** (string) - A message containing the properties of the prefab spawner.

#### Response Example
```json
{
  "message": "- FitHeightmap = true\n- InheritSeed = false\n- InheritHeightCheck = true\n- DefaultWeight: 1.0\n- PrefabWeights: { \"prefab1.path\": 2.0 }"
}
```
```

--------------------------------

### /sleepoffset

Source: https://www.hytalecommands.com/sleepoffset

Get or set the sleep offset value and its percentage representation.

```APIDOC
## GET /sleepoffset

### Description
Retrieves the current sleep offset value.

### Method
GET

### Endpoint
/sleepoffset

### Parameters
#### Query Parameters
- **value** (string) - Optional - Specifies whether to retrieve the offset as a raw value or percentage. Accepts 'percent' or 'offset'.

### Response
#### Success Response (200)
- **value** (string) - The current sleep offset value or percentage.

#### Response Example
```json
{
  "value": "10%"
}
```

## POST /sleepoffset

### Description
Sets the sleep offset value or its percentage representation.

### Method
POST

### Endpoint
/sleepoffset

### Parameters
#### Request Body
- **offset** (number) - Optional - The sleep offset value to set.
- **percent** (string) - Optional - Show/set as percentage. Accepts a string representing the percentage.

### Request Example
```json
{
  "offset": 15
}
```
```json
{
  "percent": "25%"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the sleep offset has been updated.

#### Response Example
```json
{
  "message": "Set sleep offset: 15 (was 10)"
}
```
```

--------------------------------

### World Config Commands

Source: https://www.hytalecommands.com/world

Commands for configuring world settings.

```APIDOC
## POST /world config.setspawn

### Description
Sets the spawn point of a world.

### Method
POST

### Endpoint
/world config.setspawn

### Parameters
#### Request Body
- **position** (object) - Required - The position to set as the spawn point.
  - **x** (number) - The x-coordinate.
  - **y** (number) - The y-coordinate.
  - **z** (number) - The z-coordinate.

### Request Example
```json
{
  "example": "/world config.setspawn position:{x: 10, y: 64, z: 20}"
}
```

### Response
#### Success Response (200)
Indicates that the spawn point has been successfully set.

#### Response Example
```json
{
  "example": "Spawn point set successfully."
}
```

## POST /world config.setspawn.default

### Description
Sets the spawn point to the default location.

### Method
POST

### Endpoint
/world config.setspawn.default

### Response
#### Success Response (200)
Indicates that the spawn point has been reset to default.

#### Response Example
```json
{
  "example": "Default spawn point set."
}
```

## POST /world config.setspawn.rotation

### Description
Sets the rotation for the spawn point.

### Method
POST

### Endpoint
/world config.setspawn.rotation

### Parameters
#### Query Parameters
- **default** (string) - Required - The forward direction for the rotation (e.g., 'north', 'south', 'east', 'west').

### Response
#### Success Response (200)
Indicates that the spawn rotation has been successfully set.

#### Response Example
```json
{
  "example": "Spawn rotation set successfully."
}
```
```

--------------------------------

### World Settings Commands

Source: https://www.hytalecommands.com/world

Commands for managing various world settings.

```APIDOC
## GET/POST /world settings.blockticking

### Description
Gets or sets whether the world is ticking blocks.

### Method
GET/POST

### Endpoint
/world settings.blockticking

### Parameters
#### Query Parameters (for POST)
- **value** (boolean) - Optional - Set to true to enable block ticking, false to disable.

### Response
#### Success Response (200)
Returns the current block ticking status or confirms the setting change.

#### Response Example
```json
{
  "example": "Block ticking is currently enabled."
}
```

## POST /world settings.box2d.default

### Description
Sets the 2D bounding box settings to their default values.

### Method
POST

### Endpoint
/world settings.box2d.default

### Response
#### Success Response (200)
Indicates that the 2D bounding box settings have been reset to default.

#### Response Example
```json
{
  "example": "2D bounding box settings reset to default."
}
```

## GET/POST /world settings.chunkSaving

### Description
Disables or enables the saving of chunks.

### Method
GET/POST

### Endpoint
/world settings.chunkSaving

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable chunk saving, false to disable.

### Response
#### Success Response (200)
Returns the current chunk saving status or confirms the setting change.

#### Response Example
```json
{
  "example": "Chunk saving is currently enabled."
}
```

## GET/POST /world settings.chunkUnload

### Description
Disables or enables the unloading of chunks.

### Method
GET/POST

### Endpoint
/world settings.chunkUnload

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable chunk unloading, false to disable.

### Response
#### Success Response (200)
Returns the current chunk unloading status or confirms the setting change.

#### Response Example
```json
{
  "example": "Chunk unloading is currently enabled."
}
```

## GET/POST /world settings.chunkstoragetype

### Description
Gets or sets the chunk storage type.

### Method
GET/POST

### Endpoint
/world settings.chunkstoragetype

### Parameters
#### Query Parameters (for POST)
- **type** (string) - Optional - The chunk storage type (e.g., 'standard', 'compressed').

### Response
#### Success Response (200)
Returns the current chunk storage type or confirms the setting change.

#### Response Example
```json
{
  "example": "Current chunk storage type: standard"
}
```

## GET/POST /world settings.compassupdating

### Description
Disables or enables compass updating in a world.

### Method
GET/POST

### Endpoint
/world settings.compassupdating

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable compass updating, false to disable.

### Response
#### Success Response (200)
Returns the current compass updating status or confirms the setting change.

#### Response Example
```json
{
  "example": "Compass updating is currently enabled."
}
```

## GET/POST /world settings.creativemode

### Description
Enables or disables creative mode for this world.

### Method
GET/POST

### Endpoint
/world settings.creativemode

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable creative mode, false to disable.

### Response
#### Success Response (200)
Returns the current creative mode status or confirms the setting change.

#### Response Example
```json
{
  "example": "Creative mode is currently enabled."
}
```

## GET/POST /world settings.daylightportion

### Description
Gets or sets the portion of the day that will be daylight.

### Method
GET/POST

### Endpoint
/world settings.daylightportion

### Parameters
#### Query Parameters (for POST)
- **portion** (number) - Optional - The portion of the day (0.0 to 1.0).

### Response
#### Success Response (200)
Returns the current daylight portion or confirms the setting change.

#### Response Example
```json
{
  "example": "Daylight portion is currently 0.5."
}
```

## GET/POST /world settings.freezeallnpcs

### Description
Gets or sets whether all NPCs in this world will be in a frozen state.

### Method
GET/POST

### Endpoint
/world settings.freezeallnpcs

### Parameters
#### Query Parameters (for POST)
- **frozen** (boolean) - Optional - Set to true to freeze all NPCs, false to unfreeze.

### Response
#### Success Response (200)
Returns the current NPC freeze status or confirms the setting change.

#### Response Example
```json
{
  "example": "All NPCs are currently frozen."
}
```

## GET/POST /world settings.gamemode

### Description
Sets the default GameMode for the world.

### Method
GET/POST

### Endpoint
/world settings.gamemode

### Parameters
#### Query Parameters (for POST)
- **mode** (string) - Optional - The GameMode to set (e.g., 'survival', 'creative', 'adventure').

### Response
#### Success Response (200)
Returns the current default GameMode or confirms the setting change.

#### Response Example
```json
{
  "example": "Default GameMode is set to survival."
}
```

## GET/POST /world settings.gameplayconfig

### Description
Gets or sets the GameplayConfig Id for the world.

### Method
GET/POST

### Endpoint
/world settings.gameplayconfig

### Parameters
#### Query Parameters (for POST)
- **id** (string) - Optional - The ID of the GameplayConfig.

### Response
#### Success Response (200)
Returns the current GameplayConfig Id or confirms the setting change.

#### Response Example
```json
{
  "example": "GameplayConfig Id is set to 'default_config'."
}
```

## GET/POST /world settings.keeploaded

### Description
Sets a region of chunks that will not unload automatically.

### Method
GET/POST

### Endpoint
/world settings.keeploaded

### Parameters
#### Query Parameters (for POST)
- **region** (string) - Optional - Defines the region of chunks to keep loaded (format may vary).

### Response
#### Success Response (200)
Confirms that the keep-loaded region has been set.

#### Response Example
```json
{
  "example": "Keep-loaded region set."
}
```

## GET/POST /world settings.playersaving

### Description
Disables or enables the saving of player data.

### Method
GET/POST

### Endpoint
/world settings.playersaving

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable player saving, false to disable.

### Response
#### Success Response (200)
Returns the current player saving status or confirms the setting change.

#### Response Example
```json
{
  "example": "Player data saving is currently enabled."
}
```

## GET/POST /world settings.pregenerate

### Description
Sets a region of chunks that will be pre-generated on the world's startup.

### Method
GET/POST

### Endpoint
/world settings.pregenerate

### Parameters
#### Query Parameters (for POST)
- **region** (string) - Optional - Defines the region of chunks to pre-generate (format may vary).

### Response
#### Success Response (200)
Confirms that the pre-generation region has been set.

#### Response Example
```json
{
  "example": "Pregeneration region set."
}
```

## GET/POST /world settings.pvp

### Description
Gets or sets whether PvP is enabled in the world.

### Method
GET/POST

### Endpoint
/world settings.pvp

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable PvP, false to disable.

### Response
#### Success Response (200)
Returns the current PvP status or confirms the setting change.

#### Response Example
```json
{
  "example": "PvP is currently enabled."
}
```

## GET/POST /world settings.sanctuaryradius

### Description
Gets or sets the NPC spawning sanctuary radius in the world.

### Method
GET/POST

### Endpoint
/world settings.sanctuaryradius

### Parameters
#### Query Parameters (for POST)
- **radius** (number) - Optional - The sanctuary radius value.

### Response
#### Success Response (200)
Returns the current sanctuary radius or confirms the setting change.

#### Response Example
```json
{
  "example": "Sanctuary radius is set to 10."
}
```

## GET/POST /world settings.secondspergameday

### Description
Gets or sets the number of real-time seconds that constitute one in-game day.

### Method
GET/POST

### Endpoint
/world settings.secondspergameday

### Parameters
#### Query Parameters (for POST)
- **seconds** (number) - Optional - The number of real-time seconds per game day.

### Response
#### Success Response (200)
Returns the current seconds per game day or confirms the setting change.

#### Response Example
```json
{
  "example": "Seconds per game day is set to 720."
}
```

## GET/POST /world settings.spawningnpc

### Description
Gets or sets whether NPCs are spawning in the world.

### Method
GET/POST

### Endpoint
/world settings.spawningnpc

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable NPC spawning, false to disable.

### Response
#### Success Response (200)
Returns the current NPC spawning status or confirms the setting change.

#### Response Example
```json
{
  "example": "NPC spawning is currently enabled."
}
```

## GET/POST /world settings.spawnmarkers

### Description
Gets or sets whether spawn markers are spawning NPCs in the world.

### Method
GET/POST

### Endpoint
/world settings.spawnmarkers

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable spawn markers for NPCs, false to disable.

### Response
#### Success Response (200)
Returns the current spawn marker status or confirms the setting change.

#### Response Example
```json
{
  "example": "Spawn markers for NPCs are currently enabled."
}
```

## GET/POST /world settings.ticking

### Description
Gets or sets whether the world is ticking.

### Method
GET/POST

### Endpoint
/world settings.ticking

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable ticking, false to disable.

### Response
#### Success Response (200)
Returns the current ticking status or confirms the setting change.

#### Response Example
```json
{
  "example": "World ticking is currently enabled."
}
```

## GET/POST /world settings.timepaused

### Description
Gets or sets whether time is paused in the world.

### Method
GET/POST

### Endpoint
/world settings.timepaused

### Parameters
#### Query Parameters (for POST)
- **paused** (boolean) - Optional - Set to true to pause time, false to unpause.

### Response
#### Success Response (200)
Returns the current time pause status or confirms the setting change.

#### Response Example
```json
{
  "example": "Time is currently paused."
}
```

## GET/POST /world settings.toggle

### Description
Disables or enables the saving of world chunks.

### Method
GET/POST

### Endpoint
/world settings.toggle

### Parameters
#### Query Parameters (for POST)
- **enabled** (boolean) - Optional - Set to true to enable chunk saving, false to disable.

### Response
#### Success Response (200)
Returns the current chunk saving status or confirms the setting change.

#### Response Example
```json
{
  "example": "Chunk saving is currently enabled."
}
```

## GET/POST /world settings.totalmoonphases

### Description
Gets or sets the total number of moon phases.

### Method
GET/POST

### Endpoint
/world settings.totalmoonphases

### Parameters
#### Query Parameters (for POST)
- **phases** (integer) - Optional - The total number of moon phases.

### Response
#### Success Response (200)
Returns the current total moon phases or confirms the setting change.

#### Response Example
```json
{
  "example": "Total moon phases is set to 8."
}
```

## GET/POST /world settings.worldgentype

### Description
Gets or sets the world generation type.

### Method
GET/POST

### Endpoint
/world settings.worldgentype

### Parameters
#### Query Parameters (for POST)
- **type** (string) - Optional - The world generation type (e.g., 'default', 'flat').

### Response
#### Success Response (200)
Returns the current world generation type or confirms the setting change.

#### Response Example
```json
{
  "example": "World generation type is set to default."
}
```

## GET/POST /world settings.worldmapdisabled

### Description
Disables or enables the WorldMap in a world.

### Method
GET/POST

### Endpoint
/world settings.worldmapdisabled

### Parameters
#### Query Parameters (for POST)
- **disabled** (boolean) - Optional - Set to true to disable the WorldMap, false to enable.

### Response
#### Success Response (200)
Returns the current WorldMap status or confirms the setting change.

#### Response Example
```json
{
  "example": "WorldMap is currently disabled."
}
```
```

--------------------------------

### /editline - Draw a line of blocks

Source: https://www.hytalecommands.com/editline

Draws a line of blocks between a specified start and end point, with options for material, dimensions, shape, and block placement density.

```APIDOC
## POST /websites/hytalecommands/editline

### Description
Draw a line of blocks between two points with specified material and optional dimensions, shape, and density.

### Method
POST

### Endpoint
/websites/hytalecommands/editline

### Parameters
#### Query Parameters
- **start** (position) - Required - Start position (x y z, supports ~ for relative)
- **end** (position) - Required - End position (x y z, supports ~ for relative)
- **material** (blockType) - Required - Block material pattern (e.g. Rock_Stone or Rock_Stone,Soil_Grass)
- **width** (number) - Optional - Line width (default: 1)
- **height** (number) - Optional - Line height (default: 1)
- **shape** (string) - Optional - Line shape (Cube, Sphere, Cylinder, Cone, etc.)
- **origin** (string) - Optional - Shape origin point (Center, Bottom, Top)
- **spacing** (number) - Optional - Block interval along the line (default: 1)
- **density** (integer) - Optional - Random chance (1-100) that each block is placed (default: 100)

### Request Example
```json
{
  "start": "10 64 20",
  "end": "30 70 40",
  "material": "Rock_Stone",
  "width": 2,
  "height": 3,
  "shape": "Cylinder",
  "origin": "Center",
  "spacing": 1,
  "density": 80
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the line was drawn.

#### Response Example
```json
{
  "message": "Line successfully drawn from start to end."
}
```
```

--------------------------------

### Population and Statistics

Source: https://www.hytalecommands.com/spawning

Commands for repopulating NPCs and viewing spawning statistics.

```APIDOC
## POST /spawning/populate

### Description
Remove all NPCs and repopulate the world. This command resets the NPC population based on current configurations.

### Method
POST

### Endpoint
/spawning/populate

### Parameters
#### Query Parameters
- **environment** (string) - Optional - The environment to populate (optional, defaults to all)
```

```APIDOC
## GET /spawning/stats

### Description
Print statistics about NPC spawning and population. This command provides insights into the current spawning status and population counts.

### Method
GET

### Endpoint
/spawning/stats

### Parameters
#### Query Parameters
- **environments** (string) - Optional - Show environment statistics
- **markers** (string) - Optional - Show marker statistics
- **verbose** (string) - Optional - Show verbose statistics
```

--------------------------------

### Beacon Management

Source: https://www.hytalecommands.com/spawning

Commands for managing spawn beacons, including adding new beacons and triggering manual spawns.

```APIDOC
## POST /spawning/beacons/add

### Description
Add a spawn beacon to the world. This command allows specifying the beacon type and optionally setting it to manual trigger.

### Method
POST

### Endpoint
/spawning/beacons/add

### Parameters
#### Query Parameters
- **beacon** (string) - Required - The beacon NPC spawn definition
- **manual** (boolean) - Optional - Set this beacon to be a manual type (defaults to false)
```

```APIDOC
## POST /spawning/beacons/trigger

### Description
Trigger a manual type spawn beacon. This command is used to initiate a spawn from a beacon that is set to manual trigger.

### Method
POST

### Endpoint
/spawning/beacons/trigger

### Parameters
#### Query Parameters
- **beacon** (string) - Required - The beacon ID to trigger
```

--------------------------------

### /inventorybackpack

Source: https://www.hytalecommands.com/inventorybackpack

Allows players to view and resize their in-game backpack. The size parameter is optional.

```APIDOC
## POST /inventorybackpack

### Description
Allows players to view and resize their in-game backpack. The size parameter is optional.

### Method
POST

### Endpoint
/inventorybackpack

### Parameters
#### Query Parameters
- **size** (string) - Optional - The new backpack size

### Request Example
```json
{
  "size": "10"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the backpack has been resized or viewed.

#### Response Example
```json
{
  "message": "Backpack size updated to 10."
}
```
```

--------------------------------

### World Performance Commands

Source: https://www.hytalecommands.com/world

Commands for monitoring and managing world performance metrics.

```APIDOC
## GET /world perf

### Description
Displays performance metrics (TPS) for a world.

### Method
GET

### Endpoint
/world perf

### Response
#### Success Response (200)
Returns the current TPS for the world.

#### Response Example
```json
{
  "example": "Current TPS: 20.0"
}
```

## GET /world perf.all

### Description
Shows delta values in addition to TPS for performance metrics.

### Method
GET

### Endpoint
/world perf.all

### Response
#### Success Response (200)
Returns TPS and delta values for the world.

#### Response Example
```json
{
  "example": "TPS: 20.0, Delta: 50ms"
}
```

## GET /world perf.delta

### Description
Shows delta values instead of TPS for performance metrics.

### Method
GET

### Endpoint
/world perf.delta

### Response
#### Success Response (200)
Returns delta values for the world.

#### Response Example
```json
{
  "example": "Delta: 50ms"
}
```

## GET /world perf.graph

### Description
Displays a graph of TPS over time.

### Method
GET

### Endpoint
/world perf.graph

### Parameters
#### Query Parameters
- **height** (integer) - Optional - The height of the graph.
- **width** (integer) - Optional - The width of the graph.

### Response
#### Success Response (200)
Returns a representation of the TPS graph (e.g., ASCII art or a URL to an image).

#### Response Example
```json
{
  "example": "[TPS Graph Representation]"
}
```

## POST /world perf.reset

### Description
Resets performance metrics for all worlds.

### Method
POST

### Endpoint
/world perf.reset

### Response
#### Success Response (200)
Indicates that performance metrics have been reset.

#### Response Example
```json
{
  "example": "Performance metrics reset for all worlds."
}
```

## POST /world perf.reset.specific

### Description
Resets performance metrics for a specific world.

### Method
POST

### Endpoint
/world perf.reset.specific

### Parameters
#### Query Parameters
- **worldName** (string) - Required - The name of the world for which to reset metrics.

### Response
#### Success Response (200)
Indicates that performance metrics have been reset for the specified world.

#### Response Example
```json
{
  "example": "Performance metrics reset for world 'MyWorld'."
}
```
```

--------------------------------

### /give Command

Source: https://www.hytalecommands.com/give

Grants a specified item to the player executing the command, with optional quantity and metadata.

```APIDOC
## POST /give

### Description
Gives an item to the player executing the command.

### Method
POST

### Endpoint
/give

### Parameters
#### Query Parameters
- **item** (string) - Required - The item to give.
- **quantity** (integer) - Optional - The quantity of items to give. Defaults to 1.
- **metadata** (string) - Optional - Item metadata as a JSON string.

### Request Example
```json
{
  "item": "Armor Bronze Chest",
  "quantity": 5,
  "metadata": "{\"enchantment\": \"sharpness\", \"level\": 3}"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the item was given.

#### Response Example
```json
{
  "message": "You received 5 of Armor Bronze Chest"
}
```

#### Error Responses
- **unableToFind** (string) - Unable to find item or block "{itemId}".
- **insufficientInvSpace** (string) - Unable to give {quantity} of {item}; insufficient inventory space.
- **invalidMetadata** (string) - Invalid metadata format: {error}.
```

--------------------------------

### /settimeandgohome

Source: https://www.hytalecommands.com/settimeandgohome

Sets the time of day in the world and teleports the user to a specified world.

```APIDOC
## /settimeandgome

### Description
Sets the time of day and teleports the user to a specified world.

### Method
POST

### Endpoint
/websites/hytalecommands/settimeandgohome

### Parameters
#### Query Parameters
- **timeOfDay** (Integer) - Required - The time of day to set the world to.
- **world** (String) - Optional - The world to teleport to. Defaults to 'Default'.

### Request Example
```json
{
  "timeOfDay": 12000,
  "world": "MyAwesomeWorld"
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message indicating the time was set and the user was teleported.

#### Response Example
```json
{
  "message": "Time set to 12000 and teleported to MyAwesomeWorld."
}
```
```

--------------------------------

### /sound command

Source: https://www.hytalecommands.com/sound

This command allows you to play sound events in the game. You can specify whether the sound is 2D or 3D, and optionally set a category.

```APIDOC
## POST /sound

### Description
Play a sound event in the game. Supports 2D and 3D sound playback with optional category specification.

### Method
POST

### Endpoint
`/sound`

### Parameters
#### Query Parameters
- **2d** (string) - Optional - Play a 2D sound event.
- **3d** (string) - Optional - Play a 3D sound event at a specific position.
- **category** (number) - Optional - The sound category (SFX, Music, etc.). Defaults to SFX.

### Request Example
```json
{
  "command": "/sound",
  "parameters": {
    "soundId": "some_sound_id",
    "category": "SFX"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the sound was played or an error occurred.

#### Response Example
```json
{
  "message": "Sound 'some_sound_id' played successfully."
}
```

### Server Messages
- **notfound**: Sound not found: {soundid}
- **invalidCategory**: Invalid sound category '{category}'. Valid categories are: {validCategories}
```

--------------------------------

### /copy Command

Source: https://www.hytalecommands.com/copy

Copies the contents of a selection in the Hytale world to the clipboard, allowing for pasting later. Supports various options to customize the copy operation.

```APIDOC
## POST /websites/hytalecommands/copy

### Description
Copies the contents of your selection in the world, storing them in your clipboard to paste.

### Method
POST

### Endpoint
/websites/hytalecommands/copy

### Parameters
#### Query Parameters
- **--entitiesonly** (boolean) - Optional - Copy only entities (no blocks)
- **--empty** (boolean) - Optional - Include empty blocks in the copy
- **--keepanchors** (boolean) - Optional - Keep anchor blocks in the copy
- **noEntities** (boolean) - Optional - Exclude entities from the copy (entities are included by default)
- **entitiesonly** (boolean) - Optional - Copy only entities (no blocks)
- **empty** (boolean) - Optional - Include empty blocks in the copy
- **keepanchors** (boolean) - Optional - Keep anchor blocks in the copy
- **xMin** (number) - Optional - The minimum X coordinate
- **yMin** (number) - Optional - The minimum Y coordinate
- **zMin** (number) - Optional - The minimum Z coordinate
- **xMax** (number) - Optional - The maximum X coordinate
- **yMax** (number) - Optional - The maximum Y coordinate
- **zMax** (number) - Optional - The maximum Z coordinate

### Request Example
```json
{
  "command": "/copy",
  "parameters": {
    "--entitiesonly": true,
    "xMin": 0,
    "yMin": 0,
    "zMin": 0,
    "xMax": 10,
    "yMax": 10,
    "zMax": 10
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the copy operation was successful.

#### Response Example
```json
{
  "message": "Selection copied to clipboard."
}
```
```

--------------------------------

### /loadworld - Load World

Source: https://www.hytalecommands.com/loadworld

Loads an existing world by its name. This command is essential for accessing and continuing gameplay in previously created worlds.

```APIDOC
## POST /websites/hytalecommands/loadworld

### Description
Loads an existing world by its name. This command is essential for accessing and continuing gameplay in previously created worlds.

### Method
POST

### Endpoint
/websites/hytalecommands/loadworld

### Parameters
#### Query Parameters
- **name** (string) - Optional - The name of the world to load

### Request Example
```json
{
  "name": "MyAwesomeWorld"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the world has been loaded.

#### Response Example
```json
{
  "message": "World 'MyAwesomeWorld' loaded successfully."
}
```
```

--------------------------------

### /sound all subcommand

Source: https://www.hytalecommands.com/sound

This subcommand plays the specified sound to all players instead of just the sender.

```APIDOC
## POST /sound/all

### Description
Play a sound event to all players in the game. This is a subcommand of the main `/sound` command.

### Method
POST

### Endpoint
`/sound all`

### Parameters
#### Query Parameters
- **2d** (string) - Optional - Play a 2D sound event.
- **3d** (string) - Optional - Play a 3D sound event at a specific position.
- **category** (number) - Optional - The sound category (SFX, Music, etc.). Defaults to SFX.

### Request Example
```json
{
  "command": "/sound all",
  "parameters": {
    "soundId": "another_sound_id",
    "category": "Music"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the sound was played to all players or an error occurred.

#### Response Example
```json
{
  "message": "Sound 'another_sound_id' played to all players."
}
```

### Server Messages
- **notfound**: Sound not found: {soundid}
- **invalidCategory**: Invalid sound category '{category}'. Valid categories are: {validCategories}
```

--------------------------------

### /give other Command

Source: https://www.hytalecommands.com/give

Grants a specified item to another player, with optional quantity and metadata.

```APIDOC
## POST /give/other

### Description
Gives an item to a specified target player.

### Method
POST

### Endpoint
/give/other

### Parameters
#### Query Parameters
- **target** (string) - Required - The target player to give the item to.
- **item** (string) - Required - The item to give.
- **quantity** (integer) - Optional - The quantity of items to give. Defaults to 1.
- **metadata** (string) - Optional - Item metadata as a JSON string.

### Request Example
```json
{
  "target": "PlayerName",
  "item": "Armor Bronze Chest",
  "quantity": 2,
  "metadata": "{}"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the item was given to the target player.

#### Response Example
```json
{
  "message": "You gave PlayerName 2 of Armor Bronze Chest"
}
```

#### Error Responses
- **unableToFind** (string) - Unable to find item or block "{itemId}".
- **insufficientInvSpace** (string) - Unable to give {quantity} of {item}; insufficient inventory space.
- **invalidMetadata** (string) - Invalid metadata format: {error}.
```

--------------------------------

### Meta Commands API

Source: https://www.hytalecommands.com/meta

This section details commands for retrieving meta information about entities, worlds, and chunks, and for dumping registered commands.

```APIDOC
## GET /meta

### Description
Retrieves meta information about entities, worlds, or chunks, and allows dumping registered commands.

### Method
GET

### Endpoint
`/meta [entity] [world]`

### Parameters
#### Query Parameters
- **entity** (number) - Optional - Prints the MetaStore of the target Entity.
- **world** (world) - Optional - Prints the MetaStore of the current World.

### Subcommands
- `/meta chunk`: Prints the MetaStore of the current WorldChunk.
- `/meta dump`: Dump all registered commands to a file.

### Server Messages
- `dump.success`: Dumped commands to {file}
- `dump.error`: There was a problem, see server logs

### Related Commands
- `/ambience`: Manage ambience in worlds
- `/assets`: Commands related to assets
- `/backup`: Run a backup of the universe
- `/block`: Block-related commands
- `/blockset`: List the block sets and contents
```

--------------------------------

### Marker Management

Source: https://www.hytalecommands.com/spawning

Commands for managing spawn markers, including adding new markers and enabling/disabling them.

```APIDOC
## POST /spawning/markers/add

### Description
Add an NPC spawn marker to the world. This command places a marker that influences NPC spawning.

### Method
POST

### Endpoint
/spawning/markers/add

### Parameters
#### Query Parameters
- **marker** (string) - Required - The spawn marker definition
```

```APIDOC
## POST /spawning/markers/add/flip

### Description
Flip the forward rotation of the spawn marker. This command modifies the orientation of an existing marker.

### Method
POST

### Endpoint
/spawning/markers/add/flip
```

```APIDOC
## POST /spawning/markers/enable

### Description
Enable spawn markers. This command activates all configured spawn markers in the world.

### Method
POST

### Endpoint
/spawning/markers/enable
```

--------------------------------

### Spawning Commands

Source: https://www.hytalecommands.com/spawning

Base command for managing NPC spawning. Allows for various subcommands to control beacons, markers, suppression, and statistics.

```APIDOC
## GET /spawning

### Description
Base command for managing NPC spawning. Allows for various subcommands to control beacons, markers, suppression, and statistics.

### Method
GET

### Endpoint
/spawning

### Parameters
#### Query Parameters
- **beacon** (string) - Optional - The beacon NPC spawn definition
- **marker** (string) - Optional - The spawn marker definition
- **suppression** (string) - Optional - The spawn suppression definition
- **environments** (string) - Optional - Show environment statistics
- **markers** (string) - Optional - Show marker statistics
- **verbose** (string) - Optional - Show verbose statistics
- **environment** (string) - Optional - The environment to populate (optional, defaults to all)
```

--------------------------------

### Prefab Spawner Base Command

Source: https://www.hytalecommands.com/prefabspawner

View and edit properties on a prefab spawner block. Optionally specify the position of the spawner.

```APIDOC
## GET /prefabspawner

### Description
View and edit properties on a prefab spawner block. Optionally specify the position of the spawner.

### Method
GET

### Endpoint
`/prefabspawner [position]`

### Parameters
#### Query Parameters
- **position** (string) - Optional - The position of the prefab spawner (or raycast from player if not specified)

### Response
#### Success Response (200)
- **message** (string) - A message indicating the status of the operation or retrieved properties.

#### Response Example
```json
{
  "message": "Current Prefab Path: some/prefab.path"
}
```
```

--------------------------------

### /blockspawner

Source: https://www.hytalecommands.com/blockspawner

Commands for working with block spawners in Hytale.

```APIDOC
## /blockspawner [position]

### Description
Commands for working with block spawners.

### Method
N/A (Command-line interface)

### Endpoint
N/A (Command-line interface)

### Parameters
#### Path Parameters
- **position** (string) - Optional - The position of the block spawner (or raycast from player if not specified)

### Subcommands

#### `/blockspawner get`

##### Description
Gets the BlockSpawner id for a BlockSpawner block you look at.

##### Method
N/A (Command-line interface)

##### Endpoint
N/A (Command-line interface)

#### `/blockspawner set`

##### Description
Sets a BlockSpawner id for a BlockSpawner block you look at.

##### Parameters
* **blockSpawnerId** (string) - Required - The BlockSpawner table ID to set

##### Method
N/A (Command-line interface)

##### Endpoint
N/A (Command-line interface)

### Server Messages
* **blockSpawnerSet**: Set BlockSpawner to {id}!
* **currentBlockSpawner**: The BlockSpawner for this block is {id}
* **noBlockSpawnerSet**: No BlockSpawner set for this block
```

--------------------------------

### Ambience Management API

Source: https://www.hytalecommands.com/ambience

This API allows for the management of ambience effects, including setting music, clearing settings, and managing emitters within Hytale worlds.

```APIDOC
## POST /ambience

### Description
Manages ambience in worlds, allowing you to set music, clear settings, or manage emitters.

### Method
POST

### Endpoint
`/ambience`

### Parameters
#### Query Parameters
- **ambiencefxid** (string) - Optional - The ID of the AmbienceFX for the music
- **soundEvent** (string) - Optional - Looping sound event to play from this emitter

### Subcommands

#### POST /ambience/clear

##### Description
Resets all forced ambience settings on the world.

##### Method
POST

##### Endpoint
`/ambience clear`

##### Response
###### Success Response (200)
- **message** (string) - Confirmation message: 'All forced ambience settings were reset'

#### POST /ambience/emitter

##### Description
Manages ambient emitters in worlds.

##### Method
POST

##### Endpoint
`/ambience emitter`

#### POST /ambience/emitter/add

##### Description
Add an ambient emitter entity to the player's current position in the world.

##### Method
POST

##### Endpoint
`/ambience emitter.add`

##### Parameters
###### Query Parameters
- **soundEvent** (string) - Required - Looping sound event to play from this emitter

##### Response
###### Success Response (200)
- **message** (string) - Confirmation message: 'Added ambient emitter with sound event '{soundEventId}' at your location'
###### Error Response (400)
- **message** (string) - Error message if the sound event is not a looping sound event: 'Sound event '{soundEventId}' is not a looping sound event!'
- **message** (string) - Error message if the emitter failed to spawn: 'Failed to spawn ambient emitter with sound event '{soundEventId}''

#### POST /ambience/setmusic

##### Description
Sets the forced ambience music on the world.

##### Method
POST

##### Endpoint
`/ambience setmusic`

##### Parameters
###### Query Parameters
- **ambiencefxid** (string) - Required - The ID of the AmbienceFX for the music

##### Response
###### Success Response (200)
- **message** (string) - Confirmation message: 'World forced ambience music set to {ambience}'

```

--------------------------------

### Set Prefab Spawner Fit Heightmap

Source: https://www.hytalecommands.com/prefabspawner

Configures whether the prefab spawner should fit the heightmap.

```APIDOC
## POST /prefabspawner/set.fitHeightmap

### Description
Configures whether the prefab spawner should fit the heightmap.

### Method
POST

### Endpoint
`/prefabspawner set.fitHeightmap`

### Parameters
#### Query Parameters
- **value** (boolean) - Required - Whether to fit the heightmap (true/false).

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "message": "Prefab spawner heightmap fitting set to true."
}
```
```

--------------------------------

### Set Prefab Spawner Properties

Source: https://www.hytalecommands.com/prefabspawner

Sets various properties for a prefab spawner block.

```APIDOC
## POST /prefabspawner/set

### Description
Sets various properties for a prefab spawner block. You can set the prefab path, heightmap fitting, seed inheritance, height check inheritance, and default weight.

### Method
POST

### Endpoint
`/prefabspawner set`

### Parameters
#### Query Parameters
- **prefab** (string) - Required - The prefab path to set.
- **fitHeightmap** (boolean) - Optional - Whether to fit the heightmap (true/false).
- **inheritSeed** (boolean) - Optional - Whether to inherit the seed (true/false).
- **inheritHeightCheck** (boolean) - Optional - Whether to use its parent's HeightCondition (true/false).
- **defaultWeight** (number) - Optional - Sets the default weight that is assigned to prefabs that do not have a weight mapping assigned.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the properties have been set.

#### Response Example
```json
{
  "message": "Set PrefabSpawner!"
}
```
```

--------------------------------

### /expand Command

Source: https://www.hytalecommands.com/expand

This command allows you to expand your current selection in all directions or by a specified amount in a particular direction.

```APIDOC
## /expand

### Description
Expand your selection in all directions, or by the specified amount in a direction.

### Method
Not Applicable (Command-line Interface)

### Endpoint
Not Applicable (Command-line Interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
`/expand [axis] [distance]`

### Response
#### Success Response (200)
This command modifies the in-game selection. No direct textual response is typically provided unless an error occurs.

#### Response Example
None (In-game selection modification)
```

--------------------------------

### /wait Command

Source: https://www.hytalecommands.com/wait

The /wait command allows you to pause command execution for a specified amount of time. It can optionally print a message to chat upon completion.

```APIDOC
## POST /websites/hytalecommands/wait

### Description
Introduces a delay before completing a command asynchronously. Useful for sequencing actions or creating timed events.

### Method
POST

### Endpoint
/websites/hytalecommands/wait

### Parameters
#### Query Parameters
- **time** (integer) - Optional - The amount of time in seconds to wait.
- **--print** (string) - Optional - If specified, the command will print 'Waiting complete!' to chat when finished.

### Request Example
```json
{
  "command": "/wait",
  "parameters": {
    "time": 5,
    "--print": ""
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the command execution status, e.g., 'Waiting complete!' if --print was used.

#### Response Example
```json
{
  "message": "Waiting complete!"
}
```
```

--------------------------------

### World Save Commands

Source: https://www.hytalecommands.com/world

Commands for saving world data.

```APIDOC
## POST /world save

### Description
Saves the current world's data to disk.

### Method
POST

### Endpoint
/world save

### Response
#### Success Response (200)
Indicates that the world has been saved.

#### Response Example
```json
{
  "example": "World saved successfully."
}
```

## POST /world save.all

### Description
Saves all worlds on the server to disk.

### Method
POST

### Endpoint
/world save.all

### Response
#### Success Response (200)
Indicates that all worlds have been saved.

#### Response Example
```json
{
  "example": "All worlds saved successfully."
}
```
```
Tokens:
Raw