Repository navigation
Configuration
config.jsonc (in addons/swiftlys2/configs/plugins/CustomHUD/) holds every CustomHUD setting, under a "CustomHUD" section. CustomHUD writes it on first start, with a comment over each setting.
| File | Holds |
|---|---|
config.jsonc |
The settings on this page |
SwiftlyS2's configs/menus/menus.jsonc
|
The renderer and the keys, and while MenuConfig is "swiftlys2" the starting mode and page size — Navigation
|
resources/translations/<language>.jsonc, in the plugin folder |
Every line players read — Translations |
- Changes apply on save, and the console logs
[CustomHUD] Config reloaded.An open menu picks them up when it next redraws. OnlyRendererIdneeds a restart. - A value CustomHUD cannot use is logged at start and on save,
[CustomHUD] config.jsonc: …, naming what applies instead. - A value of the wrong type, such as
"MaxVisibleLines": "five", is logged asconfig.jsonc could not be read, and the settings in use stay until you fix it. - Each start adds the settings a newer CustomHUD brings, with their defaults. It never changes a value already in the file.
| Setting | Default | Description |
|---|---|---|
MenuConfig |
"swiftlys2" |
Where the starting mode and the page size come from: "swiftlys2" SwiftlyS2's menus.jsonc, "customhud" the next two settings — Navigation
|
DefaultNavMode |
"buttons" |
Mode players start in until they run !setnav: buttons, wasd, numbers or mouse. With "MenuConfig": "customhud" only |
MaxVisibleLines |
5 |
Lines on one page of a keyboard menu, 1–32. With "MenuConfig": "customhud" only — Pages
|
Menus |
Per plugin | The layout each plugin's menus draw in — Menus |
Messages |
"game" for each kind |
The game's own HUD messages in CustomHUD's layouts — Messages |
Panels |
Each panel's own | The layout each panel draws in — Panels |
DetailedLogging |
false |
Log every frame drawn, with its menu id, layout and the game-thread time each step took, and every captured message |
The layout each plugin's menus draw in: Mouse for players in mouse mode, Keyboard for buttons, wasd and numbers. A layout is named by its file, and names ending in _v2 are CS2's own store look.
| Plugin | Mouse |
Keyboard |
|---|---|---|
WeaponSkins |
"menu_skins_mouse_v2" |
"menu_list_skins_v2" |
ShopCore, MapChooser, Ranks, VIPCore, Admins, MixScrims
|
"menu_locker_v2" |
"menu_list_v2" |
Other, every other plugin |
"menu_list_mouse_v2" |
"menu_list_v2" |
-
Rankscovers Ranks_WeaponStats, Ranks_CustomCombos and Ranks_Prestige too. - A name that is no layout for that plugin and mode, such as a
Keyboardof"menu_locker_v2", draws the plugin's default and logs a warning. - Every layout, and which plugins and modes it serves: Layouts.
{
"CustomHUD": {
"Menus": {
"ShopCore": {
"Mouse": "menu_list_mouse_v2"
},
"Other": {
"Keyboard": "menu"
}
}
}
}ShopCore draws in the list for mouse players too, and every other plugin's menus draw in the classic list for keyboard players.
The game's own HUD messages, which plugins send with SendCenter, SendAlert and SendNotify:
| Setting | Default | Description |
|---|---|---|
Center |
"game" |
Centre text |
Alert |
"game" |
Alerts |
Notify |
"game" |
Notifications |
"game" leaves a kind to the game; "hud_text" and "hud_alert" draw it in CustomHUD's layouts instead, and "hud_text_v2" and "hud_alert_v2" in CS2's own store look — Native Text Capture.
The panels other plugins show through the Panels API.
| Setting | Default | Description |
|---|---|---|
Versus |
"panel_versus" |
Two teams and their score |
Ready |
"panel_ready" |
The ready counter |
Timeout |
"panel_timeout" |
The timeout banner |
Each panel ships with one layout. A layout of your own: Layouts.
CustomHUD reads these but does not write them into config.jsonc. Add one to the "CustomHUD" section when you need it.
| Setting | Default | Description |
|---|---|---|
Hints |
{} |
Footer line per mode — Hints |
PageViews |
{} |
Menu id or prefix.* → view — Views
|
MenuOverrides |
{} |
Menu id or prefix.* → layouts, winning over Menus — Layouts
|
MenuLayouts, MessageLayouts, PanelLayouts
|
{} |
Layouts of your own, by name — Layouts |
LayoutRoot |
"panorama/layout/custom_game/customhud/" |
Folder a layout File without a / is read from |
RendererId |
"customhud.panorama" |
The renderer id menus.jsonc selects. Restart to apply |
Messages.Chat, Messages.ChatEndOfRound, Messages.Console
|
"game" |
More kinds of message — Kinds |
The footer line for each mode, in every language. Without an entry a hint comes from the player's translation file, customhud.hint.<key>. "" hides it.
| Key | Shown on |
|---|---|
wasd, buttons, numbers, mouse
|
Menus in that mode |
chat |
Menus whose input method is chat, for buttons players |
<key>.view |
The same, on a menu with nothing to select, such as a vote tally kept open after voting |
-
{up},{down},{select}and{close}become the menu's keys. In mouse mode{close}is the close button:×, or<on a layout without one. - An entry for a keyboard mode replaces the list's key legend with your line.
- An overridden mode keeps your line on view-only menus until you override its
.viewtoo. - An entry identical to the English default counts as unset.
Example: Navigation.
{ "CustomHUD": { // Where players' starting navigation mode and the menu page size come from: // "swiftlys2" = Menus.InputMethod and MenuLayout.MaxVisibleLines in configs/menus/menus.jsonc, // "customhud" = DefaultNavMode and MaxVisibleLines below. "MenuConfig": "swiftlys2", // The mode players start in until they run !setnav: "buttons", "wasd", "numbers" or "mouse". // Used with "MenuConfig": "customhud". "DefaultNavMode": "buttons", // Lines on one page of a keyboard menu, 1-32. Used with "MenuConfig": "customhud". "MaxVisibleLines": 5, // The layout each plugin's menus draw in, for mouse players and for keyboard players (buttons, wasd, numbers). // Names ending in _v2 are CS2's store look, the rest the first designs. Every layout: https://github.com/shmitzas/CustomHUD/wiki/Layouts "Menus": { "WeaponSkins": { "Mouse": "menu_skins_mouse_v2", "Keyboard": "menu_list_skins_v2" }, "ShopCore": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, "MapChooser": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, "Ranks": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, "VIPCore": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, "Admins": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, "MixScrims": { "Mouse": "menu_locker_v2", "Keyboard": "menu_list_v2" }, // Every other plugin. "Other": { "Mouse": "menu_list_mouse_v2", "Keyboard": "menu_list_v2" } }, // The game's own HUD messages: "game" leaves a kind to CS2, "hud_text" or "hud_alert" draws it in that CustomHUD layout. // "hud_text_v2" and "hud_alert_v2" are the same in CS2's store look. "Messages": { "Center": "game", "Alert": "game", "Notify": "game" }, // Layout of each panel other plugins show through CustomHUD. "Panels": { "Versus": "panel_versus", "Ready": "panel_ready", "Timeout": "panel_timeout" }, // Log every menu frame drawn and every message captured. "DetailedLogging": false } }