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

# Overview

This page covers the most important sections in `config.yml`.

## General

```yaml
debug: false
itemBridgeDebug: false
commands:
  main: "rih"
handle-player-death-messages: true
language: "en"
permissionsReferenceLanguage: "en"
groups:
  provider: "auto"
update-notifications: false
metrics-enabled: true
```

Key points:

* `commands.main` changes the main command shown to players.
* `/boss` remains available as a compatibility fallback.
* `language` supports `en` and `es`.
* `groups.provider` controls clan and faction integration.
* `metrics-enabled` toggles bStats telemetry.
* permissionsReferenceLanguage controls the language ("en"/"es") of the auto-generated permissions-reference.yml informational file.

## Auto Egg Spawning

```yaml
trySpawnBossMinutes: -1
autoEggSpawnChance: 100
bossEggExpiration: 15
autoAwakeningDistance: 15
autoAwakeningTicks: 80
```

Key points:

* Set `trySpawnBossMinutes: -1` to disable automatic egg generation.
* Automatic eggs persist across normal server restarts until they expire.
* Only players with `rareitemhunter.hunter.hatch` can auto-awaken nearby eggs.

## Random Egg Placement

```yaml
bossEggAllowedRegions:
  world:
    - __global__
randomEggRadius: 5000
randomEggAttemptsPerWorld: 40
defaultRandomEggWorld: ""
defaultRandomEggRegion: "__global__"
defaultRandomEggCords: "0,0"
```

Key points:

* `bossEggAllowedRegions` limits random egg placement by world and, optionally, by WorldGuard region.
* `__global__` means no region restriction in that world.
* `defaultRandomEggWorld: ""` tells the plugin to pick from configured worlds.

## Boss Behavior

```yaml
bossExpireKills: -1
bossDisappearSound: "ENTITY_WARDEN_DIG"
disableCreativeGodOnFight: false
bossAI:
  defaultMode: "v2"
  v2:
    targetUpdateTicks: 30
    targetRange: 24.0
```

Key points:

* `bossExpireKills` removes a boss after it kills enough players.
* `bossAI.defaultMode: "v2"` enables the smarter target and skill logic by default.
* `disableCreativeGodOnFight` is useful on servers where admins or Essentials users may otherwise trivialize boss fights.

## Loot and Crafting

```yaml
legendaryCompassRecipe:
  - [AIR, GOLD_INGOT, AIR]
  - [IRON_INGOT, COMPASS, DIAMOND]
  - [AIR, EMERALD, AIR]
```

The Legendary Compass supports normal materials and these special recipe tokens:

* `RARE_ESSENCE`
* `DARK_MATTER`
* `CURSED_DIAMOND`
* `LEGENDARY_TRIBUTE`

## Stats Storage

```yaml
statsStorage: "yaml"
statsSaveIntervalSeconds: 5
mysql:
  mode: "single"
  host: "localhost"
  port: 3306
  database: "rih_remaster"
  username: "root"
  password: ""
  tablePrefix: "rih_"
```

Key points:

* Use `yaml` or leave empty for file-based storage.
* Use `mysql` to enable MySQL stat storage.
* Use `off`, `none`, or `disabled` to turn stat tracking off entirely.
* If MySQL fails on startup, the plugin falls back to YAML.
* statsSaveIntervalSeconds controls how often stats are flushed to disk/DB (1-3600, default 5).
* mysql.mode: use single when one server owns the database (in-memory cache); use shared for multi-server setups (additive writes with periodic cache refresh).

## CombatLogX

```yaml
combatLogX:
  tagOnBossCombat: true
  announceLogoutPunish: true
  blockedProperties:
    Fly: true
    DoubleJump: true
    Invisibility: true
```

Key points:

* The section is ignored when CombatLogX is not installed.
* `blockedProperties` lets you disable escape-heavy properties while players are combat tagged.

### Regional Boss Pools

This is a separate, optional auto-spawn system driven by spawn\_pools.yml. When enabled, it replaces the legacy trySpawnBossMinutes spawner with weighted, per-WorldGuard-region boss pools. It requires WorldGuard to be installed.

```
enabled: false
spawning:
  timer-mode: "global"
  global:
    interval-minutes: 60
    chance-percent: 100
pools:
  default:
    bosses:
      SomeBoss: 10
regions:
  arena_a:
    world: "world"
    region: "arena"
    pool: "default"
    priority: 0
    selection-weight: 10
    max-active-encounters: 1
    timer:
      interval-minutes: 30
      chance-percent: 50
```