Repository navigation
Installation
shmitzas edited this page Nov 12, 2026
·
2 revisions
- SwiftlyS2 1.5.0 or later
- AddonsManager, to give every player the CustomHUD Workshop addon, which holds the layouts
- Plugins that build their menus with
Core.Menu. Menus from the deprecatedCore.MenusAPIare not drawn - Optional: Cookies, to remember each player's mode and scale across restarts
-
Download
CustomHUD-v<version>.zipfrom Releases and unzip it intoaddons/swiftlys2/plugins/. -
Add
"3834965450"toMain.Addonsinaddons/swiftlys2/configs/plugins/AddonsManager/config.jsonc. -
Restart the server and check the console for
[CustomHUD] Renderer 'customhud.panorama' registered. -
Select the renderer in
addons/swiftlys2/configs/menus/menus.jsonc:
If CustomHUD fails to load while menus.jsonc selects it, every menu on the server fails to open — so check step 3 before step 4.
To try it on one plugin first, put Renderer in that menu's own section of menus.jsonc instead, as SwiftlyS2's menus.example.jsonc shows.
| What | Path |
|---|---|
| Plugin | addons/swiftlys2/plugins/CustomHUD/ |
| Config |
addons/swiftlys2/configs/plugins/CustomHUD/config.jsonc, created on first start |
| Renderer and keys, and by default the starting mode and page size |
addons/swiftlys2/configs/menus/menus.jsonc, SwiftlyS2's |
| Translations | addons/swiftlys2/plugins/CustomHUD/resources/translations/ |
| Panels API contract | addons/swiftlys2/plugins/CustomHUD/resources/exports/CustomHUD.Contract.dll |
| Layouts | The CustomHUD Workshop addon, on each player's game |
| Check | Expect |
|---|---|
| Console at start |
[CustomHUD] Renderer 'customhud.panorama' registered., and with Cookies [CustomHUD] Persisting player preferences through Cookies.
|
| Any plugin's menu | Drawn at the left of the screen, with its keys along the bottom |
!setnav mouse, then a menu |
A cursor, and the menu answers clicks |
!hudscale |
The six steps, 80 to 150
|
{ "Menus": { "Renderer": "customhud.panorama" } }