Skip to main content
A dialogue file is divided into several main sections: 
Settings: # general settings
UI: # UI keys
Colors: # text colors
Sounds: # sound settings
Dialogue: # dialogue pages
Answers: # optional answer options

​
Settings

Contains general dialogue settings, such as typing speed, effects, and player restrictions. 
Settings:
  typing-speed: 1
  wait-on-new-line: 5
  effect: Slowness
  prevent-exit: false
  disable-chat: true
  disable-commands: true
  disable-movement: true
  hide-players: false
  hide-hotbar: true
  show-fog: true
  • typing-speed
    Defines how quickly dialogue text is revealed.
  • wait-on-new-line
    Defines the delay applied when the dialogue moves to a new line.
  • effect
    Defines the effect applied while the dialogue is active.
    Supported values:
    • Slowness
    • None
  • prevent-exit
    Defines whether the player can exit the dialogue by sneaking.
  • disable-chat
    Defines whether chat is blocked while the dialogue is active.
  • disable-commands
    Defines whether commands are blocked while the dialogue is active.
  • disable-movement
    Defines whether player movement is blocked while the dialogue is active.
  • hide-players
    Defines whether other players are visible to the player while the dialogue is active.
  • hide-hotbar
    Defines whether the hotbar is hidden while the dialogue is active.
    This feature requires ProtocolLib.
  • show-fog
    Defines whether the fog layer is shown.

​
UI

Defines which UI elements are used by the dialogue. 
UI:
  fog: "default-fog"
  dialogue-background: "default-dialogue-background"
  answer-background: "default-answer-background"
  arrow: "default-arrow"
  sliders:
    both: "default-sliders-both"
    top: "default-sliders-top"
    bottom: "default-sliders-bottom"
These values reference keys defined in images.yml. Custom images are explained on the Custom Images & Sounds page.

​
Colors

Defines the colors used for dialogue text and answer text. Colors must use the #RRGGBB format. 
Colors:
  dialogue-text: "#000000"
  answer-text: "#000000"
  disabled-answer-text: "#808080"
  • dialogue-text
    Defines the default color of dialogue text.
  • answer-text
    Defines the default color of answer text.
  • disabled-answer-text
    Defines the color used for disabled answers.

​
Sounds

Defines the sounds used for text typing and answer selection. 
Sounds:
  typing: "default-typing"
  selection: "default-selection"
You can use default Minecraft sounds, sounds from resource packs, or custom sounds configured in sounds.yml. Custom sounds are explained on the Custom Images & Sounds page.

​
Dialogue

Contains the dialogue pages. 
Dialogue:
  "1":
    lines:
      - "First line"
      - "Second line"
    pre-actions: []
    post-actions: []

  "2":
    lines:
      - "Another page"
    pre-actions: []
    post-actions: []
Each page uses a numeric ID and contains the text shown to the player.
  • lines
    Defines the text displayed on the page.     Each page can contain up to 5 lines.
  • pre-actions & post-actions
    Defines actions executed before or after the page starts or completes.     All available actions are explained on the Action List page.

​
Answers

Contains the answer options shown to the player. This section is optional. If it is missing, the dialogue will be shown without answers. 
Answers:
  "1":
    text: "First answer"
    sound: "minecraft:entity.player.levelup"
    actions: []

  "2":
    text: "Second answer"
    condition: "perm:example.permission:==true"
    sound: "minecraft:ui.button.click"
    actions: []

  "3":
    text: "Third answer"
    sound: "custom-sound"
    actions: []
Answers are shown on the final page of the dialogue. A dialogue must have at least 3 valid answers for the Answer section to be used.
  • text
    Defines the text shown for the answer.
  • condition
    Defines whether the answer is enabled.     Conditions are explained on the Conditions & Placeholders page.
  • sound
    Defines the sound played when the answer is selected.     You can use default Minecraft sounds, sounds from resource packs, or custom sounds configured in sounds.yml. Custom sounds are explained on the Custom Images & Sounds page.
  • actions
    Defines actions executed after the answer is selected.     All available actions are explained on the Action List page.

​
Notes

  • Some sections are optional.
  • The Answers section can be omitted if the dialogue does not need answer options.
  • If values in Settings, UI, Colors, or Sounds are missing, the plugin will use default values where applicable.
  • Text formatting can be used in both dialogue pages and answers.
    See the Text Formatting page for more info.