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

# Configuration

The default config.yml for CrownStoreEvents and an explanation of its content.

## Default config.yml

{% code title="CrownStoreEvents/config.yml" overflow="wrap" lineNumbers="true" expandable="true" %}

```yaml
#
# Thank you for purchasing CrownStoreEvents!
# If you have any questions, suggestions or need help, please do not hesitate and
# join our discord: https://dsc.gg/crowndevelopment to ask for help!
# We are there to assist you.
#
# By purchasing this plugin you are accepting the BBB terms as well as
# our terms that can be found in our discord.
#

# you can obtain your license in our discord! https://dsc.gg/crowndevelopment
# paste your license key in here
license: paste-here

debug-mode: false # enable this to send various messages to console

##################################################################
#                       DATA CONFIGURATION                       #
#                    dsc.gg/crowndevelopment                     #
##################################################################
storage:
  method: h2 # you can choose between H2 and MySQL and MariaDB. MySQL and MariaDB are recommended
  data:
    host: crownhost
    database: crowndatabase
    username: crownuser
    password: "crownpassword"

    # sets the maximum size of the MySQL connection pool.
    #   https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing

    pool-settings:
      maximum-pool-size: 10
      minimum-idle: 10
      maximum-lifetime: 1800000
      keepalive-time: 0
      connection-timeout: 5000

##################################################################
#                      EVENT CONFIGURATION                       #
#                    dsc.gg/crowndevelopment                     #
##################################################################
events: # visit the wiki to learn how to create an event

##################################################################
#                   PROGRESS BAR CONFIGURATION                   #
#                    dsc.gg/crowndevelopment                     #
##################################################################
progress-bar: # this is used as the default if the event does not have a specific configuration set
  percentage: 2.0 # the percentage a single bar represents - double from 1 to 100
  display-mode: solid # you can choose between solid and gradient
  full: "&a|" # the bar that is reached
  empty: "&c|" # the bar that is not reached yet
  gradient: "#ffffff:#000000" # separate the two hex codes with a :
```

{% endcode %}

***

## What these values mean

### license

* `license`: Your license key. You can find everything you need to know about the license system [here](https://obey.gitbook.io/wiki/core/guides/our-license-system).

### debug-mode

* `debug-mode`: Either `true` or `false`. Toggles debug messages in the console. Can also be toggled with `/cse debug`.

### storage

* `storage`:
  * `method`: You can choose between `H2`, `MySQL`, and `MariaDB`. Using `MySQL` or `MariaDB` requires configuring the `data` section below.
  * `data`:
    * `host`: Hostname or IP address of your database server.
    * `database`: Name of the database schema.
    * `username`: Database user for authentication.
    * `password`: Password for authentication.
    * `pool-settings`: HikariCP connection pool settings (learn more [here](https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing)):
      * `maximum-pool-size`: Maximum total number of active/idle connections in the pool.
      * `minimum-idle`: Minimum number of idle connections maintained.
      * `maximum-lifetime`: Maximum lifetime of a connection before retirement (in milliseconds).
      * `keepalive-time`: Frequency of heartbeat pings for idle connections (in milliseconds; `0` to disable).
      * `connection-timeout`: Maximum wait time for acquiring a connection before throwing an error (in milliseconds).

### events

* `events`: This section contains all configured store events. Read the [How to setup an event](https://obey.gitbook.io/wiki/storeevents/how-to-setup-an-event.md) guide for full setup instructions.

### progress-bar

* `progress-bar`: Global default progress bar configuration used whenever an event does not specify its own custom `progress-bar` section.
  * `percentage`: The percentage each bar unit represents (e.g. `5.0` creates 20 total bars for 100%).
  * `display-mode`: `solid` or `gradient`. Solid uses the color code in `full` and `empty`. Gradient generates color steps across the reached bars. *(Note: For gradient mode, omit color codes from the `full` string).*
  * `full`: Character or string representing reached progress units.
  * `empty`: Character or string representing unreached progress units.
  * `gradient`: Hex color codes separated by colons (e.g. `#ffffff:#000000` or `#ff0080:#00ff00:#0000ff`).
