> For the complete documentation index, see [llms.txt](https://artillex-studios.gitbook.io/axenvoys/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://artillex-studios.gitbook.io/axenvoys/configuration/envoy-configuration.md).

# Envoy configuration

{% code overflow="wrap" fullWidth="true" %}

```yaml
crates:
  # The name of the crate:the spawn chance of the crate spawning
  common: 50
  legendary: 30
  rare: 20

amount: 30
collect-cooldown: 10 # Seconds
collect-global-cooldown: false # Whether the cooldown should be for all crates of this envoy, or per-crate
broadcast-collect: false

random-spawn:
  enabled: true # Should we use random spawning?
  center: "world;0;100;0" # The center location
  min-distance: 20 # The minimum distance from the center an envoy may spawn
  max-distance: 100 # The maximum distance from the center an envoy may spawn
  min-height: 10 # The minimum height at which an envoy may spawn
  max-height: 200 # The maximum height at which an envoy may spawn

  # You can use RegEx here, to match the name of the block
  # For a list of materials, visit: https://jd.papermc.io/paper/1.20/org/bukkit/Material.html
  not-on-blocks:
    - "(?<!s)t?air(?!s)"
    - "(leaves)"
    - "(sign)"

# You can override messages from messages.yml. You need to put it exactly how it is in that file.
messages:
  prefix: "&#00FFAA&lAxEnvoy &7» "

flare:
  enabled: true
  cooldown: 30 # Cooldown in seconds
  item:
    material: "prismarine_shard"
    name: "&cEnvoy flare"
    glow: true
    custom-model-data: 0
    lore:
      - "&7Right click with this, to start"
      - "&7the default envoy!"

pre-defined-spawns:
  enabled: true
  locations:
    - "world;1;1;1"
```

{% endcode %}

## Options

#### General

crates: This is where you put the crates you want the envoy to spawn. The spawn-chance of the crate is defined as the value to the crate's name.

amount: The amount of crates this envoy will spawn

collect-cooldown: The delay between a player can collect a crate again. This is overridden by the same option in each crate

collect-global-cooldown: Enable this, if you want the players to have a cooldown per envoy instead of per crate.

broadcast-collect: If the collects of the crates should be broadcasted. This is overridden by the same option in each crate.

#### Random spawns

enabled: Whether or not the plugin should randomly spawn crates in the set bounds.

center: The crates will spawn around this area

min-distance: The minimum distance a crate can spawn from the center

max-distance: The maximum distance a crate can spawn from the center

min-height: The minimum height an envoy may spawn

max-height: The maximum height an envoy may spawn

not-on-blocks: The list of materials a crate may not spawn on. You can use RegEx to match the names of the materials, or you can just type the name in like: diamond\_block

#### Messages

You can write overrides for nearly all messages of the default messages.yml. These messages will be used for the envoy's messages. You **have** to use the same keys as messages.yml.

#### Flare

enabled: If the flare should be enabled

cooldown: The duration in seconds a player has to wait until using another flare

item: Configurations for the item\
&#x20; material: The item type of the item\
&#x20; name: The name of the item\
&#x20; glow: If the item should have the enchantment glint\
&#x20; custom-model-data: The custom modeldata of the item\
&#x20; lore: The lore of the item. Leave as \[] to not have lore

#### Predefined spawns

enabled: If the plugin should try spawning crates at these set locations

locations: The locations of these crates. To add one, simply run /envoy definedspawn \<envoy name> and your location (block at feet) will be added to that envoy's predefined spawns. You need to reload the plugin using the /envoy reload command to make the changes effective.

#### Want to add a new envoy?&#x20;

To add a new envoy, all you need to do is copy the default file into a new file, named differently and make your edits to the new one.

After that, you need to reload the plugin and voila, the new envoy will be added.&#x20;