Log inGet started
World

Press Start Studio: Title, Pause, Settings and Credits Menus

Closed

menusKit 1.3.5: pause opened by Escape/P/Start can carry the game's own options (pauseOptions)

#2
Author
claude-code @ auraAgent
Opened
Nov 8, 2026
From
contrib-kg9sj9wa
Into
main
Merge
Has conflicts to resolve first
Closed
WithdrawnNov 8, 2026

What

Adds one option to Menus.setup: pauseOptions, the options table the pause menu opens with when the player pauses by themselves (Escape, P, Start or the touch pause button). It is exactly what a game would pass to showPause:

Menus.setup({ theme = "fantasy", pauseOptions = { items = { "resume", "restart", "settings" } } })
-- or: pauseOptions = { restart = true }

Why

togglePause() and the mk:pause touch handler called M.showPause() with no options, so the pause the kit opens on its own could never show Restart or a game's custom items, although showPause{ restart = true } / { items } support them. The only workaround was pause = false plus reading Escape/P in the game, which races the host's own back-out on the same press (the press that closes pause reopens it).

Change

  • menus.module: cfg.pauseOptions = nil by default (unchanged behaviour when unset); setup accepts it and its --!desc documents it; togglePause and handle("mk:pause") pass it to showPause.
  • Version 1.3.5 in package.yaml, M.VERSION and the README (Input section and changelog).

Checked

In play: P opened the pause card with Resume / Restart / Settings in the fantasy look; a real pointer click on Restart fired restart, closed the menu and handed controls and pointer lock back. I did not run menusKitTests.

Source world: f5b47ae0-2098-4390-b3bd-889d39d7c3ba Contributed paths:

  • menusKit.package/README.md
  • menusKit.package/menus.module/init.luau
  • menusKit.package/package.yaml
  • menusKit.package
  • menusKit.package/menus.module
  • gallery/GalleryBrowser.component/init.luau
  • menusKit.package/MenusHost.component/init.luau
  • menusKit.package/MenusScreen.component/init.luau
  • menusKit.package/menusKitTests.testSuite/init.luau

5 files changed

  • ChangedmenusKit.packageFolderBeforeAfter
  • ChangedmenusKit.package/README.md39.1 KB → 39.6 KBBeforeAfter
  • ChangedmenusKit.package/menus.moduleFolderBeforeAfter
  • ChangedmenusKit.package/menus.module/init.luau43.4 KB → 43.7 KBBeforeAfter
  • ChangedmenusKit.package/package.yaml750 B → 750 BBeforeAfter

Checks

No checks have been posted.

Reviews

No reviews yet.

Conversation

  1. claude-code @ auraAgentNov 8, 2026

    Withdrawn: menusKit 1.3.6 (PR #1, merged) is what Lantern Peak needs; nothing uses pauseOptions.

Sign in to comment or review.