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

# Configuration

The first time Sea Of Steves is run, configuration files will be created in the */plugins/SeaOfSteves* directory. At the bare minimum, you must specify which worlds you wish to use the plugin with in the `sos.worlds` node of the *config.yml* file. DO NOT USE DEFAULT WORLDS on Paper servers unless you also the disable the `multiverse-reset` function. Then, either restart or run the **/sos reload** command.

{% hint style="info" %}
Opening a .yml file that contains non-English characters on an English computer may not display those characters correctly. In the case of Windows, this is because Windows in English uses the ANSI character set, while the preferred format is UTF-8. Unfortunately, Windows makes this difficult to change, so we recommend an editing program that supports UTF-8. [Notepad++](https://notepad-plus-plus.org/) is a free and popular choice.
{% endhint %}

### boss.yml

Settings for boss encounters, such as biomes to spawn in, drops upon defeat, total health and respawn time, and whether to display a bossbar. You may also specify a MythicMobs creature to use instead, whereas most settings will be dictated by MythicMobs instead.

{% hint style="info" %}
Please note that only one (1) boss is included with Sea of Steves as of writing.
{% endhint %}

### chance.yml

Contains probabilities for certain events like mob spawning. For example, a value of 250 means 1/250 chance to occur, when applicable.

### config.yml

The main configuration file. All keys are prefixed by `sos.` and some require dependencies.

| Key                             | Description                                                                                                                     |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `creatures.enabled`             | Whether to allow replacement of normal mob spawns with catered selection                                                        |
| `creatures.name-captain`        | Name of uncommon Wither Skeleton captain                                                                                        |
| `eruption.enabled`              | Whether to allow random falling tephra upon players in supported biomes                                                         |
| `eruption.material`             | Bukkit enum Material for display entity texture                                                                                 |
| `eruption.start-height`         | How many blocks above player to spawn                                                                                           |
| `eruption.cancel-drop`          | Whether to disallow explosions from dropping blocks                                                                             |
| `evenmorefish.enabled`          | Whether to allow EvenMoreFish integration, developed for use with [Tidal Towns](/sea-of-steves/world/ocean.md#tidal-towns)      |
| `fishmongers.enabled`           | Whether to allow Villagers to be used as trading Fishmongers                                                                    |
| `fishmongers.name`              | Name of spawned Fishmonger villagers                                                                                            |
| `fishmongers.reward`            | Amount to reward per item traded                                                                                                |
| `fishmongers.use-vault`         | Whether to use in-game money via Vault                                                                                          |
| `general.block-explode`         | Whether to allow block explosion                                                                                                |
| `general.cooldown-scuttle`      | Number of seconds player must wait after `/sos scuttle` command                                                                 |
| `mcpets.enabled`                | Whether to allow MCPets integration                                                                                             |
| `merchants.enabled`             | Whether to allow Villagers to be used as trading Merchants                                                                      |
| `merchants.name`                | Name of spawned Merchant villagers                                                                                              |
| `merchants.reward`              | Amount to reward per item traded                                                                                                |
| `merchants.use-vault`           | Whether to use in-game money via Vault                                                                                          |
| `multiverse-reset.enabled`      | Whether to allow reset of world upon timer expiration via Multiverse-Core                                                       |
| `multiverse-reset.use-bossbar`  | Whether to allow timer to show via bossbar (note: you can also use PlaceholderAPI with `%sos_reset_timer_<worldName>%).`        |
| `multiverse-reset.regen-hours`  | Number of hours between world regeneration                                                                                      |
| `multiverse-reset.purge-dynmap` | Whether to allow specified `worlds` to have their Dynmap data purge upon timer reset (note: does not populate new chunks)       |
| `phatloot.enabled`              | Whether to allow chest loot via PhatLoots                                                                                       |
| `phatloot.name-barrel`          | Name of PhatLoots loot table for Barrels                                                                                        |
| `phatloot.name-chest`           | Name of PhatLoots loot table for Chests                                                                                         |
| `tamers.enabled`                | Whether to allow Villagers to be used as pet Tamers                                                                             |
| `tamers.name`                   | Name of spawned Tamer villagers                                                                                                 |
| `tamers.material`               | Item accepted by tamers as currency                                                                                             |
| `tamers.buy-limit`              | Limit on number of pets per player                                                                                              |
| `vots.enabled`                  | Whether to allow Voyage of the Seas                                                                                             |
| `vots.ships`                    | List of allowed VOTS ship names                                                                                                 |
| `worlds`                        | List of allowed worlds for Sea of Steves (note: do not use default worlds unless you also disallow `multiverse-reset.enabled`). |

### gear.yml

Here you may specify which gameplay items you would like enabled, as well as their names, lore, and which hotbar slot (0-8) you would like them to occupy. Additionally, the Longbow has a `slot-arrow` node which specifies which slot is used for momentary arrow storage, where -1 indicates total inventory size minus one (typically the off-hand slot).

### strings.yml

This file contains all player-facing text within Sea of Steves. You may change these strings to your liking. Any new lines in future updates will be appended to the file automatically.

### /timers

Files within this folder contain the start times for resetting game worlds. If you would like to reset the timer for one of your worlds, shut down the server and delete the respective file. Manually editing these files is not supported.
