### EliteMobs Server Administration Commands

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/setup.md

Essential console commands for managing the EliteMobs plugin, including commands for initial setup, checking installation status, and reloading plugin configurations after changes or updates.

```Minecraft Console Command
/em setup
```

```Minecraft Console Command
/em reload
```

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

### Basic Custom Spawn Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_spawns.md

An example YAML configuration file for a custom spawn, demonstrating essential settings such as enabling the spawn, specifying valid world types, and controlling surface spawning behavior.

```yml
isEnabled: true
validWorldTypes:
- NORMAL
- CUSTOM
bypassWorldGuard: false
isSurfaceSpawn: true
```

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

### Complete Custom Event Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

A comprehensive YAML example demonstrating the combination of various common configuration settings for a custom event, including enabling, boss files, messages, and commands.

```yml
isEnabled: true
bossFilenames:
- "cool_boss.yml"
- "other_cool_boss.yml"
announcementPriority: 3
startMessage: "Cool event is starting!"
endMessage: "Cool event is ending!"
eventStartCommands:
- say The event started!
eventEndCommands:
- say The event ended!
```

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

### Example In-Game Arena Configuration YAML

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_arenas.md

This YAML configuration defines the complete setup for an in-game arena. It specifies core properties like `isEnabled`, `arenaName`, `corner1`, `corner2`, `startLocation`, and `exitLocation`. It also manages wave progression with `waveCount` and `delayBetweenWaves`, defines mob `spawnPoints`, lists `bossList` entries per wave, sets `rawArenaReward` conditions, and configures player limits with `minimumPlayerCount` and `maximumPlayerCount`, along with custom `arenaMessages`.

```yaml
isEnabled: true
arenaName: Example Arena
corner1: my_arena_world,0,0,0,0,0
corner2: my_arena_world,50,50,50,0,0
startLocation: my_arena_world,25,0,25,0,0
exitLocation: my_minecraft_world,234,44,245,0,0
waveCount: 5
delayBetweenWaves: 5
spawnPoints:
  - name=north:location=my_arena_world,40.5,0,0
  - name=south:location=my_arena_world,10.5,0,0
  - name=west:location=my_arena_world,0,0,40.5
  - name=east:location=my_arena_world,0,0,10.5
  - name=center:location=my_arena_world,25.5,0,25.5
bossList:
  - wave=1:spawnPoint=north:boss=example_arena_wave_1_mob.yml
  - wave=1:spawnPoint=center:boss=example_arena_wave_1_mob.yml
  - wave=1:spawnPoint=south:boss=example_arena_wave_1_mob.yml
  - wave=2:spawnPoint=center:boss=example_arena_wave_2_mob.yml
  - wave=3:spawnPoint=east:boss=example_arena_wave_3_mob.yml
  - wave=3:spawnPoint=west:boss=example_arena_wave_3_mob.yml
  - wave=4:spawnPoint=center:boss=example_arena_wave_4_mob.yml
  - wave=4:spawnPoint=center:boss=example_arena_wave_4_mob.yml
  - wave=5:spawnPoint=center:boss=example_arena_wave_5_mob.yml
  - wave=5:spawnPoint=south:boss=example_arena_wave_5_mob.yml
  - wave=5:spawnPoint=west:boss=example_arena_wave_5_mob.yml
rawArenaReward:
  - currencyAmount=5:wave=1
  - currencyAmount=10:wave=2
  - currencyAmount=15:wave=3
  - currencyAmount=20:wave=4
  - currencyAmount=25:wave=5
  - filename=magmaguys_toothpick.yml:itemlevel=5:wave=5:chance=0.5
minimumPlayerCount: 1
maximumPlayerCount: 3
arenaMessages:
  - wave=1:message=&d[Arena NPC] &fWow! Wave 1!
  - wave=2:message=&d[Arena NPC] &fAmazing it is wave 2!
  - wave=3:message=&d[Arena NPC] &fWave 3 is now on!
  - wave=4:message=&d[Arena NPC] &fWave 4 already!
  - wave=5:message=&d[Arena NPC] &fWell it is all over after this one.
cylindricalArena: false
permission: arena.mypermission
```

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

### YML Float (Decimal) Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Shows how to define float values with many decimal places in YML. Includes an example for specifying a range for randomization, similar to Doubles.

```yml
value: 10.42452
```

```yml
value: 1.0~10.42452
```

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

### Comprehensive Timed Events Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

A complete example demonstrating various configuration options for a timed event, including enablement, boss filenames, announcement messages, commands, local and global cooldowns, weight, duration, and minimum player count.

```yml
isEnabled: true
bossFilenames:
- "cool_boss.yml"
- "other_cool_boss.yml"
announcementPriority: 3
startMessage: "Cool event is starting!"
endMessage: "Cool event is ending!"
eventStartCommands:
- say The event started!
eventEndCommands:
- say The event ended!
customSpawn: "myCoolSpawn.yml"
localCooldown: 30
globalCooldown: 15
weight: 100
eventDuration: 20
eventEndsWithBossDeath: true
eventEndTime: 10000
minimumPlayerCount: 5
```

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

### YML Integer Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Demonstrates how to define whole number integer values in YML. It also shows how to specify a range for randomization using the '~' character, allowing for dynamic script values.

```yml
value: 10
```

```yml
value: 1~10
```

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

### Define Event Start Commands (eventStartCommands)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

Specifies a list of commands to be executed by the server when the event starts. This allows for dynamic actions like broadcasting messages or triggering other game mechanics.

```APIDOC
Key: eventStartCommands
Description: Sets the commands that run at the start of the event.
Type: String List
Default: none
```

```yml
eventStartCommands:
- say The event now starts!!
- "$chance=0.5$ say What a spawn!"
```

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

### YML String List Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Explains the format for defining lists of string values in YML. This requires a specific format using hyphens for each item, and it is recommended to keep the values between quotes.

```yml
valuesList:
- "value,1"
- "value,2"
- "value,3"
```

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

### YML Boolean Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Demonstrates how to define boolean values (`true` or `false`) in YML configuration files. These are typically used to toggle specific features on or off.

```yml
value1: true
value2: false
```

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

### Complete Arena NPC Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_arenas.md

A comprehensive YAML configuration demonstrating how to set up a basic Arena NPC. This example includes properties like name, role, profession, spawn location, greetings, dialog, farewells, talkability, activation radius, interaction type, disguise, and the target arena. The NPC will spawn in 'my_minecraft_world' with a zombie disguise and allow players to challenge 'example_arena'.

```YAML
isEnabled: true
name: Example NPC
role: <Arena Master>
profession: ARMORER
spawnLocation: my_minecraft_world,233,44,245,0,0
greetings:
  - Welcome to the Arena!
dialog:
  - Ready to enter the Arena?
farewell:
  - Bye!
canTalk: true
activationRadius: 3.0
interactionType: ARENA_MASTER
disguise: ZOMBIE
arena: example_arena.yml
```

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

### EliteMobs Quest Acceptance Permission Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_quests.md

Example configuration for setting a specific permission required for players to accept a quest. Players must possess this permission node to start the quest.

```yaml
questAcceptPermission: elitequest.my_permission
```

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

### EliteMobs Admin Command: Open Setup Menu

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/permissions_and_commands.md

Opens the main setup menu for the EliteMobs plugin.

```APIDOC
/em setup
```

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

### Reload BetterStructures Plugin Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/betterstructures/setup.md

This command is used to reload the BetterStructures plugin's configuration and newly imported content. It should be executed after placing zipped content files into the `~plugins/BetterStructures/imports` directory to ensure the plugin recognizes them and begins spawning structures in new chunks.

```Minecraft Command
/bs reload
```

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

### Manual File Cleanup for Minecraft NORMAL World

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

This snippet outlines the essential files and folders to retain when manually cleaning a Minecraft world folder for a NORMAL environment. Deleting all other files and folders helps significantly reduce the world's size for distribution.

```File System Instructions
To prepare your NORMAL world, keep the following files and folders:
1. region folder
2. raids.dat from within the data folder (ensure it's placed inside the data folder when copying)
3. level.dat file

You can safely delete all other files and folders located in the world folder.
```

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

### YML String Configuration with Quotes

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Illustrates the recommended way to define string values in YML, emphasizing the use of double quotes. This is mandatory for strings containing color codes or special characters at the beginning to prevent configuration resets.

```yml
value: "String"
```

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

### EliteScript TRANSLATING_RAY Zone Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/cn/elitemobs/elitescript_zones.md

Demonstrates configuring an EliteScript zone with `TRANSLATING_RAY` shape, defining start and end targets for two points, animation duration, and particle effects. This example uses cloud particles to visualize the ray, animating it upwards by 10 blocks over 100 ticks.

```yaml
eliteScript:
  Example:
    Events:
      - EliteMobDamagedByPlayerEvent
    Zone:
      shape: TRANSLATING_RAY
      Target:
        targetType: SELF
      FinalTarget:
        targetType: SELF
        offset: 0,10,0
      Target2:
        targetType: DIRECT_TARGET
      FinalTarget2:
        targetType: DIRECT_TARGET
        offset: 0,10,0
      animationDuration: 100
      ignoresSolidBlocks: true
    Actions:
      - action: SPAWN_PARTICLE
        particles:
          - particle: CLOUD
        Target:
          targetType: ZONE_FULL
        repeatEvery: 1
        times: 100
```

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

### Configure Event Start Message (startMessage)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

Defines the custom message displayed to players when the event begins. This provides immediate feedback and context for the event's initiation.

```APIDOC
Key: startMessage
Description: Sets the message sent at the start of the event.
Type: String
Default: none
```

```yml
startMessage: An event has started!
```

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

### Manual File Cleanup for Minecraft NETHER and THE_END Worlds

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

This snippet details the specific files and folders to keep when manually cleaning a Minecraft world folder for NETHER or THE_END environments. Removing other unnecessary files significantly reduces the world's size for distribution.

```File System Instructions
To prepare your NETHER and THE_END worlds, keep the following files and folders:
1. region folder inside the DIM-1 folder (ensure it's placed inside the DIM-1 folder when copying)
2. raids.dat from within the data folder (ensure it's placed inside the data folder when copying)
3. level.dat file

You can safely delete all other files and folders located in the world folder.
```

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

### YML Serialized Location String Format

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Shows the specific string format for storing location data in YML. It follows the pattern `worldName,X,Y,Z,PITCH,YAW`, used to configure and store in-game locations.

```yml
location: world,1.0,2.0,3.0,4.0,5.0
```

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

### YML Double (Floating-Point) Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Illustrates how to define floating-point numbers (doubles) in YML, including examples for specifying a range for randomization. Doubles can also represent whole numbers like integers.

```yml
value: 10.01
```

```yml
value: 1.0~10.01
```

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

### Anywhere Spawn Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_spawns.md

A simplified YAML configuration for a custom spawn designed to occur anywhere. This setup allows mobs to spawn in any location, in any world, at any time, and during any moon phase.

```yml
isEnabled: true
canSpawnInLight: true
```

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

### Declaring a named EliteScript

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_powers.md

This example demonstrates how to define a specific EliteScript by giving it a unique name, 'Example', as a sub-entry under the 'eliteScript' key.

```yml
eliteScript:
  Example:
```

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

### EliteMobs Boss Respawn Time Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/setup.md

This snippet shows an example of a `spawnLocations` entry in an EliteMobs configuration file. The numbers after the colon represent a Unix timestamp indicating the boss's next scheduled respawn. Users can delete these numbers to force an immediate respawn after an `/em reload`.

```yml
spawnLocations:
- em_primis,1100.5,22.5,526.5,0.0,0.0:1643259941451
```

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

### Set Minimum Player Count for Arena Start

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_arenas.md

Sets the minimum amount of players an arena must have before it can begin. This ensures a certain number of participants are present.

```yml
minimumPlayerCount: 1
```

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

### Full Wormhole Configuration Example for Inter-World Teleportation

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_wormholes.md

This comprehensive YAML example demonstrates a complete wormhole setup, enabling teleportation between two distinct worlds. It includes settings for activation, precise world coordinates, display text, required permissions, coin cost, visual style, particle color, player blinding, and size, showcasing a typical configuration scenario.

```yaml
isEnabled: true #We enable the worm by setting this value to true
location1: my_world,1.5,11.0,1.5,108.0,5.0 #this is where the wormhole will appear in my_world
location2: my_other_world,766.5,29.0,517.5,-136.0,5.0 #this is where the wormhole will appear in my_other_world
location1Text: "&aGo to My World" #makes a nice display text above wormhole location1
location2Text: "&aGo to My Other World" #makes a nice display text above wormhole location2
permission: eliteperm.coolplayers #only players with this permission will be able to use the wormhole, both for location1 and location2
coinCost: 2 #the players will need to pay 12 elite coins to be able to use the worm hole
style: CRYSTAL #this wormhole will be in the shape of a crystal
particleColor: 0x00ff00 #this will set the wormhole particles to green
blindPlayer: true #the wormhole teleport will blind the player for a short duration to make the transition less jarring
sizeMultiplier: 1.0 #sets how big the shape of the wormhole should be
```

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

### Execute Node.js Directory Caching Script

Source: https://github.com/magmaguy/magmaguy.com/blob/master/js/ReadMe.md

This command initiates the `node_utils.js` Node.js script. This script is responsible for retrieving and caching website directories and runs on port 40000. It requires the `express` and `cors` npm packages to be installed.

```Shell
node node_utils.js
```

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

### Full NPC Configuration Example (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_npcs.md

A comprehensive example showcasing various configuration options for an NPC, including basic properties like name, role, greetings, dialog, and advanced settings such as disguise, custom models, and interaction types with associated parameters.

```yml
isEnabled: true
name: "&cRed Rubin"
role: "&a<Generic NPC>"
profession: NITWIT
greetings:
- Hiya!
- Hello!
dialog:
- Great conversation!
- Pleasure talking with you!
farewell:
- Goodbye!
- Laters!
canTalk: true
activationRadius: 4
interactionType: CHAT
timeout: 0
questFileName: 
- my_quest.yml #npc interactionType must be set to CUSTOM_QUEST_GIVER
disguise: SKELETON
customDisguiseData: #used when a custom libsdisguise is being set
customModel: MODEL_ONE
arena: my_arena.yml #npc interactionType must be set to ARENA_MASTER
command: /say Hello World! #npc interactionType must be set to COMMAND
spawnLocation: my_world,584,55,127,90,10 #remember that NPCs use pitch and yaw to set where they are looking at. this is also automatically set when running the /em spawnnpc <npcfilename.yml> command, so make sure you pose where you want the NPC to be facing when running the command.
```

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

### API: Set Arena Start Location (startLocation)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_arenas.md

Defines the initial spawn point for players or entities entering the arena. This is a serialized location string specifying the exact coordinates and orientation.

```APIDOC
startLocation:
  Type: Location (serialized)
  Default: none
  Description: Sets the start location of the arena.
```

```yml
startLocation: my_arena_world,1,50,1,0,0
```

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

### Example Treasure File Items Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/betterstructures/creating_treasure.md

An example showing the 'items' section of a treasure file, detailing how common and rare items are defined with their respective weights and properties, including procedural enchantment settings.

```yml
items:
  common:
    weight: 60
    items:
    - amount: 1-1
      material: STONE_PICKAXE
      procedurallyGenerateEnchantments: true
      weight: 1.0
    - amount: 1-1
      material: STONE_SHOVEL
      procedurallyGenerateEnchantments: true
      weight: 1.0
  rare:
    weight: 30
    items:
    - amount: 1-1
      material: ANVIL
      weight: 6.0
    - amount: 1-6
      material: BEETROOT
      weight: 6.0
```

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

### Example Treasure File Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/betterstructures/creating_treasure.md

A comprehensive example demonstrating the structure of a treasure file, including item definitions, procedural enchantment settings, and rarity categories like common, rare, and epic.

```yml
isEnabled: true
mean: 4.0
standardDeviation: 3.0
items:
  common:
    weight: 60
    items:
    - amount: 1-1
      material: STONE_PICKAXE
      procedurallyGenerateEnchantments: true
      weight: 1.0
    - amount: 1-1
      material: STONE_SHOVEL
      procedurallyGenerateEnchantments: true
      weight: 1.0
  rare:
    weight: 30
    items:
    - amount: 1-1
      material: ANVIL
      weight: 6.0
    - amount: 1-6
      material: BEETROOT
      weight: 6.0
  epic:
    weight: 10
    items:
    - amount: 2-10
      material: DIAMOND
      weight: 1.0
    - amount: 1-1
      material: DIAMOND_AXE
      weight: 6.0
procedurallyGeneratedItemSettings:
  golden_sword:
    bane_of_arthropods:
      minLevel: 1
      maxLevel: 5
      chance: 0.2
    looting:
      minLevel: 1
      maxLevel: 3
      chance: 0.2
```

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

### Example `filename` Field (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_reinforcements.md

A YAML example demonstrating the `filename` field, used to specify the configuration file of the reinforcement boss to be summoned.

```yaml
filename: test_boss.yml
```

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

### EliteScript STATIC_RAY Zone Configuration and Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_zones.md

Comprehensive documentation for defining a STATIC_RAY zone in EliteScript, including its API parameters and a practical YAML example demonstrating its usage with particle spawning along a ray.

```APIDOC
Key: shape
Details: Sets the shape of the zone. Should be `STATIC_RAY`
Mandatory: ✅

Key: target
Details: Sets the location for the first point of the line
Mandatory: ✅

Key: target2
Details: Sets the location for the last point of the line
Mandatory: ✅

Key: filter
Details: Sets which types of entities get targeted
Mandatory: ❌

Key: ignoresSolidBlocks
Details: Sets if the ray will pass through solid blocks
Mandatory: ❌

Key: pointRadius
Details: Sets the thickness of the ray. Default is 0.5 blocks.
Mandatory: ❌
```

```yaml
eliteScript:
  Example:
    Events:
      - EliteMobDamagedByPlayerEvent
    Zone:
      shape: STATIC_RAY
      Target2:
        targetType: DIRECT_TARGET
        offset: 0,1,0
      Target:
        targetType: SELF
        offset: 0,1,0
    Actions:
      - action: SPAWN_PARTICLE
        particles:
          - particle: CLOUD
        Target:
          targetType: ZONE_FULL
        repeatEvery: 5
        times: 20
```

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

### Full Treasure Chest Configuration Example (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_treasure_chests.md

A complete example of a treasure chest configuration file, showcasing various parameters such as enabling the chest, defining its type and facing direction, specifying loot lists with chances, setting mimic chances, restock timers, and initial locations.

```yml
isEnabled: true
chestType: CHEST
facing: NORTH
dropStyle: MULTIPLE
lootList:
- filename=elite_scrap_tiny.yml:chance=0.90
- magmaguys_toothpick.yml:chance=0.95
mimicChance: 0.50
mimicCustomBossesList:
- balrog.yml
- killer_rabbit_of_caerbannog.yml
restockTimer: 1
effects: SMOKE_NORMAL
locations:
- world,0.0,-60.0,-14.0,0.0,0.0
```

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

### YAML Configuration Example for Soulbound Property

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_items.md

An example YAML snippet demonstrating how to configure the `soulbound` property. Setting it to `true` ensures the item is soulbound upon dropping.

```yml
soulbound: true
```

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

### Assign Boss Powers (YAML Example)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for assigning powers to a boss by referencing external YAML files containing power definitions.

```yml
powers:
- hyper_loot.yml
- attack_arrow.yml
```

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

### Trim Minecraft World with WorldBorder Plugin Commands

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

This snippet provides the sequence of commands to use the WorldBorder plugin for trimming a Minecraft world. It covers setting the border radius, initiating the trim process with frequency and padding, confirming the trim, and optionally clearing the border. Note: If '/wb' doesn't work, try '/worldborder:wb'. This process reduces world size for easier distribution.

```Minecraft Commands
/wb set x
/wb trim [freq] [pad]
/wb trim confirm
/wb clear all
```

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

### EliteScript CUBOID Zone Configuration and Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_zones.md

Comprehensive documentation for defining a CUBOID zone in EliteScript, including its API parameters and a practical YAML example demonstrating its usage with particle spawning.

```APIDOC
Key: shape
Details: Sets the shape of the zone. Should be `CUBOID`
Mandatory: ✅

Key: target
Details: Sets the location for the center of the cuboid
Mandatory: ✅

Key: filter
Details: Sets which types of entities get targeted
Mandatory: ❌

Key: x
Details: Sets the length of the cuboid
Mandatory: ✅

Key: y
Details: Sets the height of the cuboid
Mandatory: ✅

Key: z
Details: Sets the width of the cuboid, defaults to `x`
Mandatory: ❌

Key: xBorder
Details: Sets the length of the inner cuboid
Mandatory: ❌

Key: yBorder
Details: Sets the height of the inner cuboid
Mandatory: ❌

Key: zBorder
Details: Sets the width of the inner cuboid, defaults to `x`
Mandatory: ❌
```

```yaml
eliteScript:
  Example:
    Events:
      - EliteMobDamagedByPlayerEvent
    Zone:
      shape: CUBOID
      x: 4
      y: 4
      z: 4
      xBorder: 3
      yBorder: 3
      zBorder: 3
      Target:
        targetType: SELF
    Actions:
      - action: SPAWN_PARTICLE
        particles:
          - particle: CLOUD
        Target:
          targetType: ZONE_FULL
        repeatEvery: 5
        times: 20
```

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

### EliteMobs Custom Objective: FETCH_ITEM Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_quests.md

Example configuration for a custom objective requiring players to fetch a specific custom item. The `amount` specifies the quantity, `itemName` is for display, and `filename` points to the item's configuration.

```yaml
customObjectives:
  Objective1:
    amount: '99'
    itemName: Red Apples
    filename: my_quest_item_red_apples.yml
    objectiveType: FETCH_ITEM
```

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

### Example Wormhole Configuration File

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_wormholes.md

Illustrates a complete example of a wormhole configuration file, defining its enabled status and the coordinates for its two teleportation points, including world, XYZ, yaw, and pitch. Yaw and Pitch control player ejection direction.

```yaml
isEnabled: true
location1: em_primis,1288.5,19,452.5,135,-23
location2: em_primis,1288.5,-39,451.5,180,-1
```

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

### Example Phase 3 Boss Configuration (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_boss_phases.md

An example YAML configuration for Phase 3 of a Custom Boss. This file defines the attributes for the boss once it transitions from Phase 2, showcasing a different entity type and a unique power set, highlighting the flexibility of phase-based changes.

```YAML
isEnabled: true
level: 50
healthMultiplier: 10
entityType: WITHER_SKELETON
powers:
- arrow_rain
```

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

### TELEPORT Action Location Format Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

An example of the standard EliteMobs location format used in the TELEPORT action, specifying world, coordinates, pitch, and yaw.

```yaml
location: world,0,64,0,0,0
```

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

### Example Phase 2 Boss Configuration (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_boss_phases.md

An example YAML configuration for Phase 2 of a Custom Boss. This file defines the attributes for the boss once it transitions from Phase 1, including a new entity type and additional powers, demonstrating how attributes can change between phases.

```YAML
isEnabled: true
level: 50
healthMultiplier: 10
entityType: SKELETON
powers:
- attack_gravity.yml
- arrow_fireworks.yml
```

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

### Example Usage of TELEPORT Action

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

A YAML example demonstrating the TELEPORT action, triggered by EliteMobDamagedByPlayerEvent, to teleport nearby players within a 10-block range to the boss's spawn location.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobDamagedByPlayerEvent
    Actions:
    - action: TELEPORT
      Target: 
        targetType: NEARBY_PLAYERS
        range: 10
      FinalTarget:
        targetType: SELF_SPAWN
```

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

### EliteScript PLACE_BLOCK Action YAML Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

YAML configuration demonstrating the PLACE_BLOCK action. This example creates a temporary glass dome around the boss for 6 seconds (120 ticks) when the boss is damaged by a player.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobDamagedByPlayerEvent
    Zone:
      shape: DOME
      radius: 3
      Target:
        targetType: SELF
    Actions:
    - action: PLACE_BLOCK
      Target:
        targetType: ZONE_FULL
      duration: 120
      material: GLASS
```

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

### Configure Boss Scale (YAML Example)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for setting the boss's scale. A value of `1.2` makes the boss 20% larger than its default size.

```yml
scale: 1.2
```

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

### TELEPORT Action 'same_as_boss' Location Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

An example demonstrating the 'same_as_boss' special value for the world name in the TELEPORT action's location parameter, using the boss's current world.

```yaml
location: same_as_boss,0,64,0,0,0
```

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

### Example Usage of SUMMON_ENTITY Action

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

A YAML example demonstrating how to use the SUMMON_ENTITY action within an EliteScript, triggering on EliteMobEnterCombatEvent to target a DIRECT_TARGET.

```yaml
eliteScript:
  Example:
    Events:
      - EliteMobEnterCombatEvent
    Actions:
      - action: SUMMON_ENTITY
        Target:
          targetType: DIRECT_TARGET
```

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

### Example `summonType` Field (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_reinforcements.md

A concise YAML example showing how to specify the `summonType` field, which dictates the condition under which a reinforcement will be spawned.

```yaml
summonType: ON_HIT
```

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

### Set Boss Type (YAML Example)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for defining the boss's type. `MINIBOSS` will enable health bar display and other features for this boss.

```yml
bossType: MINIBOSS
```

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

### Configure Boss Armor and Equipment (YAML Example)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for assigning various armor pieces and held items to a boss. This includes a player head for the helmet, a custom model chestplate, custom colored leggings, and standard boots, main hand, and off-hand items.

```yml
helmet: 198c4123-cafc-45df-ba79-02a421eb8ce7
chestplate: DIAMOND_CHESTPLATE:1
leggings: LEATHER_LEGGINGS:ffa500
boots: NETHERITE_BOOTS
mainHand: DIAMOND_SWORD
offHand: SHIELD
```

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

### Example `chance` Field (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_reinforcements.md

A YAML example showing how to set the `chance` field, which determines the probability (e.g., 0.5 for 50%) of a reinforcement spawning when triggered by `ONCE` or `ON_HIT`.

```yaml
chance: 0.5
```

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

### EliteMobs Internal Admin Command: Toggle Content Installation

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/permissions_and_commands.md

Allows toggling the installation status of specified EliteMobs content, such as dungeon configurations. This command is meant for internal use, typically when interacting with menus.

```APIDOC
/em setup toggle <dungeonConfig>
```

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

### EliteScript NAVIGATE Action YAML Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

Example YAML configuration for the NAVIGATE action. This snippet demonstrates making a boss navigate from its current position to nearby players, with a specific velocity and a fallback teleport if navigation fails, triggered by player damage.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobDamagedByPlayerEvent
    Actions:
    - action: NAVIGATE
      Target: 
        targetType: SELF
      FinalTarget:
        targetType: NEARBY_PLAYERS
        range: 50
      velocity: 1.0
      bValue: true
      duration: 100
```

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

### Configure Disguise with Baby Variant (YAML Example)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for applying a disguise to a boss while ensuring it retains its baby variant, specifically for a Hoglin.

```yaml
disguise: HOGLIN:baby
```

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

### YAML Example: Script with Global and Action-Specific Conditions

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_conditions.md

This YAML configuration demonstrates an Elite Script named 'Example' that triggers on 'EliteMobDamagedByPlayerEvent'. It includes a global condition (`isAlive: true`) that blocks the entire script if the elite is not alive. Additionally, the 'PLACE_BLOCK' action has its own condition (`locationIsAir: true`) that only allows it to run if the target block is air, demonstrating how individual actions can have specific conditions.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobDamagedByPlayerEvent
    Conditions:
      isAlive: true
      conditionType: BLOCKING
      Target:
        targetType: SELF
    Actions:
    - action: PLACE_BLOCK
      Target:
        targetType: DIRECT_TARGET
      duration: 20
      material: DIRT
      offset: 0,3,0
      Conditions:
        locationIsAir: true
        conditionType: BLOCKING
        Target:
          targetType: ACTION_TARGET
    Cooldowns:
      local: 60
      global: 20
```

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

### EliteMobs Boss: Slime Size Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Example YAML configuration for setting the `slimeSize` parameter for an EliteMobs Slime or Magmacube boss. This allows customization of the boss's visual size.

```yml
slimeSize: 5
```

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

### EliteMobs Example Custom Item Configuration

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_items.md

A comprehensive YAML example showcasing various configurable properties for an EliteMobs custom item, including material, name, lore, enchantments, potion effects, drop weight, scalability, and item type.

```yml
isEnabled: true
material: WOODEN_AXE
name: '&4Test item'
lore:
- This is a cool item
- It has cool lore
enchantments:
- DAMAGE_ALL,4
- FLAMETHROWER,1
potionEffects:
- FAST_DIGGING,0,self,onHit
- POISON,0,target,onHit
- GLOWING,0,self,continuous
dropWeight: dynamic
scalability: scalable
itemType: custom
```

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

### Complete Enchanted Book Configuration Example (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/item_upgrade_system.md

A comprehensive example demonstrating how to configure a full enchanted book, including its enabled status, material, display name, lore, enchantments (both Minecraft and EliteMobs custom enchantments), item type, and soulbound status.

```yaml
isEnabled: true
material: BOOK
name: '&5Excellent Mining Enchanted Book'
lore:
- '&2Used to enchant items at the enchanter!'
enchantments:
- MENDING,1
- DRILLING,1
itemType: UNIQUE
soulbound: false
```

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

### Reference YAML Configuration Files by Filename

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

Filename values are used to reference other .yml configuration files within MagmaGuy's plugins. These files can represent various plugin-specific assets like items or quests. The example shows how to include a specific item configuration file, 'magmaguys_toothpick.yml', within a unique loot list.

```yml
uniqueLootList:
  - filename: magmaguys_toothpick.yml
```

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

### EliteMobs Custom Objective: KILL_CUSTOM Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_quests.md

Example configuration for a custom objective requiring players to kill a specific custom boss. The `amount` specifies the number of kills, and `filename` points to the boss's configuration file.

```yaml
customObjectives:
  Objective1:
    amount: '1'
    filename: my_cool_boss.yml
    objectiveType: KILL_CUSTOM
```

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

### Set Minimum Player Count for Event Start

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

Establishes the minimum number of online players required for the timed event to initiate. The event will only start if this condition is met.

```yml
minimumPlayerCount: true
```

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

### Example Phase 1 Boss Configuration (YAML)

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_boss_phases.md

An example YAML configuration for the initial phase (Phase 1) of a Custom Boss. It defines basic attributes like health, entity type, powers, and specifies the subsequent phases along with their health thresholds for transition.

```YAML
isEnabled: true
level: 50
healthMultiplier: 10
entityType: STRAY
powers:
- attack_gravity.yml
phases:
- phase_2_boss.yml:0.60
- phase_3_boss.yml:0.30
```

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

### Configure Instanced Dungeon Start Location

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/dungeon_packager.md

Defines the precise teleport coordinates for players entering an instanced dungeon. Players will be sent to this location when initiating the dungeon using the `/em start` command. The format includes world name, X, Y, Z coordinates, and optional yaw and pitch.

```APIDOC
Key: startLocation
Values: String (e.g., "world,x,y,z,yaw,pitch")
Default: none
Mandatory: true
```

```YAML
startLocation: my_minecraft_world,10.5,70,10.5,0.0,0.0
```

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

### Example Usage of TAG Action with Fireworks

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

A YAML example demonstrating the TAG action to apply a 'fireworks' tag to a mob, followed by a SPAWN_FIREWORKS action that conditionally executes based on the presence of this tag.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobSpawnEvent
    Actions:
    - action: TAG
      Target:
        targetType: SELF
      tags:
      - fireworks
    - action: SPAWN_FIREWORKS
      Target:
        targetType: SELF
      wait: 20  
      offset: 0,3,0
      vValue: 0,.1,0
      flicker: true
      withTrail: true
      power: 1
      fireworkEffects:
      - [ORANGE, RED]
      repeatEvery: 20
      Conditions:
        hasTags:
        - fireworks
```

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

### EliteMobs Custom Rewards Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_quests.md

Example configuration for custom quest rewards, including currency, material items, and custom items, with specified amounts and chances. Rewards follow the universal EliteMobs loot format.

```yaml
customRewards:
- currencyAmount=50:amount=1:chance=0.05
- material=COOKED_COD:amount=3:chance=1.0
- filename=magmaguys_toothpick.yml:amount=1:chance=1.0
```

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

### EliteMobs Custom Objective: DIALOG Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_quests.md

Example configuration for a custom objective requiring players to engage in a dialogue with a specific NPC. It includes the dialogue lines, NPC filename, name, and optional location.

```yaml
customObjectives:
  Objective1:
    dialog:
    - "&a[Dialog NPC] &fCome here often?"
    - "&7&oI should eat more apples."
    filename: dialog_npc.yml
    npcName: Dialog NPC
    location: at dialog location.
    objectiveType: DIALOG
```

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

### EliteScript TRANSLATING_RAY Zone Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/es/elitemobs/elitescript_zones.md

An example EliteScript configuration demonstrating the use of the `TRANSLATING_RAY` zone shape. This script creates an animated ray from a boss to a player, showing how to use `offset` for movement and `animationDuration` for timing, along with particle effects.

```yaml
eliteScript:
  Example:
    Events:
      - EliteMobDamagedByPlayerEvent
    Zone:
      shape: TRANSLATING_RAY
      Target:
        targetType: SELF
      FinalTarget:
        targetType: SELF
        offset: 0,10,0
      Target2:
        targetType: DIRECT_TARGET
      FinalTarget2:
        targetType: DIRECT_TARGET
        offset: 0,10,0
      animationDuration: 100
      ignoresSolidBlocks: true
    Actions:
      - action: SPAWN_PARTICLE
        particles:
          - particle: CLOUD
        Target:
          targetType: ZONE_FULL
        repeatEvery: 1
        times: 100
```

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

### Example: Dynamic Arena Block State Workflow

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

Illustrates a practical application of block states to create a dynamic combat arena, demonstrating how to use commands to open and close a door based on boss phases.

```APIDOC
Scenario: Create a fight where a boss spawns in an arena with an open door, which closes when the fight starts and reopens when the fight is over.
Requires: Two boss phases (e.g., phase_1_boss.yml, phase_2_boss.yml) and three sets of block states.

Step 1: Register open door blocks for phase_1_boss.yml on_spawn
  Command: /em registerblocks phase_1_boss.yml on_spawn OR /em registerblocksedit phase_1_boss.yml on_spawn
  Details: Register air blocks (area selection recommended) to ensure the door is open when the boss spawns.

Step 2: Register closed door blocks for phase_2_boss.yml on_spawn
  Command: /em registerblocks phase_2_boss.yml on_spawn OR /em registerblocksedit phase_2_boss.yml on_spawn
  Details: Register solid blocks of the door to prevent players from leaving when the boss enters phase 2.

Step 3: Register open door blocks for phase_2_boss.yml on_remove
  Command: /em registerblocks phase_2_boss.yml on_remove OR /em registerblocksedit phase_2_boss.yml on_remove
  Details: Register the same air blocks from Step 1 to open the door when the boss dies, allowing players to leave the arena.
```

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

### Combined Event Configuration Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_events.md

Demonstrates a combined configuration for event chance and breakable materials. This example sets a 0.1% chance for an event to run when a coal ore block is broken, assuming the event type is `BREAK_BLOCK`.

```yml
chance: 0.001
breakableMaterials:
- COAL_ORE
```

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

### Apply Color Codes and Text Modifiers in YAML

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/global/configuration_file_guide.md

MagmaGuy's plugins support Minecraft-like color codes and text modifiers using the '&' symbol (instead of '§'). These can be used to format text for elements like mob names, quest text, and dungeon names. Modifiers can be combined to achieve effects like bold, italic, underline, strikethrough, and random text. The example demonstrates how to apply multiple color codes to a mob's name.

```yml
name: $normalBossLevel &aScary &dDragon
```

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

### EliteMobs Custom Boss Full YAML Example

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/creating_bosses.md

A comprehensive YAML example demonstrating various properties for configuring a custom boss. It includes settings for entity type, name, health, equipment, powers, and custom messages for spawn, death, and damage events. This snippet showcases a wide range of configurable options.

```yml
isEnabled: true
entityType: ZOMBIE
name: '&eTest boss'
level: dynamic
timeout: 10
isPersistent: false
healthMultiplier: 2.0
damageMultiplier: 0.5
helmet: GOLDEN_HELMET
chestplate: IRON_CHESTPLATE
leggings: LEATHER_LEGGINGS
boots: CHAINMAIL_BOOTS
mainHand: GOLDEN_AXE
offHand: SHIELD
isBaby: false
powers:
- invulnerability_knockback.yml
spawnMessage: A test boss has been spawned!
deathMessage: A test boss has been slain by $players!
escapeMessage: A test boss entity has escaped!
locationMessage: 'Test entity: $location'
uniqueLootList:
- magmaguys_toothpick.yml:1
dropsEliteMobsLoot: true
dropsVanillaLoot: true
trails:
- BARRIER
onDamageMessages:
- "I've hit you!"
onDamagedMessages:
- "I've been hit!"
```

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

### Example YAML for PUSH Action

Source: https://github.com/magmaguy/magmaguy.com/blob/master/wiki/en/elitemobs/elitescript_actions.md

Shows how to configure the PUSH action in EliteScript to repeatedly push nearby players upwards. This example pushes players within 10 blocks with a force of 0.3, repeating 10 times every 0.5 seconds (10 ticks), making them appear to jump for 5 seconds.

```yaml
eliteScript:
  Example:
    Events:
    - EliteMobDamagedByPlayerEvent
    Actions:
    - action: PUSH
      wait: 3
      Target: 
        targetType: NEARBY_PLAYERS
        range: 10
      vValue: 0,0.3,0
      times: 10
      repeatEvery: 10
```