> For the complete documentation index, see [llms.txt](https://wiki.vortexdevelopment.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.vortexdevelopment.net/projects/vortexstacker/configuration.md).

# ⚙️ Configuration

### Items Module (Modules.Items)

```yml
# Enable or disable the Items module.
Enabled: true

# The format of the stacked item name. Use <type> and <amount> as placeholders.
Name Format: "<gradient:#9200B7:#137FFF><amount>x <type></gradient>"

# If true, item names will be automatically translated based on client language.
Auto Translate Names: true

# Enable stacking for non-stackable items such as tools and armor
Stack Non Stackable Items: false

# List of item types (material names) that should not be stacked
Disabled Items:
  - BARRIER

# List of worlds where item stacking is disabled
Disabled Worlds:
  - "example_world"

# The global maximum stack size for items.
Max Stack Size: 2147483647
```

### Mobs (Modules.Mobs)

```yaml
# The method used to merge mob stacks. OLDEST keeps the first mob, YOUNGEST keeps the latest.
Merge Method: OLDEST

# Enable or disable the Mobs module.
Enabled: true

# The radius in blocks within which mobs will be merged into stacks.
Merge Radius: 8.0

# The maximum number of mobs that can be in a single stack.
Max Stack Size: 1000

# If true, the stack amount will be displayed in the mob's name.
Display Stack In Name: true

# The format of the stacked mob name. Use <type> and <amount> placeholders.
Stack Name Format: "<gradient:#9200B7:#137FFF><type> x<amount></gradient>"

# If true, mob names will be automatically translated based on client language.
Auto Translate Names: true
Task:
  # Task interval in ticks for checking mobs to stack.
  Interval: 3

Checks:
  # If true, mobs will only stack if they are on the surface (direct sky access).
  Surface Only: true
  # If true, mobs flying downwards will still be considered for stacking.
  Flying Downwards: true
  # If true, mobs with custom names will also be stacked.
  Stack Custom Named: false

# List of attributes that must match for two mobs to stack (e.g., AGE, COLOR, VARIANT).
Active Checks:
  - "AGE"
  - "COLOR"
  - "VARIANT"
  - "TAMED"
  - "HAS_EQUIPMENT"

Loot Editor:
  # If true, the mob loot editor GUI will be enabled.
  Enabled: true

# If true, only mobs spawned from spawners will be stacked.
Stack Only From Spawners: false

# List of Persistent Data Container keys that will prevent an entity from being stacked.
Ignored PDC Keys:
  - "mynamespace:custom_mob"
```

### Spawners (Modules.Spawners)

```yaml
# Enable or disable the Spawners module.
Enabled: true

# How to handle spawners that are found in the database but the block at the location is no longer a spawner.
# Options:
# SKIP - Just don't load it into memory
# WARN - Don't load it and show a warning in console
# REMOVE - Delete it from the database and log the deletion
Cleanup Action: SKIP

# The maximum stack size for spawners.
Max Stack Size: 1000

# If true, spawner mob names will be automatically translated based on the client's language settings. (Will auto translate <type> placeholders)
Auto Translate Names: true

# If true, custom entities from other plugins will be supported by spawners.
Custom Entity Support: true

GUI:
  # If true, the spawner GUI will be enabled, allowing players to manage spawner upgrades and settings.
  Enabled: false

Drops:
  # If true, spawners will drop as items when broken.
  To Inventory: true
  # If true, players will need to have a silk touch pickaxe to pick up spawners.
  Silk Touch Required: false

Holograms:
  # If true, holograms will be displayed above spawners showing their type and amount.
  Enabled: true
  # The format of the spawner holograms. You can use <amount> and <type> placeholders.
  Format:
    - "<gradient:#9200B7:#137FFF><amount>x <type> Spawner</gradient>"

Item:
  # The name of the spawner item. You can use <amount> and <type> placeholders.
  Name: "<gradient:#9200B7:#137FFF><amount>x <type> Spawner</gradient>"

Spawned Mobs:
  # If true, spawned mobs will have their AI disabled when they were spawned from spawners. Gravity still applies.
  Disable AI: true
  # If true, spawned Endermen will be prevented from teleporting when there were spawned from spawners.
  Disable Enderman Teleport: true

# If true, players will not be able to change the spawner type using spawn eggs.
Disable Mob Egg Usage: true

# If true, each spawner will require a spawn egg to be placed.
Require Egg Per Spawner: false
```

### Blocks (Modules.Blocks)

```yaml
# Enable or disable the Blocks module.
Enabled: true

# How to handle blocks that are found in the database but the block at the location is no longer the correct type.
# Options:
# SKIP - Just don't load it into memory
# WARN - Don't load it and show a warning in console
# REMOVE - Delete it from the database and log the deletion
Cleanup Action: SKIP

Hologram:
  # Enable or disable holograms for stacked blocks
  Enabled: true
  # Format of the hologram displayed above stacked blocks. Use <block-name> and <amount> as placeholders.
  Format:
    - "<gradient:#9200B7:#137FFF><block-name> x<amount></gradient>"

# Behavior when a player sneak-breaks a stacked block
# Options:
# DROP_ALL - Drops all blocks in the stack
# DROP_ONE - Drops one block from the stack
Sneak Break Behavior: DROP_ALL

# If true, when a stacked block is broken, items will be dropped directly into the player's inventory if possible.
Drop Directly To Player: false

```

### Schedules

```yaml
Schedules:
  Remove Stacked Items:
    # Schedule removal of stacked items and entities.
    # Period format: <number><unit> (e.g. 15m, 1h, 30s)
    Enabled: false
    Period: "15m"
    Log: true
  Remove Stacked Entities:
    Enabled: false
    Period: "15m"
    Log: true
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.vortexdevelopment.net/projects/vortexstacker/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.