> For the complete documentation index, see [llms.txt](https://imshadows-organization.gitbook.io/ryzenclans-or-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://imshadows-organization.gitbook.io/ryzenclans-or-wiki/configurations/config.yml.md).

# Config.yml

<pre class="language-yaml" data-line-numbers><code class="lang-yaml">#####################################################################################
# ■━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━■ #
# ┃                                                                               ┃ #
<strong># ┃ ██████╗ ██╗   ██╗███████╗███████╗███╗   ██╗ ██████╗██╗      █████╗ ███╗   ██╗ ┃ #
</strong># ┃ ██╔══██╗╚██╗ ██╔╝╚══███╔╝██╔════╝████╗  ██║██╔════╝██║     ██╔══██╗████╗  ██║ ┃ #
# ┃ ██████╔╝ ╚████╔╝   ███╔╝ █████╗  ██╔██╗ ██║██║     ██║     ███████║██╔██╗ ██║ ┃ #
# ┃ ██╔══██╗  ╚██╔╝   ███╔╝  ██╔══╝  ██║╚██╗██║██║     ██║     ██╔══██║██║╚██╗██║ ┃ #
# ┃ ██║  ██║   ██║   ███████╗███████╗██║ ╚████║╚██████╗███████╗██║  ██║██║ ╚████║ ┃ #
# ┃ ╚═╝  ╚═╝   ╚═╝   ╚══════╝╚══════╝╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝ ┃ #
# ■━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━■ #
#                                                                                   #
#  Discord: https://discord.gg/RKu7vfwtRW                                           #
#  Author: ImShadow                                                                 #
#                                                                                   #
#####################################################################################

#####################################################################################
#                                                                                   #
#  ■─────────────────────────────────────────────────────────────────────────────■  #
#  │                                                                             │  #
#  │  Recommendation:                                                            │  #
#  │    For large servers with 200+ users, MySQL is recommended.                 │  #
#  │    For servers with 50+ users, SQLite is recommended.                       │  #
#  │                                                                             │  #
#  ■─────────────────────────────────────────────────────────────────────────────■  #
#                                                                                   #
#####################################################################################

database:
  type: sqlite
  host: localhost
  port: 3306
  name: ryzenclans
  username: root
  password: password
  pool-size: 8

clan:
  max-size: 25
  max-allies: 2
  min-name-length: 3
  max-name-length: 6
  max-description-length: 100
  ally-request-cooldown: 30
  join-request-cooldown: 30
  allow-colors: true
  allowed-color-codes:
    - '0'
    - '1'
    - '2'
    - '3'
    - '4'
    - '5'
    - '6'
    - '7'
    - '8'
    - '9'
    - 'a'
    - 'b'
    - 'c'
    - 'd'
    - 'e'
    - 'f'
    - 'l'
  allow-numbers: false
  blocked-words:
    - admin
    - staff
    - owner
    - mod
    - helper
  blocked-characters:
    - '@'
    - '#'
    - '$'
    - '%'
    - '^'
    - '&#x26;'
    - '*'
    - '('
    - ')'
    - '['
    - ']'
    - '{'
    - '}'
    - '/'
    - '|'
    - '&#x3C;'
    - '>'
    - '?'
    - '!'
    - '='
    - '+'
    - '~'
    - '`'
  blocked-regex: ""

home:
  enabled: true
  teleport-delay: 5

bank:
  enabled: true
  max-balance: 0  # 0 = unlimited

points:
  kill-points: 1 # |- Points per kill
  death-points: 1 # |- Points deducted upon death
  death-penalty-enabled: true  # |- Enable/disable point loss on death
  max-kills-per-player: 5 # |- Anti-boosting: max kills against the same player
  reset-time-hours: 24 # |- Hours to reset anti-boosting counter
  points-without-clan: true # |- true = Only count points when killing players WITH a clan | false = Count points when killing any player
  points-with-ally: false # |- true = DO NOT count points when killing allies | false = Count points when killing allies (normal)
  points-players-without-armor: false  # |- true = DO NOT count points if the player has no armor | false = Count points regardless of armor (normal)

clan-format:
  prefix: "&#x26;8[%clan_prefix%&#x26;8]" # |- Format for %ryzenclans_clan_prefix%
  name: "%clan_name%" # |- Format for %ryzenclans_clan_name%
  tag: "&#x26;7[%clan_prefix%&#x26;7]" # |- Format for %ryzenclans_clan_tag%

# ------------------------------------------
# Colors for clan relationships
#   These colors are automatically applied in placeholders when relationships exist
#   If there is NO relationship (neutral), the clan's original color is kept | %rel_ryzenclans_rel_clan_name%
# ------------------------------------------
clan-colors:
  same: "&#x26;a"
  ally: "&#x26;b"
  enemy: "&#x26;c"
  focused: "&#x26;d"
  neutral: "&#x26;f"

# ------------------------------------------
# Optional LunarClient dependency
# Required: https://www.spigotmc.org/resources/api-apollo.116331/
# ------------------------------------------
lunar:
  team-viewer: true
  waypoints: true
  rally-duration: 300

no-clan-display:
  name: "✘" # Name shown when player has no clan
  prefix: "&#x26;c&#x26;l✘" # Prefix shown when player has no clan
  color: "&#x26;7" # Color for players without a clan

# ------------------------------------------
# How often the top-clan placeholder cache refreshes (in seconds)
# ------------------------------------------
top-cache-refresh-seconds: 60
</code></pre>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://imshadows-organization.gitbook.io/ryzenclans-or-wiki/configurations/config.yml.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.