> 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/quick-start.md).

# Quick Start

This path gets the plugin live quickly without covering every advanced option.

{% stepper %}
{% step %}

### Enable Automatic Egg Spawning

In `config.yml`:

```yaml
trySpawnBossMinutes: 60
autoEggSpawnChance: 100
bossEggExpiration: 15
```

This attempts one automatic egg spawn every hour and keeps the egg active for 15 minutes.
{% endstep %}

{% step %}

### Choose Where Eggs Can Spawn

If you use WorldGuard:

```yaml
bossEggAllowedRegions:
  world:
    - wilderness
    - arena
```

If you do not use WorldGuard, keep `__global__`:

```yaml
bossEggAllowedRegions:
  world:
    - __global__
```

{% endstep %}

{% step %}

### Give Hunters Access

Grant players:

* `rareitemhunter.hunter.hatch`
* `rareitemhunter.hunter.compass`
* `rareitemhunter.hunter.craft`
  {% endstep %}

{% step %}

### Give a Compass

Use:

```
/rih compass <player>
```

or:

```
/boss compass <player>
```

{% endstep %}

{% step %}

### Spawn a Test Egg

Use:

```
/rih egg random here
```

This lets you verify egg spawning, awakening, and boss combat immediately.
{% endstep %}

{% step %}

### Review Drops and Crafting

Boss drops are defined in `bosses.yml`. Rare item properties, recipes, costs, and cooldowns are defined in `rares.yml`.
{% endstep %}

{% step %}

### Reload After Changes

Use:

```
/rih reload
```

No server restart is required for normal config edits.
{% endstep %}
{% endstepper %}