Repository navigation
Navigation
Each player chooses how they move through menus with !setnav, and how large menus are with !hudscale. The keys for buttons mode come from SwiftlyS2's configs/menus/menus.jsonc; the starting mode and the page size come from there too, or from CustomHUD's own config.jsonc — Starting mode.
| Mode | Move | Select | Change a value | Close |
|---|---|---|---|---|
buttons |
Shift / F | E | A / D | Tab |
wasd |
W / S | E | A / D | R or Tab |
numbers |
— | 1–6 | A / D after its number | 9 |
mouse |
— | Click | Click its track, or ‹ ›
|
< back, × close |
-
buttonskeys are the binds inmenus.jsonc, shown at SwiftlyS2's defaults.wasdkeys are fixed: any other keymenus.jsoncbinds, Shift and F by default, does nothing inwasdmode. A key a menu binds to an action of its own still works in every mode. - Moving past a page's last row opens the next page. In
numbersmode 7 and 8 turn pages, and inmousemode‹and›at the bottom. -
wasd: W and S also walk the player. -
numbers: the number keys must be bound — Commands. A and D change the slider or selector picked last; the other keysmenus.jsoncbinds, Shift, F, E and Tab by default, do nothing. -
mouse: a cursor shows while a menu is open. The keysmenus.jsoncbinds, Shift, F, A, D, E and Tab by default, do nothing. - Mouse and numbers input plays no menu sounds.
- A menu whose plugin removed its close key, such as MixScrims' team pick, cannot be closed in any mode.
A player who has never run !setnav starts in the mode, and reads pages of the size, that MenuConfig in CustomHUD's config.jsonc points at:
MenuConfig |
Starting mode | Page size |
|---|---|---|
"swiftlys2", the default |
Menus.InputMethod in menus.jsonc: buttons, wasd, numbers or mouse. chat or unset is buttons
|
MenuLayout.MaxVisibleLines in menus.jsonc
|
"customhud" |
DefaultNavMode in config.jsonc
|
MaxVisibleLines in config.jsonc
|
SwiftlyS2 itself ignores wasd, numbers and mouse in menus.jsonc. The console states both at start, and again when you change them.
Players who have never run !setnav start in mouse mode, whatever menus.jsonc sets. The console confirms it: [CustomHUD] Players who have not run !setnav navigate in mouse mode, and menu pages hold up to 5 lines ("MenuConfig": "customhud" in config.jsonc).
| Setup |
!setnav and !hudscale last |
|---|---|
| With Cookies | Across restarts |
| Without Cookies | Until the server restarts |
| A player without a SteamID, as on a LAN server | Until they disconnect |
In the keyboard modes a menu shows one page at a time. A page holds no more than:
-
MaxVisibleLines, frommenus.jsoncorconfig.jsoncasMenuConfigsays — default5,1–32, counted in lines, so a two-line row costs two - The menu's own page size
- Six choices in
numbersmode. A disabled row takes no number
On a menu whose input method is chat, CustomHUD draws SwiftlyS2's own window, so !N picks the row numbered N.
mouse mode scrolls instead, and pages only past the layout's rows: 24 in the mouse list.
With "MenuConfig": "swiftlys2" the console states the page size at start: [CustomHUD] Menu pages hold up to 5 lines (MenuLayout.MaxVisibleLines in configs/menus/menus.jsonc).
!hudscale <percent> resizes a player's menus, snapped to the nearest step: !hudscale 115 sets 110. The steps are 80, 90, 100, 110, 125 and 150.
In the keyboard modes the list's footer shows the keys that work on the focused row; every other footer is a one-line hint. Hints, a setting you add to config.jsonc yourself, replaces either with your own line:
{
"CustomHUD": {
"Hints": {
"numbers": "1-6 pick · 7/8 page · 9 exit",
"numbers.view": "9 exit"
}
}
}numbers players see your line in every language, in place of the key legend.
{ "CustomHUD": { "MenuConfig": "customhud", "DefaultNavMode": "mouse" } }