Config.yml Tutorial
# 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
# Common sounds
# Format: <sound>;<volume>;<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
# You can also use resource pack sounds.
sounds:
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: "&a|"
empty_symbol: "&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:
Common Items
These are items used on the different inventories of the plugin. Remember to use the ITEMS 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
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
No Letter
Item placed on a word line, where there is no character/letter.
Letter To Find
Item placed on a word line, where there is a character/letter to be found.
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.
Wrong Word
Item placed on the word line when the player guesses wrong.
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.
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.
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.
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.
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:
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.
Hidden Character Item
Corresponds to the character item placed on the position of a hidden word.
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.
Ready Character Item
Corresponds to the character item placed on a word that is correct.
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.
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.
Inventory Slot
Position of the player inventory where this character item will be placed. All slots here: https://mcutils.com/inventory-slots
Last updated