BetterHud 2.2-b04
Search…
BetterHud
OVERVIEW
Commands & Permissions
TUTORIALS
First install
Creating a new hud
Hud content
Placeholders
In-game editor
CONFIGURATIONS
config.yml
messages.yml
Powered By GitBook
config.yml
1
config-version: "1.1" # DON'T TOUCH THIS!!
2
texture-version: "1.2" # DON'T TOUCH THIS!!
3
#
4
# ██████╗ ███████╗████████╗████████╗███████╗██████╗ ██╗ ██╗██╗ ██╗██████╗
5
# ██╔══██╗██╔════╝╚══██╔══╝╚══██╔══╝██╔════╝██╔══██╗██║ ██║██║ ██║██╔══██╗
6
# ██████╔╝█████╗ ██║ ██║ █████╗ ██████╔╝███████║██║ ██║██║ ██║
7
# ██╔══██╗██╔══╝ ██║ ██║ ██╔══╝ ██╔══██╗██╔══██║██║ ██║██║ ██║
8
# ██████╔╝███████╗ ██║ ██║ ███████╗██║ ██║██║ ██║╚██████╔╝██████╔╝
9
# ╚═════╝ ╚══════╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═════╝
10
#
11
# Author: ApiGames
12
# SpigotMC: https://www.spigotmc.org/resources/betterhud-custom-minecraft-hud-itemsadder-addon.84180/
13
# Discord: https://discord.gg/MUFrGfTTWY
14
# Wiki: https://apigames.gitbook.io/betterhud/
15
#
16
# Support is given only through the discord ticket system!
17
#
18
configuration:
19
​
20
#How often should we refresh all placeholders in hud?
21
hud-refresh:
22
period: 1 #IN SECONDS
23
​
24
#This feature requires self-host enabled
25
show-vanilla-hud: false
26
​
27
#Multiple Huds
28
# You can create unlimited number of huds, but don't overdo it ;)
29
# Valid display values: ACTIONBAR, BOSSBAR, PLACEHOLDER, GUI
30
huds:
31
​
32
#Example of placeholder display type
33
#
34
# This example is made for the last line of scoreboard
35
# Display it using placeholder: %betterhud_placeholder-example%
36
#
37
placeholder-example:
38
display: PLACEHOLDER
39
permission: "betterhud.hud.placeholderExample"
40
​
41
#Example of GUI display type
42
#
43
# This configuration shows custom text inside GUI
44
# Display it using placeholder in title: %betterhud_gui-example%
45
#
46
gui-example:
47
display: GUI
48
permission: "betterhud.hud.guiExample"
49
title: "&7GUI Test"
50
title-offset: -30
51
position: "before" #Should we put the hud after/before title?
52
​
53
#Example of permission based HUD
54
#
55
# Only players with permission "betterhud.hud.admin" can see this hud
56
#
57
admin-hud:
58
display: BOSSBAR
59
permission: "betterhud.hud.admin"
60
toggle-command: "/adminhud" #This command will work after server restart
61
toggle-actions:
62
on-join: true
63
​
64
#Default hud
65
#
66
# Shows on join only when player doesn't meet conditions for previous huds
67
# Can be toggled using /hud
68
#
69
default-hud:
70
display: ACTIONBAR
71
toggle-command: "/hud" #This command will work after server restart
72
toggle-actions:
73
on-gamemode-change-to: "SURVIVAL" #Valid values: SURVIVAL, ADVENTURE, CREATIVE, SPECTATOR
74
on-join: true
75
​
76
#Hud content
77
# You must assign at least one hud part to the each hud
78
# Every hud part must have specified type
79
#
80
#Valid types:
81
# TEXT - Can display every char from alphabet, special chars, numbers and custom characters
82
# INTEGER - Can display only numbers (I suggest to use this, when the output of the placeholder is always only number)
83
# ICON - Can display only icons, which are located in "ItemsAdder/data/items_packs/betterhud/textures/font/icons/"
84
#
85
# TEXT and INTEGER must have max-length set!
86
#
87
# For more examples, placeholders and other useful stuff, visit BetterHud's wiki!
88
# https://apigames.gitbook.io/betterhud/
89
#
90
hud-content:
91
​
92
#DEBUG HUD - JUST FOR TESTING TEXTURE INTEGRITY
93
debug-hud:
94
text:
95
type: TEXT
96
position-x: 0
97
position-y: 0
98
scale: 8
99
max-length: 128
100
input: abcdefghijklmnopqrstuvwxyz
101
text-CAPITAL:
102
type: TEXT
103
position-x: 0
104
position-y: -15
105
scale: 8
106
max-length: 128
107
input: ABCDEFGHIJKLMNOPQRSTUVWXYZ
108
special:
109
type: TEXT
110
position-x: 0
111
position-y: -30
112
scale: 8
113
max-length: 128
114
input: ',.-_!?()[]@#+%:;=<>*/\'
115
numbers:
116
type: INTEGER
117
position-x: 0
118
position-y: -45
119
scale: 8
120
max-length: 128
121
input: ',.- 0123456789'
122
​
123
placeholder-example:
124
textLine1:
125
type: TEXT
126
position-x: 0
127
position-y: -10
128
scale: 12
129
max-length: 16
130
input: '{#a37833}Line1'
131
textLine2:
132
type: TEXT
133
position-x: -33
134
position-y: -25
135
scale: 12
136
max-length: 16
137
input: '&eLine2'
138
​
139
gui-example:
140
guiText:
141
type: TEXT
142
position-x: 0
143
position-y: -20
144
scale: 12
145
max-length: 8
146
input: '&6Test'
147
​
148
admin-hud:
149
align-text:
150
type: TEXT
151
position-x: 0
152
position-y: -22
153
scale: 12
154
max-length: 15
155
input: '{#ff0000}YOU ARE ADMIN'
156
fixed-position: true
157
align: right
158
​
159
default-hud:
160
health-icon:
161
type: ICON
162
position-x: -40
163
position-y: -20
164
scale: 14
165
texture-path: hp.png
166
health:
167
type: INTEGER
168
position-x: -35
169
position-y: -22
170
scale: 10
171
max-length: 4
172
input: '{health-formatted}'
173
fixed-position: true
174
armor-icon:
175
type: ICON
176
position-x: -18
177
position-y: -20
178
scale: 14
179
texture-path: armor.png
180
armor:
181
type: INTEGER
182
position-x: -13
183
position-y: -22
184
scale: 10
185
max-length: 2
186
input: '{armor}'
187
fixed-position: true
188
food-icon:
189
type: ICON
190
position-x: 15
191
position-y: -20
192
scale: 14
193
texture-path: hunger.png
194
food:
195
type: INTEGER
196
position-x: 20
197
position-y: -22
198
scale: 10
199
max-length: 2
200
input: '{food}'
201
fixed-position: true
202
oxygen-icon:
203
type: ICON
204
position-x: 30
205
position-y: -20
206
scale: 12
207
texture-path: oxygen.png
208
oxygen:
209
type: INTEGER
210
position-x: 35
211
position-y: -22
212
scale: 10
213
max-length: 2
214
input: '{oxygen}'
215
fixed-position: true
216
​
217
#Should we enable debug log?
218
debug:
219
enabled: false
Copied!
TUTORIALS - Previous
In-game editor
Next - CONFIGURATIONS
messages.yml
Last modified 5mo ago
Copy link