# Configurations

<h2 align="center"><mark style="color:purple;"><strong>Configurations</strong></mark></h2>

<p align="center"><mark style="color:$primary;">The main configuration file,</mark> <code>config.yml</code><mark style="color:$primary;">, allows you to customize the general settings, messages, and appearance of the FisFisItemEvolve plugin. This file is automatically generated in your</mark> <code>/plugins/FisFisItemEvolve/</code> <mark style="color:$primary;">folder the first time you start the server with the plugin.</mark></p>

<h3 align="center"><mark style="color:purple;"><strong>Default</strong><strong> </strong><strong><code>config.yml</code></strong></mark></h3>

<p align="center"><mark style="color:$primary;">Here is a view of the default configuration file for quick reference. Each option is explained in detail below.</mark></p>

```yaml
###############################################
##### FisFisItemEvolve Configuration File #####
###############################################

# Set this to enabled to add an approval process before items are evolved.
evolve-confirmation: "disabled"

# The title of the menu opened with the /evolve command.
evolve-menu-title: "&8&l» &5&lEvolution Path &8&l«"

# The item that represents the progress in the /evolve menu.
evolve-menu-progress-item:
  material: "ARROW"
  name: "&5&lProgress Status"
  # Available placeholders: %current%, %target%
  lore:
    - "&5Current Points: &d%current%"
    - "&5Required Points: &d%target%"
    - ""
    - "&9Keep evolving!"
  
# Only appears when evolve-confirmation is enabled.
evolve-menu-confirmation-item:
  material: "LIME_STAINED_GLASS_PANE"
  name: "&2&l✔ Start Evolution"
  lore:
    - "&7click to start the evolution"
    - "&7process of this item."
    - ""
    - "&e⚠ &cWarning: &ethis cannot be undone!"

# The format of the progress text that will appear on the item's lore.
# Available placeholders: %current%, %target%
progress-lore: "&5&lEvolution Progress: &d&l%current% &5&l/ &d&l%target%"

# Settings for when an item evolves.
evolve:
  message:
    enabled: true
    # Messages to be sent to the player (each line is a separate message).
    messages:
      - "&5&lCONGRATULATIONS!"
      - "&dYour item has successfully evolved!"
  title:
    enabled: true
    # The main title that will appear on the player's screen.
    text: "&5&lITEM EVOLVED"
  subtitle:
    enabled: true
    # The subtitle that will appear below the main title.
    text: "&dEnjoy your new power!"

# Various messages sent by the plugin.
messages:
  no-evolution-path: "&cThe item in your hand has no evolution path."
```

<details>

<summary><mark style="color:purple;"><strong>evolve-menu-title</strong></mark></summary>

<mark style="color:$primary;">Sets the title of the gui menu opened with the /evolve command.</mark>

</details>

<details>

<summary><mark style="color:purple;"><strong>evolve-confirmation</strong></mark></summary>

<mark style="color:$primary;">By setting this setting to enabled, it introduces a requirement for confirmation before items evolve. The confirmation is done via the menu opened using the /evolve command.</mark>

</details>

<details>

<summary><mark style="color:purple;"><strong>evolve-menu-progress-item</strong></mark></summary>

<mark style="color:$primary;">Sets the properties of the icon that shows the progress information in the evolve menu.</mark>

* <mark style="color:purple;">%current%</mark> <mark style="color:$primary;">the placeholder indicates the current evolutionary progress of the item</mark>
* <mark style="color:purple;">%target%</mark> <mark style="color:$primary;">The placeholder indicates the progress required for the item to evolve.</mark>

</details>

<details>

<summary><mark style="color:purple;"><strong>evolve-menu-confirmation-item</strong></mark></summary>

<mark style="color:$primary;">The confirmation process to start the evolution is done by clicking on this icon. The icon only appears when the evolve-confirmation setting is enabled.</mark>

</details>

<details>

<summary><mark style="color:purple;"><strong>progress-lore</strong></mark></summary>

<mark style="color:$primary;">Sets how the progress indicator that will appear in the item lore looks like.</mark>

</details>

<details>

<summary><mark style="color:purple;"><strong>evolve</strong></mark></summary>

<mark style="color:$primary;">Sets the methods for notifying the player when an item evolves.</mark>

* <mark style="color:purple;">message:</mark> <mark style="color:$primary;">It keeps a list of messages that will be sent to the player when the item evolves from the chat.</mark>
* <mark style="color:purple;">title:</mark> <mark style="color:$primary;">Sets the text that will be sent to the player's screen when the item evolves.</mark>
* <mark style="color:purple;">subtitle:</mark> <mark style="color:$primary;">Sets the text that appears under the text that appears on the player's screen when the item evolves.</mark>

</details>

<details>

<summary><mark style="color:purple;">messages</mark></summary>

<mark style="color:$primary;">sets the messages that the plugin will send to players.</mark>

</details>


---

# 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://fisfis.gitbook.io/fisfisitemevolve/configurations/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.