Skip to main content

Configuration

Main file: plugins/KGInfoServs-BQBetterHud/config.yml

Goal of this page: explain every useful config line and what it does.

BetonQuest config (required)

In plugins/BetonQuest/config.yml:

conversation:
default_io: kg_bqhud,menu,chest

Inside conversations, you can also force:

conversationIO: kg_bqhud

If you still have kg_hud in default_io, replace it with kg_bqhud.

Global structure

language: "en"
standalone:
resource-pack:
output-mode: "folder"
self-host-port: 8164
public-url: ""
output-folder: "plugins/KGInfoServs-BQBetterHud/resourcepack"
force-pack: false
pack-prompt: "Resource pack required for dialogue display."
regenerate-on-startup: false
x-offset: 0
layout: ...
text-alignment: ...
text-fonts: ...
y-offset: -200
option-sound:
key: "minecraft:ui.button.click"
volume: 1.0
pitch: 1.0
typewriter:
enabled: true
speed: 30
selection-mode: "scroll"
selection-indicator:
prefix: ""
selected-color: "<#97deaa>"
unselected-color: "<gray>"
hand-base-y: -25
hand-line-height: 10
max-option-length: 0
updater:
auto-download: false

language

KeyDefaultEffect
languageenPlugin message language (en or fr)

Resource Pack (standalone.resource-pack)

KeyDefaultEffect
output-mode"folder"Pack output mode: folder (generate folder) or self-host (send pack directly)
self-host-port8164HTTP port used in self-host
public-url""Public pack URL in self-host (recommended in production)
output-folder"plugins/KGInfoServs-BQBetterHud/resourcepack"Output folder in folder mode
force-packfalseForce client pack acceptance
pack-prompt"Resource pack required for dialogue display."Prompt shown before download
regenerate-on-startupfalseRegenerate pack on each startup

Global Position (standalone)

KeyDefaultEffect
x-offset0Moves the full UI on X axis
y-offset-200Moves the full UI on Y axis

Layout (standalone.layout)

You can move elements with x and y.

Elements supporting scale:

  • dialogue-bg.scale
  • answer-bg.scale
  • avatar.scale

Full reference:

KeyDefaultEffect
dialogue-bg.x0Dialogue background X
dialogue-bg.y20Dialogue background Y
dialogue-bg.scale1.0Dialogue background scale
answer-bg.x180Options background X
answer-bg.y-30Options background Y
answer-bg.scale1.0Options background scale
npc-name.x10NPC name X (popup with options)
npc-name.y19NPC name Y (popup with options)
npc-name-spoken.x6NPC name X (popup without options)
npc-name-spoken.y23NPC name Y (popup without options)
name-bg.x0Name background X
name-bg.y14Name background Y
dialogue-text.x10Dialogue text X (with options)
dialogue-text.y32Dialogue text Y (with options)
dialogue-text.split-width166Dialogue text wrap width
dialogue-text-spoken.x10Dialogue text X (without options)
dialogue-text-spoken.y36Dialogue text Y (without options)
options-scroll.x226Options text X in scroll
options-scroll.y-25Options text Y in scroll
options-scroll.line-height14Options line spacing in scroll
options-fixed.x190Options text X in fixed
options-fixed.y-25Options text Y in fixed
options-fixed.line-height8Options line spacing in fixed
options-fixed.split-width160Options text wrap width in fixed
hand.x175Selection hand X
hand.y-26Selection hand base Y
hand.spacing8Vertical spacing between hand lines
avatar.x-20NPC avatar X
avatar.y0NPC avatar Y
avatar.scale0.75NPC avatar scale
text-height8Rendered text height

Text Alignment (standalone.text-alignment)

Allowed values: left, center, right

KeyDefaultEffect
dialogue"center"Dialogue text alignment
speaker"left"NPC name alignment
options"left"Options alignment

Text Fonts (standalone.text-fonts)

KeyDefaultEffect
dialogue""Reserved for per-zone font selection
speaker""Reserved for per-zone font selection
options""Reserved for per-zone font selection

Important note: in the current build, rendering mostly uses the default font from fonts.yml.

Option Sound (option-sound)

KeyDefaultEffect
key"minecraft:ui.button.click"Sound played when selection changes
volume1.0Sound volume
pitch1.0Sound pitch

Typewriter (typewriter)

KeyDefaultEffect
enabledtrueEnable/disable typewriter effect
speed30Typewriter speed

Selection Mode (selection-mode)

KeyDefaultEffect
selection-mode"scroll"Selection mode: scroll or fixed

Selection Indicator (selection-indicator)

KeyDefaultEffect
prefix""Prefix added to selected option
selected-color"<#97deaa>"Selected option color
unselected-color"<gray>"Unselected option color
hand-base-y-25Selection hand base Y
hand-line-height10Y step between option lines
max-option-length0Max option length (0 = unlimited)

Updater (updater)

KeyDefaultEffect
auto-downloadfalseAuto-download updates when available

How to apply changes

  1. Edit config.yml.
  2. Run /bqhud reload.
  3. Validate in game.

For visual changes (layout, offsets, avatars, backgrounds), always test in real gameplay conditions.

Fonts (fonts.yml)

File: plugins/KGInfoServs-BQBetterHud/fonts.yml

Main sections:

  • default: default font
  • fonts: named custom fonts

Main keys:

KeyEffect
default.scaleDefault font size
default.fileTTF file path in plugins/KGInfoServs-BQBetterHud/fonts/
default.use-unifontUses Minecraft fonts when true
fonts.<name>.fileCustom TTF path
fonts.<name>.scaleCustom font size

Example:

default:
scale: 16
file: ""
use-unifont: false

fonts:
title:
file: "myfont.ttf"
scale: 24
use-unifont: false