Repository navigation
Layouts
A layout is the Panorama file a menu, message or panel draws in. config.jsonc (in addons/swiftlys2/configs/plugins/CustomHUD/) names a layout by its file, without .vxml_c — Configuration. Layouts ship in the CustomHUD Workshop addon on each player's game.
- A layout the player's addon does not have draws nothing, and the server cannot tell.
- Names are not case-sensitive, and the file's
.vxml_cmay stay on:"MENU_LIST_V2.vxml_c"is"menu_list_v2".
| Layout | Players | Plugins | Draws |
|---|---|---|---|
menu_locker_v2 |
Mouse | ShopCore, MapChooser, Ranks, VIPCore, Admins, MixScrims | The designed pages — Supported Plugins |
menu_skins_mouse_v2 |
Mouse | WeaponSkins | The skin locker |
menu_list_mouse_v2 |
Mouse | Every plugin | The list, with a scrollbar, < and ×
|
menu_list_v2 |
Keyboard | Every plugin | The list, with a key legend, and a supported plugin's name and art |
menu_list_skins_v2 |
Keyboard | Every plugin | The same list, with sticker art for WeaponSkins |
menu_mouse |
Mouse | Every plugin | The classic tile grid |
menu |
Keyboard | Every plugin | The classic list |
menu_shop, menu_skins, menu_teampick
|
Keyboard | Every plugin | The classic list styled for a shop, a skin picker or MixScrims' team pick |
A layout named for a mode or a plugin the table does not list draws the plugin's default instead, and logs a warning.
| Layouts | Look |
|---|---|
Names ending in _v2
|
CS2's own store: its navy, light blue for what is open or picked, green for what you have equipped |
The same names without _v2: menu_locker, menu_skins_mouse, menu_list_mouse, menu_list, menu_list_skins, hud_text, hud_alert
|
The first designs: near-black panels with an orange accent and gold captions |
- Both designs draw the same pages from the same data, so a switch changes the look and nothing else.
- The exception is WeaponSkins:
menu_skins_mouseopens Rifles in place of the categories page, and lists the properties pages in its sidebar.
| Layout | Draws |
|---|---|
hud_text |
A small box near the top of the screen, for 5 seconds — Native Text Capture |
hud_alert |
A larger, louder box, for 4 seconds |
hud_text_v2, hud_alert_v2
|
The same two boxes in CS2's own store look |
panel_versus, panel_ready, panel_timeout
|
The versus strip, the ready counter and the timeout banner — Panels |
MenuOverrides, a setting you add yourself, picks layouts for one menu id, or for every id that starts with a prefix, prefix.*. It wins over Menus, and a mode it leaves out keeps the plugin's.
MixScrims' team pick draws in the team-pick list for keyboard players; mouse players keep MixScrims' designed page. DetailedLogging logs each menu's id as it draws.
A layout of your own is a file in a Workshop addon you build and serve yourself — Building. Name it in one of these settings you add to config.jsonc, then pick that name as you would a shipped one.
| Setting | Holds |
|---|---|
MenuLayouts |
Menu layouts, for Menus and MenuOverrides
|
MessageLayouts |
Message layouts, for Messages
|
PanelLayouts |
Panel layouts, for Panels
|
{
"CustomHUD": {
"MenuLayouts": {
"my-list": {
"File": "my_list.vxml_c",
"RowSlots": 10
}
},
"Menus": {
"Other": {
"Keyboard": "my-list"
}
}
}
}Every other plugin's menus draw in my_list.vxml_c for keyboard players, ten rows at a time.
-
Fileis read fromLayoutRootunless it holds a/. Keep the_c. - A menu layout that restyles a shipped one names it as
Baseand needs nothing but itsFile. It then serves the same players and plugins: Layout Variations shows every step. - A shipped layout's file is its name plus
.vxml_c, so yours can start from any of them. Rows per file:menu_list_v2,menu_list_skins_v2and the classic lists 20,menu_list_mouse_v224,menu_locker_v248,menu_mouse60,menu_skins_mouse_v2128. - Any other layout of your own is merged with nothing: a field you leave out takes the source's default, not the shipped layout's. The fields name the panels, variables and classes the file declares, commented in
CustomHudConfig.csfor menus,NativeTextConfig.csfor messages andPanelConfig.csfor panels. - One named like a shipped layout replaces it wherever that name is picked.
- A message layout with
"Suppress": falseleaves the game's copy on screen too, which helps while styling one.
{ "CustomHUD": { "MenuOverrides": { "mixscrims.team-pick": { "Keyboard": "menu_teampick" } } } }