Interactions
  • Interactions Wiki
  • How to Start
  • Creating a Conversation: Inventory
  • Creating a Conversation: Config
  • Conversation Entities Properties
  • Conversation Properties
  • Dialogues Properties
  • Options Properties
  • Actions
  • Requirements
  • Commands and Permissions
  • Config.yml File
  • Messages.yml File
  • PlaceholderAPI Variables
  • Keywords
    • Conversation Entity
    • Conversation
    • Dialogue
    • Option
  • FAQ
    • FAQ
  • API
    • API Methods and Events
  • FULL EXAMPLES
    • Quests Example
    • Influence Example
    • Options in Dialogue Example
Powered by GitBook
On this page

Was this helpful?

Config.yml File

You can modify different options in the config.yml file of the plugin, here you will find information about all of these options.

# Set to false if you don't want OP players to receive notifications
# of plugin updates in chat when joining the server.
update_notification: true

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

# If players will be able to use the chat or write commands 
# while in a conversation or not.
allow_chat_while_in_conversation: false
allow_commands_while_in_conversation: false

# If players will be able to use their inventory while in
# a conversation.
allow_inventory_interact_while_in_conversation: true

# When is set to false, mobs will not target and attack players
# inside a conversation.
allow_mob_damage: false

# This option defines how players need to click on a Citizens NPC
# to start a conversation.
# RIGHT_CLICK = Just right clicking the NPC.
# SHIFT_RIGHT_CLICK = Right clicking the NPC while sneaking.
# ALL_RIGHT_CLICK = Both will work.
# SWAP_HAND_CLICK = Pressing the swap hand key (F) by looking at the NPC. This
# option only works on 1.9+.
conversation_start_click_type: RIGHT_CLICK

# This option defines which messages do you want to block for
# players in a conversation.
# NONE = No messages are blocked
# CHAT = Only player chat messages are blocked
# ALL = All messages in chat are blocked, including the ones from other
# plugins, announcements, join/leave messages, etc... (Requires ProtocolLib)
hide_chat_while_in_conversation_type: NONE

# When this option is enabled and hide_chat_while_in_conversation_type 
# is set to ALL, all blocked/hidden messages will be sent again to the 
# player when the conversation ends.
send_back_hidden_chat: true

# If allow_commands_while_in_conversation option is set to false
# these commands will be allowed.
commands_whitelist:
- "/login"
- "/help"

# Set it to true if you want players to be able to click on the
# options in the chat to continue with the dialogue.
clickable_options: true

# When this option is set to true, players will need to use 'W' and
# 'S' keys to choose an option and SNEAK/JUMP to use it. You can find
# a gif example on the main page (Interactions Wiki).
# INFO: Selectable options will be only enabled if the conversation
# has the block_movement option enabled.
selectable_options: false

# This option will allow the plugin to use ProtocolLib to cancel 
# movement when block_movement option is enabled in the conversation.
# So the player movement will be prevented completely
# while in a conversation. I suggest you that you enable this option 
# if you also have the selectable_options option enabled.
# INFO: The player will see himself mounted on an entity but other
# players will not!
use_protocollib: false

# Here you can define the action the player need to use to select
# an option while selectable_options and use_protocollib options 
# are enabled.
# It could be SNEAK or JUMP.
protocollib_selectable_options_action: SNEAK

# Set this option to false if you want to disable the empty messages
# in conversations. (messages used to separate dialogues and options)
use_empty_spaces: true

# Enables or disables the Action Bar feature.
action_bar: false

# When enabled, players will be able to skip dialogues clicking again 
# on the NPC.
skip_dialogue_on_npc_click: false

# New system that allow dialogues to be written instead of showing
# instantly, which make the conversation more realistic.
# For this to works flawlessly you need the latest version of Minecraft
# and the latest version of ProtocolLib.
write_dialogues:
    # Whether this system should be enabled or not
    enabled: false

    # CHARACTER = Writes characters 1 by 1.
    # WORD = Writes words 1 by 1.
    mode: CHARACTER

    # The delay between each written character.
    delay: 1

# Enables or disables the Boss Bar feature.
# Only works on 1.9+
boss_bar:
    # If is set to true, players will see a boss bar while in a conversation
    # Set it to false if you don't want a boss bar.
    enabled: true
    
    # Color of the boss bar. Use colors from the following link:
    # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarColor.html
    color: BLUE
    
    # Style of the boss bar. Use styles from the following link:
    # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarStyle.html
    style: SEGMENTED_10
    
    # If this option is set to true, the boss bar status will change
    # when the dialogue progresses.
    change_progress_with_time: false
    
# Here you can specify the default values of the new conversation entities,
# conversations, dialogues and options.
default_values:
PreviousCommands and PermissionsNextMessages.yml File

Last updated 1 year ago

Was this helpful?