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
| Key | Default | Effect |
|---|---|---|
language | en | Plugin message language (en or fr) |
Resource Pack (standalone.resource-pack)
| Key | Default | Effect |
|---|---|---|
output-mode | "folder" | Pack output mode: folder (generate folder) or self-host (send pack directly) |
self-host-port | 8164 | HTTP 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-pack | false | Force client pack acceptance |
pack-prompt | "Resource pack required for dialogue display." | Prompt shown before download |
regenerate-on-startup | false | Regenerate pack on each startup |
Global Position (standalone)
| Key | Default | Effect |
|---|---|---|
x-offset | 0 | Moves the full UI on X axis |
y-offset | -200 | Moves the full UI on Y axis |
Layout (standalone.layout)
You can move elements with x and y.
Elements supporting scale:
dialogue-bg.scaleanswer-bg.scaleavatar.scale
Full reference:
| Key | Default | Effect |
|---|---|---|
dialogue-bg.x | 0 | Dialogue background X |
dialogue-bg.y | 20 | Dialogue background Y |
dialogue-bg.scale | 1.0 | Dialogue background scale |
answer-bg.x | 180 | Options background X |
answer-bg.y | -30 | Options background Y |
answer-bg.scale | 1.0 | Options background scale |
npc-name.x | 10 | NPC name X (popup with options) |
npc-name.y | 19 | NPC name Y (popup with options) |
npc-name-spoken.x | 6 | NPC name X (popup without options) |
npc-name-spoken.y | 23 | NPC name Y (popup without options) |
name-bg.x | 0 | Name background X |
name-bg.y | 14 | Name background Y |
dialogue-text.x | 10 | Dialogue text X (with options) |
dialogue-text.y | 32 | Dialogue text Y (with options) |
dialogue-text.split-width | 166 | Dialogue text wrap width |
dialogue-text-spoken.x | 10 | Dialogue text X (without options) |
dialogue-text-spoken.y | 36 | Dialogue text Y (without options) |
options-scroll.x | 226 | Options text X in scroll |
options-scroll.y | -25 | Options text Y in scroll |
options-scroll.line-height | 14 | Options line spacing in scroll |
options-fixed.x | 190 | Options text X in fixed |
options-fixed.y | -25 | Options text Y in fixed |
options-fixed.line-height | 8 | Options line spacing in fixed |
options-fixed.split-width | 160 | Options text wrap width in fixed |
hand.x | 175 | Selection hand X |
hand.y | -26 | Selection hand base Y |
hand.spacing | 8 | Vertical spacing between hand lines |
avatar.x | -20 | NPC avatar X |
avatar.y | 0 | NPC avatar Y |
avatar.scale | 0.75 | NPC avatar scale |
text-height | 8 | Rendered text height |
Text Alignment (standalone.text-alignment)
Allowed values: left, center, right
| Key | Default | Effect |
|---|---|---|
dialogue | "center" | Dialogue text alignment |
speaker | "left" | NPC name alignment |
options | "left" | Options alignment |
Text Fonts (standalone.text-fonts)
| Key | Default | Effect |
|---|---|---|
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)
| Key | Default | Effect |
|---|---|---|
key | "minecraft:ui.button.click" | Sound played when selection changes |
volume | 1.0 | Sound volume |
pitch | 1.0 | Sound pitch |
Typewriter (typewriter)
| Key | Default | Effect |
|---|---|---|
enabled | true | Enable/disable typewriter effect |
speed | 30 | Typewriter speed |
Selection Mode (selection-mode)
| Key | Default | Effect |
|---|---|---|
selection-mode | "scroll" | Selection mode: scroll or fixed |
Selection Indicator (selection-indicator)
| Key | Default | Effect |
|---|---|---|
prefix | "" | Prefix added to selected option |
selected-color | "<#97deaa>" | Selected option color |
unselected-color | "<gray>" | Unselected option color |
hand-base-y | -25 | Selection hand base Y |
hand-line-height | 10 | Y step between option lines |
max-option-length | 0 | Max option length (0 = unlimited) |
Updater (updater)
| Key | Default | Effect |
|---|---|---|
auto-download | false | Auto-download updates when available |
How to apply changes
- Edit
config.yml. - Run
/bqhud reload. - 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 fontfonts: named custom fonts
Main keys:
| Key | Effect |
|---|---|
default.scale | Default font size |
default.file | TTF file path in plugins/KGInfoServs-BQBetterHud/fonts/ |
default.use-unifont | Uses Minecraft fonts when true |
fonts.<name>.file | Custom TTF path |
fonts.<name>.scale | Custom font size |
Example:
default:
scale: 16
file: ""
use-unifont: false
fonts:
title:
file: "myfont.ttf"
scale: 24
use-unifont: false