# Configuration

## Default config.yml

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

```yml
#
# 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:
  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.

### storage

* `storage`:
  * `method`: You can choose between `H2`, `MySQL` and `MariaDB`. Using `myslq` or `mariadb` will require configuration of the next `data` segment.
  * `data`:
    * `host`: Hostname of you database.
    * `database`: Logical name of your database
    * `username`: Username for authentication.
    * `password`: Password for authentication.
    * `pool-settings`: You can read more about pool settings [here](https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing).
      * `maximum-pool-size`:
      * `maximum-idle`:
      * `maximum-lifetime`:
      * `keepalive-time`:
      * `connection-timeout`:

### events

* `events`: This section contains all the configuration for your store events.

### progress-bar

* `progress-bar`:
  * `percentage`: The percentage one bar represents. Ex: 5 - Meaning one bar is 5%, so there will be a total of 20 bars. Why ? Because that adds up to 100.
  * `display-mode`: You can choose between `SOLID` and `GRADIENT`. Solid: One Color for Full Bars and one for Empty bars. Gradient: A gradient of colors for the full bars. IMPORTANT: You need to remove the color from the `full` section for the gradient mode.
  * `full`: The string that represents a full bar.
  * `empty`: The string that represents an empty bar.
  * `gradient`: A string containing hex color codes separated with a `:` to build the gradient.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://obey.gitbook.io/wiki/storeevents/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.