# Configuration

### Description

This page contains the default config.yml.

### Default config file

```yaml
#
# Thank you for purchasing CrownTebexData!
# 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

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

##################################################################
#                       DATA CONFIGURATION                       #
#                    dsc.gg/crowndevelopment                     #
##################################################################

storage:
  method: h2 # you can choose between h2 and mysql and mariadb
  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

store:
  provider: manual # you can choose between: tebex, craftingstore, manual
  secret: paste-here

# how to find your secret
# on tebex: Tebex Dashboard -> Integrations > Gameservers > Show Secret Key > Secret Key
# on crafting store: Dashboard -> Webstore > Servers > Reveal Token
# on manual: not needed

# when running the plugin on multiple servers, you can disable this so only
# one server will fetch the data and handle logic, the others will only read from the database
# this only works when storage.method is set to mysql or mariadb
fetch-data: true

# this will replace the playername for offline players in the embed image url with the name set in messages.yml under embed-purchase-offline-skin
enable-offline-mode: false

# how many payments the plugin should read with each update looking for new payments
payment-check-amount: 10

interval:
  payment-data-update: 30 # how often the plugin will send requests to tebex, updating its payment and goal data in seconds (0 to disable)
  sales-data-update: 0 # how often the plugin will send requests to tebex, updating its sales data in seconds (0 to disable)
  ranking-data-update: 30 # how often the plugin will update the rankings in seconds (0 to disable)
  sale-reminder: 0 # Time until the active sale reminder is sent in seconds (0 to disable)

##################################################################
#                     PURCHASE CONFIGURATION                     #
#                    dsc.gg/crowndevelopment                     #
##################################################################
commands:
  on-purchase: [] # commands that are executed after every purchase
  on-update: [] # commands that are executed after every data update

# date format is: yyyy-MM-dd
ignore-payments-older-than: "2000-01-01"

# Purchases with a value below this amount will not be broadcasted in game.
min-amount-for-broadcast: 0

##################################################################
#                  COMMUNITY GOAL CONFIGURATION                  #
#                    dsc.gg/crowndevelopment                     #
##################################################################
goal:
  mode: internal # you can choose between: internal, external
  bar:
    percentage: 2.0 # the percentage a single bar represents - Double from 1 to 100 #
    full: "&a|" # the bar that is reached
    empty: "&c|" # the bar that is not reached yet
  completion-commands: [] # these commands are executed after a goal is completed
  milestones: [] # percentages that will count as a milestone towards the community goal

##################################################################
#                  DISCORD WEBHOOK CONFIGURATION                 #
#                    dsc.gg/crowndevelopment                     #
##################################################################
webhook:
  enabled: false
  url: url-here
  embeds:
    purchase: false
    goal: false
    sale: false

##################################################################
#                     GG WAVE CONFIGURATION                      #
#                    dsc.gg/crowndevelopment                     #
##################################################################
gg-wave:
  enabled: false
  duration: 10 # duration of the ggwave in seconds
  trigger-text: "gg" # the text players have to type for the gg wave
  min-amount: 0 # this is the minimum a player has to spend to start a ggwave
  design:
    type: RAINBOW # choose from: RAINBOW, SOLID, SOLIDRAINBOW, GRADIENT
    bold: false
    solid-color: ""
    solid-rainbow-colors: []
    gradient: "#ffffff:#000000" # seperate the two codes with a :
  commands: # the commands that are executed when a player types to receive a reward
    - "eco give %player% 100"

##################################################################
#                     FIREWORK CONFIGURATION                     #
#                    dsc.gg/crowndevelopment                     #
##################################################################
fireworks:
  enabled: false
  mode: player # you can choose between player and all
  power: 1
  effects:
    BALL_LARGE:
      colors:
        - "#34eb7d"
        - "#ec40ff"
        - "#4046ff"
      flicker: true
      trail: true

##################################################################
#                    BLACKLIST CONFIGURATION                     #
#                    dsc.gg/crowndevelopment                     #
##################################################################
# purchases made under any name in this list won't be displayed in game or in discord
# all names have to be in lower case
# they will still be loaded into the system, calculated in ranking etc
blacklist:
  enabled: false
  names:
    - obeeyyyy
```


---

# 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/legacy-wiki/plugins/crowntebexdata/configuration.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.
