# icons
The icons menusKit draws on cards, radial orbs, the settings arrows, the back button, the victory stars and the touch pause button. Each one is a small inline SVG on a 256-unit grid, stroked in `currentColor`, so it takes the colour of whatever style it sits in and needs no icon font. It draws the same in the editor, a native player and the web player.
The looks call it for you. A game reaches it only to give a menu item an icon: `{ id = "shop", text = "Shop", icon = "shop" }` takes a built-in name, an alias such as `"storefront"`, or a whole `<svg ...>` document of its own.
- `Icons.node(ref, size, color?, opts?)`: an `svg` widget node, `size` points square. `opts` takes `weight`, `shadow = { dx, dy, color }`, `id` and `style`.
- `Icons.svg(ref, opts?)`: the SVG document string.
- `Icons.has(ref)`, `Icons.names()`, `Icons.aliases()`.
# galleryKeys
The gallery's shortcuts, held by `GalleryBrowser` while the showcase runs: 1 / 2 (LT / RT) change the look, 3 / 4 (Select) the screen, 5 / 6 (R3) the layout, and M (L3) toggles between walking and browsing. Touch players use the browser bar's buttons.
# strings
The string tables behind every word the menus draw: English (`en`), Brazilian Portuguese (`pt-BR`) and Spanish (`es`). It provides `t(key, vars)` with `{var}` substitution and inline `{ en = ..., es = ... }` tables, `number` (thousands grouped the language's way), `setLanguage` / `resolve` (with "pt" -> "pt-BR" and English fallback), `register` to add a language, and `keys` to list what a translator must cover.
Every other kit module calls it. Games use `menus.text`, `menus.setLanguage` and `menus.addLanguage`.
# MenusHost
Draws and drives menusKit's screens for the local player. `menusKit.menus` spawns it on a temporary, local entity the first time a game uses the kit in play, so a game never places it by hand and it needs no sibling components.
Each frame it builds the open screen's widget tree for the current screen size and safe area, runs focus, transitions and the credits roll, reads keyboard, gamepad and touch through the kit's input map and controlsKit (confirm, back, pause, d-pad, tabs), and shows the touch pause button. Escape / Start / the pause button open this player's pause menu only.
# layouts
The four ways to arrange a menu's choices on any look: `list` (centred column), `rail` (side rail with the title opposite), `carousel` (sliding cards) and `radial` (a ring of choices around a centre hub, built for sticks and d-pads). Each one adapts to phone-sized and portrait screens. It also provides `list`, `get`, `canonical` (aliases such as "sidebar", "cards" and "wheel") and `describe`.
`screens` calls it to lay out title, pause, game over and victory choices, and `menus.layouts()` reads its catalogue entries.
# themes
The eight looks: scifi, fantasy, cartoon, pixel, minimal, military, horror and cozy. Each look supplies its palette, fonts, backdrop, frames, focus treatment, title styling, enter/exit transitions and catalogue tags (mood, genres, best input). It also provides `list`, `get`, `canonical` (aliases such as "sci-fi" and "spooky"), `describe` and `fitTitle`.
`screens` and `layouts` call it while drawing, and `menus.looks()` / `menus.describe()` read its catalogue entries.
# sounds
The little UI sounds each look plays: move, confirm, back and open, with 32 baked clips in `sounds/` (`mk_<look>_<kind>`), routed to the `ui` channel and throttled so fast scrolling stays clean. It provides `play(look, kind)`, `clip(look, kind)`, `setEnabled(on, level)` and `isEnabled()`.
`menusKit.menus` plays them on focus moves, confirms, backs and screen opens. `setup{ sounds = false }` or `soundLevel` controls them.
# settings
This player's settings: master, music, effects and voice volume; look sensitivity; invert Y; button-prompt set; graphics quality; language. Each change applies at once (audio channels, `renderer.setQualityTier`, controlsKit prompt family, language) and is saved under the player's own `runtime_data` (key `menusKit/settings`), along with their controlsKit bindings, so it is back when they rejoin.
`menusKit.menus` wraps it (`settings`, `getSetting`, `setSetting`, `lookScale`), and the settings screen edits it.
# screens
Builds the widget tree for each of the seven screens (`title`, `pause`, `settings`, `gameover`, `victory`, `loading`, `credits`) from the current look, layout, language and screen size, plus the bottom prompt strip and the touch pause button. `build(name, state)` is the entry point.
Internal to the kit: `menusKit.menus` calls it while drawing. Games use `menus` instead.
# menus
The one module a game uses. `require("menusKit.menus")` gives the whole screen stack: `showTitle`, `showPause`, `showSettings`, `showGameOver`, `showVictory`, `showLoading` / `setProgress`, `showCredits`, `back`, `hide`, plus `on(event, fn)` to hear what the player picked. It also owns the look and layout (`setTheme`, `setLayout`, `setup`), the catalogue (`looks`, `layouts`, `describe`, `match`, `catalogue`), per-player settings (`settings`, `setSetting`, `lookScale`), language (`setLanguage`, `addLanguage`, `text`) and navigation helpers for tests (`navigate`, `focus`, `select`).
Game scripts and components call it. In play it spawns its own local `MenusHost` to draw and drive the screens, and while a menu is open it stands the local player's gameplay input down. The package README lists the full API.