Killing Floor 2

Killing Floor 2

231 ratings
FriendlyHUD Commands
By peelz
This guide contains all FriendlyHUD documentation, including commands, presets and screenshots.
3
2
   
Award
Favorite
Favorited
Unfavorite
Introduction
All commands are meant to be executed through the console (i.e. by pressing ~ or F3)

If you want to customize the HUD, you can load a single player game through the console (press F3 or ~):
open KF-Nuked?mutator=FriendlyHUD.FriendlyHUDMutator
then enable godmode:
enablecheats|god|togglezedsignoreme
and spawn in bots using this command (they spawn where you're looking at):
DebugFHUDSpawnBot
If you want to prevent the bots from getting attacked, you can press F4 to pause all game logic (including FriendlyHUD), which means the bots won't die but they also won't be able to take damage.

You can also customize the HUD outside of the game by editing this file (make sure to close your game first or it won't work!):
My Documents\My Games\Killing Floor 2\Config\KFFriendlyHUD.ini
General Settings
Command
Defaults
Description
SetFHUDEnabled <bool>
true
Controls whether FHUD is enabled or not
SetFHUDOnlyForMedic <bool>
false
Controls whether FHUD should only be visible when playing as medic
SetFHUDIgnoreSelf <bool>
true
Controls the visibility of your own health bar
SetFHUDIgnoreDeadTeammates <bool>
true
Controls whether dead teammates should be hidden from the list
SetFHUDMinHealthThreshold <float>
1.0
Hides players above a certain health ratio
SetFHUDSortStrategy <string Strategy> <bool Descending = false>
none false
Possible values: none, health, healthregen

health

healthregen

none
Disables sorting
SetFHUDOpacity <float>
1.0
Controls the opacity multiplier of all colors
By default, most colors have an alpha value of 192. In order to reach maximum opacity, you would have to use a multiplier of at least 1.33.
SetFHUDDynamicOpacity <float P1> <float P0 = 1> <float T0 = 4> <float T1 = 0>
1.0 1.0 4.0 0.0
Lowers the opacity of full-health players
Note: the parameters are used to configure the cubic interpolation curve used for scaling the opacity. If you want to fine-tune the scaling, you might have to fiddle with the parameters a bit.

Example: 0.6 1.0

Presets
Color presets
Command: LoadFHUDColorPreset <string>

Preset name
Description
default
Default colors (green health, navy blue armor)

classic
Classic colors (light blue health, saturated blue armor)

red
Beta-style colors (red health, saturated blue armor)

purple
Purple!

blood
Red colors (red health, dark red armor)

Added in v2.2
redregen
Default colors with red regen color

gradient
Red-yellow-green dynamic colors


Layout presets
Command: LoadFHUDPreset <string>

Note: presets prefixed with 1080_ are meant for 1080p, but can be used on any resolution. If using 1440p (or higher), 1440_ presets might be preferable.

Preset name
Description
default
1080_l4d
1440_l4d
1080_column2
1440_column2
1080_left
1440_left
1080_topright
1440_topright
1080_right
1440_right

Bar presets
Command: LoadFHUDBarPreset <string>

Note: presets prefixed with 1080_ are meant for 1080p, but can be used on any resolution. If using 1440p (or higher), 1440_ presets might be preferable.

Preset name
Description
default
1080_block5
1440_block5
1080_block10
1440_block10
70-30
barcode
stairs
Color Settings
Command
Defaults
Description
SetFHUDShadowColor <byte R> <byte G> <byte B> <byte A = 192>
0 0 0 192
SetFHUDIconColor <byte R> <byte G> <byte B> <byte A = 192>
255 255 255 192
SetFHUDNameColor <byte R> <byte G> <byte B> <byte A = 192>
255 255 255 192
SetFHUDFriendIconColor <byte R> <byte G> <byte B> <byte A = 192>
255 255 255 192
SetFHUDFriendNameColor <byte R> <byte G> <byte B> <byte A = 192>
51 222 44 255
SetFHUDFriendNameColorEnabled <bool>
false
Controls whether friend names should be rendered using a different color
SetFHUDArmorColor <byte R> <byte G> <byte B> <byte A = 192>
0 100 210 192
SetFHUDHealthColor <byte R> <byte G> <byte B> <byte A = 192>
0 192 0 192
SetFHUDHealthRegenColor <byte R> <byte G> <byte B> <byte A = 192>
0 70 0 192
SetFHUDBuffColor <byte R> <byte G> <byte B> <byte A = 192>
255 255 255 192
SetFHUDArmorBGColor <byte R> <byte G> <byte B> <byte A = 192>
16 16 16 192
SetFHUDHealthBGColor <byte R> <byte G> <byte B> <byte A = 192>
16 16 16 192
SetFHUDArmorEmptyBGColor <byte R> <byte G> <byte B> <byte A = 192>
16 16 16 192
SetFHUDHealthEmptyBGColor <byte R> <byte G> <byte B> <byte A = 192>
16 16 16 192
SetFHUDCDReadyIconColor <byte R> <byte G> <byte B> <byte A = 192>
0 210 120 192
SetFHUDCDNotReadyIconColor <byte R> <byte G> <byte B> <byte A = 192>
255 0 0 192
Dynamic Colors
Command
Defaults
Description
SetFHUDDynamicColorsStrategy <string>
unset
Controls the health color transition logic

lerp

static

unset
Disabled
SetFHUDDynamicRegenColorsStrategy <string>
unset
Controls the regen health color transition logic
Note: this is the same as above, but controls the regen health instead.

lerp
Scales using the current health
lerpregen
Similar to lerp, but scales using the regen health instead
static
unset
Disabled
AddFHUDColorThreshold <float> <byte R> <byte G> <byte B> <byte A = 192>
Adds (or sets) a color transition point for a specific health ratio
SetFHUDRegenColorThreshold <float> <byte R> <byte G> <byte B> <byte A = 192>
Sets the health regen color for an existing color threshold
RemoveFHUDColorThreshold <float>
Deletes the specified color threshold
MoveFHUDColorThreshold <float Threshold> <float NewThreshold>
Changes the threshold value of an existing color threshold
ClearFHUDColorThresholds
Clears all color thresholds
Bar Settings
By default, the bars (health and armor) are rendered as a single block. You can split the bars into multiple blocks using the SetFHUDBlockCount command, however the total bar width won't be adjusted. You will need to lower the block size so that the bar doesn't cover your entire screen.

The armor bar and health bar block settings can be controlled separately by prefixing block commands with "health" or "armor", e.g:
SetFHUDBlockSize -> SetFHUDArmorBlockSize, SetFHUDHealthBlockSize

Command
Defaults
Description
SetFHUDBarGap <float>
-1
SetFHUDBlockProportions <float Width> <string Ratios>
Sets up block dimensions and block ratios from a given total bar width and a list of ratios; the ratios are comma-separated
This controls block ratios overrides and block dimensions overrides simultaneously.

Examples:
200 0.7,0.3
(block 1: 70%, 200*0.7 pixels; block 2: 30%, 200*0.3 pixels)

200 0.2,0.2,0.2,0.2,0.2
(5 40-pixel blocks that represent 20% each)

SetFHUDBlockSize <float Width> <float Height> <int BlockIndex = -1>
200 8
If BlockIndex is specified, the dimensions will only be applied to that specific block.

SetFHUDBlockWidth <float> <int BlockIndex = -1>
200
Controls the block width independently from the height
If BlockIndex is specified, the dimensions will only be applied to that specific block.
SetFHUDBlockHeight <float> <int BlockIndex = -1>
8
Controls the block height independently from the width
If BlockIndex is specified, the dimensions will only be applied to that specific block.
SetFHUDBlockRatio <float> <int BlockIndex>
Controls the bar ratio represented by a specific block

Note: you can use SetFHUDDrawDebugRatios 1 to display the ratios on top of the blocks.
SetFHUDBlockCount <int>
1
SetFHUDBlockGap <float>
2
SetFHUDBlockAlignY <string>
middle
top

bottom

middle

SetFHUDBlockOffsetX <float> <int BlockIndex>
Controls the horizontal offset of individual blocks
SetFHUDBlockOffsetY <float> <int BlockIndex>
Controls the vertical offset of individual blocks
SetFHUDBlockRoundingStrategy <string>
default
default

round

ceil

floor

SetFHUDBlockOutline <float>
SetFHUDBlockOutline <float Vertical> <float Horizontal>
SetFHUDBlockOutline <float Top> <float Right> <float Bottom> <float Left>
1
SetFHUDIconSize <float>
32
SetFHUDIconOffset <float>
0
SetFHUDIconGap <float>
4
SetFHUDNameScale <float>
1
SetFHUDNameMarginX <float>
0
SetFHUDNameMarginY <float>
0
SetFHUDFriendIconEnabled <bool>
true
SetFHUDFriendIconSize <float>
24
SetFHUDFriendIconGap <float>
4
SetFHUDFriendIconOffsetY <float>
0
SetFHUDBarWidthMin <float>
122
Forces healthbars to assume a minimum spacing between them
Value: 202 (with small bars)

Value: 0 (with small bars)

ClearFHUDBlockDimensions
Clears all of the custom block dimensions overrides
ClearFHUDBlockRatios
Clears all of the custom block ratio overrides
ClearFHUDBlockOffsets
Clears all of the custom block offset overrides
Buff Settings
Command
Defaults
Description
SetFHUDBuffLayout <string>
left
Possible values: none, left, right, top, bottom

SetFHUDBuffSize <float>
8
SetFHUDBuffMargin <float>
2


SetFHUDBuffGap <float>
3


SetFHUDBuffOffset <float>
0


SetFHUDBuffCountMax <int>
3

SetFHUDForceShowBuffs <bool>
false
Forces players to be visible when they get buffed, even if they are above the MinHealthThreshold
Layout Settings
Command
Defaults
Description
SetFHUDScale <float>
1
Controls the overall scale of the HUD
SetFHUDLayout <string>
bottom
bottom

left

right
NOTE: Items will flow left-to-right and off the screen unless you set ItemsPerRow to 1 and ReverseX to true

SetFHUDFlow <string>
column
column

row

SetFHUDItemsPerColumn <int>
3
Controls the number of items per column
SetFHUDItemsPerRow <int>
5
Controls the number of items per row
SetFHUDMaxItemCount <int>
-1
Controls the maximum number of players to be rendered (useful with sorting enabled)
Added in v2.1
SetFHUDReverseX <bool>
false
false

true

SetFHUDReverseY <bool>
false
false

true

SetFHUDItemMarginX <float>
14
SetFHUDItemMarginY <float>
5
SetFHUDOffsetX <float>
0
Controls the relative horizontal position of the HUD
SetFHUDOffsetY <float>
0
Controls the relative vertical position of the HUD
Miscellaneous Settings
Command
Defaults
Description
SetFHUDShowHelpNotification <bool>
false
Controls the visibility of !FHUDHelp notifications in chat
SetFHUDUpdateInterval <float>
0.5
Controls the interval (in seconds) between player list updates
SetFHUDNameTruncationEnabled <bool>
true
Controls whether player names should be shortened
Added in v2.2
SetFHUDEmptyBlockThreshold <float>
0
Sets the minimum block ratio to qualify a block as empty (used for EmptyBG colors)
SetFHUDSelfSortStrategy <string>
first
first

last

unset
unset leaves the position undetermined.

Manual Mode
Move mode (hold SHIFT)


Toggle visibility (press CTRL)


Toggle visibility override (hold ALT)


Controls
K - Toggle manual mode
W/A/S/D - Change selection
SHIFT - Hold to move current player
CTRL - Toggle visibility of current player
ALT - Hold to override visibility (outside of manual mode)

Custom configuration
You can override the default binds using a custom config file.
Install the default config files by extracting this archive[drive.google.com] to My Documents.
You will find the config files under My Documents\My Games\KillingFloor2\Binaries\cfg\.

OnLoadFHUD.cfg gets executed joining a server with FriendlyHUD running.
OnUnloadFHUD.cfg gets executed when leaving a server with FriendlyHUD running (used for restoring binds – optional).
Unofficial Mod Compatibility
Command
Defaults
Description
SetFHUDUMCompatEnabled
true
Controls whether FHUD should override Unofficial Mod's HMTech cooldowns HUD to prevent layout conflicts

true

false
Note: due to the nature of the compatibility fix, you will need to manually re-enable UnofficialMod's settings using this command: UMHMTechChargeHUD 0

SetFHUDUMColorSyncEnabled
true
Controls whether FHUD should automatically synchronize Unofficial Mod's color scheme

Controlled Difficulty Compatibility
Command
Defaults
Description
SetFHUDCDCompatEnabled
true
SetFHUDCDOnlyTraderTime
false
Controls whether FHUD should only appear during trader time
Debug Commands
Command
Defaults
Description
SetFHUDDrawDebugLines <bool>
false
Draws debug lines that outlines the origin of FHUD
SetFHUDDrawDebugRatios <bool>
false
Draws ratios over blocks – useful for debugging block distribution issues
SetFHUDDebugForceFriend <bool>
false
Forces all players to show up as friends
DebugFHUDSpawnBot <string BotName> <int PerkIndex> <bool IsEnemy> <bool GodMode>
Spawns a bot in front of you (cheats only)
DebugFHUDSetArmor <int Armor> <int MaxArmor = -1>
Sets the armor value for your own character (cheats only)
DebugFHUDSetHealth <int Health> <int MaxHealth= -1>
Sets the health value for your own character (cheats only)
Reset Settings
ResetFHUDConfig
Resets all settings to their defaults

ResetFHUDLayout
Resets the layout settings to their defaults

ResetFHUDColors
Resets the colors to their defaults

ResetFHUDBar
Resets the bar settings to their defaults
55 Comments
peelz  [author] 1 Apr @ 11:02am 
lol :brownchicken:
not working kf3 work, when will it make compatible? :steamthumbsup:
peelz  [author] 19 Mar @ 5:05pm 
That's not a part of this mod
Toilet 19 Mar @ 2:21pm 
Just downloaded but cannot get damage numbers to work?
Bro Bike 5 Jun, 2024 @ 11:48am 
Any way to disable the damage numbers?
peelz  [author] 23 Jun, 2023 @ 10:06am 
SetFHUDEnabled false
Sprout 23 Jun, 2023 @ 4:35am 
What do you exactly type to disable this because I can't get the commands to work
Twomd 30 Oct, 2022 @ 6:06pm 
Oh nevermind I think I have it
Twomd 30 Oct, 2022 @ 6:02pm 
I know this is a bit late but can you explain a bit deeper how to input the opacity scaling so full health is translucent in console? It is saying P1 is a bad value in console when inputting
peelz  [author] 7 Oct, 2021 @ 3:57pm 
:D