# Config.yml Tutorial

<pre class="language-yaml"><code class="lang-yaml"># Enables or disables the plugin update message when joining the server.
update_notify: true

# This option defines the time (in seconds) to automatically save
# player data.
player_data_save_time: 300

# List of worlds where the plugin should/shouldn't work.
# When blacklist is true:
#   - MineWords will be blocked in worlds under the 'list' option.
# When blacklist is false:
#   - MineWords will be allowed only in worlds under the 'list' option.
enabled_worlds:
  blacklist: true
  list:
    - survival
    - nether

# Whether the amount value of each Word Item should be changed depending on the number of the word.
modify_words_amount: true

# Whether the next word must be automatically selected when a word is found.
auto_select_next_word: true

# Whether the scroll up/down buttons should be placed in the inventory only if the level has
# more than 7 words.
scroll_buttons_only_if_necessary: false
<strong>
</strong># Common sounds
# Format: &#x3C;sound>;&#x3C;volume>;&#x3C;pitch>
# Set it to 'none' if you don't want to play a sound.
# You can find a list of sounds here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
<strong># You can also use resource pack sounds.
</strong><strong>sounds:
</strong>  wrong_word: BLOCK_NOTE_BLOCK_PLING;1;0.1
  correct_word: BLOCK_NOTE_BLOCK_PLING;1;2
  all_words_found: ENTITY_PLAYER_LEVELUP;1;1
  scroll: UI_BUTTON_CLICK;1;1
  write: BLOCK_NOTE_BLOCK_HAT;1;2
  remove_last_letter: UI_BUTTON_CLICK;1;0.2
  word_of_the_day_enter: ENTITY_FIREWORK_ROCKET_BLAST;1;1.5

# Format of the %progress% variable on the lore of category items.
progress_bar_placeholder:
  filled_symbol: "&#x26;a|"
  empty_symbol: "&#x26;c|"
  amount: 20

# Defines if every message/text in the plugin should use the MiniMessage format.
# Only works on Paper 1.19.4+.
use_minimessage: false

# MySQL support credentials
mysql_database:
  enabled: false
  host: localhost
  port: 3306
  username: root
  password: root
  database: minewords

# Common items for the level inventory
# More info below
common_items:
 
# Character items, you can even create our own
# More info below
characters_items:

</code></pre>

## Common Items

These are items used on the different inventories of the plugin. Remember to use the [**ITEMS** ](/minewords/items.md)properties.

### Select Word: Selected

Item placed when a word line is selected and can be written on.

You can use the following variables:

* %number%: Number of the current word line.
* %max%: Max word lines.
* %guess%: Current word guess

```yaml
select_word:
    selected:
      id: BLACK_STAINED_GLASS_PANE
      name: "#ddddddWord &e%number%&8/&e%max%"
      lore:
        - "%hint%"
        - ""
        - "#ddddddCurrent guess: &e%guess%"
        - ""
        - "&c&lCLICK to deselect word."
      enchants:
        - "ARROW_INFINITE;1"
      item_flags:
        - HIDE_ENCHANTS
```

### Select Word: Not Selected

Item placed when a word line is not selected. Player must click on this item to select the line.

You can use the following variables:

* %number%: Number of the current word line.
* %max%: Max word lines.
* %guess%: Current word guess

<pre class="language-yaml"><code class="lang-yaml">select_word:
<strong>    not_selected:
</strong>      id: BLACK_STAINED_GLASS_PANE
      name: "#ddddddWord &#x26;e%number%&#x26;8/&#x26;e%max%"
      lore:
        - "%hint%"
        - ""
        - "#ddddddCurrent guess: &#x26;e%guess%"
        - ""
        - "&#x26;a&#x26;lCLICK to select the word and"
        - "&#x26;astart guessing."
</code></pre>

### No Letter

Item placed on a word line, where there is no character/letter.

```yaml
no_letter:
    id: BARRIER
    name: " "
```

### Letter To Find

Item placed on a word line, where there is a character/letter to be found.

```yaml
letter_to_find:
    id: PLAYER_HEAD
    name: "&c??"
    skull_data:
      texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDNiNTAwMWE2NzAwN2E5M2FkZTY2NTkxNzVlOTA1NGE5Mjk3NmIwODdmYzYyOWYwNDJiY2Q1N2U3NzU3NjQ2YSJ9fX0=
```

### Letter To Find Hidden Column

Item placed on a word line, where there is a character/letter to be found that is part of the hidden column.

```yaml
letter_to_find_hidden_column:
    id: PLAYER_HEAD
    name: "&c??"
    skull_data:
      texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYWIyY2RmNDgxNzQ3ZjExOTkzNjQ3OTM3ZTljNDg5ZDhiZWJjYWY1ZjJkODg2ZmQ5OGMyMDMyODQ0ZDEifX19
```

### Wrong Word

Item placed on the word line when the player guesses wrong.

```yaml
wrong_word:
    id: RED_TERRACOTTA
    name: " "
```

### Scroll Words Down

Item to use to show the next word lines. You can also modify the `inventory_slot` property to change the position of this item on the player inventory.

```yaml
scroll_words_down:
    item:
      id: PLAYER_HEAD
      name: "&eScroll Down"
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMmFlNDI1YzViYTlmM2MyOTYyYjM4MTc4Y2JjMjMxNzJhNmM2MjE1YTExYWNjYjkyNzc0YTQ3MTZlOTZjYWRhIn19fQ==
    inventory_slot: 1
```

### Scroll Words Up

Item to use to show the previous word lines. You can also modify the `inventory_slot` property to change the position of this item on the player inventory.

```yaml
scroll_words_up:
    item:
      id: PLAYER_HEAD
      name: "&eScroll Up"
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjQ2MjhhY2U3YzNhZmM2MWE0NzZkYzE0NDg5M2FhYTY0MmJhOTc2ZDk1MmI1MWVjZTI2YWJhZmI4OTZiOCJ9fX0=
    inventory_slot: 0
```

### Remove Last Letter

Item to remove the last letter of the selected word. You can also modify the `main_game_inventory_slot` and `word_of_the_day_inventory_slot` properties to change the position of this item on the player inventory.

```yaml
remove_last_letter:
    item:
      id: PLAYER_HEAD
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzNlNGI1MzNlNGJhMmRmZjdjMGZhOTBmNjdlOGJlZjM2NDI4YjZjYjA2YzQ1MjYyNjMxYjBiMjVkYjg1YiJ9fX0=
      name: "&cRemove Last Letter"
    main_game_inventory_slot: 2
    word_of_the_day_inventory_slot: 0
```

### Quit Level

Item to use to leave the current level. You can also modify the `inventory_slot` property to change the position of this item on the player inventory.

```yaml
quit_level:
    item:
      id: NETHER_STAR
      name: "&cQuit Level"
    inventory_slot: 8
```

## Characters Items

These are the items part of the alphabet the player is allowed to use when writing words. You can create your own character following this format:

```yaml
<character>:
  normal:
  hidden:
  ready:
  not_in_word:
  inventory_slot:
```

### Normal Character Item

Corresponds to the character item placed on a word line. Also, it is the item placed on the player inventory. Usually color white.

```yaml
normal:
      id: PLAYER_HEAD
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNGU0MTc0ODEyMTYyNmYyMmFlMTZhNGM2NjRjNzMwMWE5ZjhlYTU5MWJmNGQyOTg4ODk1NzY4MmE5ZmRhZiJ9fX0=
      name: "&f&lA" 
```

### Hidden Character Item

Corresponds to the character item placed on the position of a hidden word.&#x20;

It is also used in the **Word of the Day** minigame. This item will represent a character found in the word but in an incorrect position. Usually color yellow.

```yaml
hidden:
      id: PLAYER_HEAD
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMTdlZjI4ZGU4ZTJhY2NkY2IyM2IwOTQyZjU2MjRmNDE0OWE1YWE0OTBlYzE5ZjdkYzQ5OTFhODUwYjY1ZjQwIn19fQ==
      name: "&e&lA"
```

### Ready Character Item

Corresponds to the character item placed on a word that is correct.&#x20;

It is also used in the **Word of the Day** minigame. This item will represent a character found in the word in the correct position. Usually color green.

```yaml
ready:
      id: PLAYER_HEAD
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjBhZmQ3NzdkNTU3YTIwN2JhYzdhYWQ4NDIxZmRmNzg4ZDY2ODU4NzNjNDk1MTVkNTUyOTFlOTMwNjk5ZiJ9fX0=
      name: "&a&lA" 
```

### Not In Word Item

This item is only used in the **Word of the Day** minigame. Will represent a character not found in the word. Usually color gray.

```yaml
not_in_word:
      id: PLAYER_HEAD
      skull_data:
        texture: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMWE3NGQ5MjEyZTY0OTFiYzM3MGNhZjAyNWZkNDU5ZmU2MzJjYTdjNmJhNGRmN2ViZWZhZmQ0ODlhYjMyZmQifX19
      name: "&7&lA"
```

### Inventory Slot

Position of the player inventory where this character item will be placed.\
All slots here: <https://mcutils.com/inventory-slots>

```yaml
inventory_slot: 19
```


---

# 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://ajneb97.gitbook.io/minewords/config.yml-tutorial.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.