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

# Configuration

A simple guide about how to setup the main configuration

```
messages-format: "legacy" # Available: Legacy, Minimessage
model-provider: "modelengine" # Available: ModelEngine, ItemsAdder
options:
  screen-effect:
    character: 'ざ'
    on-start:
      in: 10
      keep: 3
      out: 15
    on-finish:
      in: 10
      keep: 1
      out: 15
```

## Settings

* messages-format
  * Sets the format of message.yml. If you don't know what is MiniMessage, I would really recommend to set the value to "legacy".
* screen-effect
  * An effect that makes a fading blackscreen like in cinematics
* model-provider
  * A plugin that handles the models.
  * Possible values are:
    * ModelEngine
    * ItemsAdder

### Screen-Effect

#### Types

* on-start
  * the effect is played when a player click on a crate with a key
* on-finish
  * the effect is played when the animation ends

#### Options

* character
  * a character from your Resource-Pack that holds the black-screen texture
* in
  * fade-in of the effect
* stay
  * for how long should the black-screen stay
* out
  * fade-out of the effect