ui Menus and UI

Change Log

  • References to a “run” have been replaced with the term “run”.

Required Controls

  • Toggle switch (On/Off)
  • Slider + manual input field
  • Dropdown options
  • Button selector, for controls remapping (see Controls)

Outline

Each of the following headings are a submenu within the settings menu. They should be presented as tabs that the player can cycle through (controller) or click on (kbm).

Gameplay

NameDescriptionTypeDefault
Auto end turnAutomatically end your turn when there’s nothing left you can do.ToggleOff

* Only changeable on the title screen. Should be greyed out during gameplay.

Video

NameDescriptionTypeDefault
ResolutionChange the render resolution.Dropdown (resolution options)Closest resolution to screen size
DisplayChange which display the game is on.Dropdown (list of connected monitors)Main monitor
Window ModeChange the window/fullscreen mode.Dropdown:
- Fullscreen
- Windowed Fullscreen
- Windowed
Windowed fullscreen
VSyncEnable or disable VSync.ToggleOff
Max Frame Rate*Set a maximum framerate for the game.Slider
- min = 30
- max-1 = monitor refresh rate
- max = unlimited
Monitor refresh rate
Graphics Settings**

* If the Max Frame Rate hasn’t been set manually, it should automatically change to the monitor’s refresh rate whenever the Display setting is changed.

** I doubt our game will be intense enough to warrant graphics settings. But if we need them, and the team has a way to implement them for particles n shit, they’d go here.

Audio

NameDescriptionTypeDefault
MasterSet the overall volume of the game.Slider 0-10050%
MusicSet the volume of background music.Slider 0-100100%
SFXSet the volume of sound effects.Slider 0-100100%

Controls

NameDescriptionTypeDefault
Controller Pointer SpeedChange the speed of the controller pointer.Slider 1-10050%
Camera Movement SpeedChange the speed of camera controls.Slider 1-10050%

Beneath the above settings, this tab needs its own UI formatted like a table. The table below should be used as an example for layout purposes. See this table in Player Controls for the actual list of controls.

  • The controller input glyphs should match the style of the controller currently in use, or if there is none/the type can’t be read, use Xbox glyphs.
ActionKeyboardController
ConfirmEnterA
BackBackspaceB
StatusTabX
End TurnSpaceSelect
Cycle LeftQLB
Cycle RightERB
etc…

Accessibility

SettingDescriptionTypeDefault
Colorblind Mode*Apply a filter to items to make their rarities easier to tell apart.Dropdown
- One setting for none
- A setting for each colorblind filter we want
None
Screen Shake IntensityAdjust how intense screen shake effects are.Slider 0-100100%

* In the UI for this setting, there should be a preview of how the effected HUD elements will look with the current setting.

Save Data

This tab’s controls MUST be disabled while the player is in a run. If the player navigates to this tab, show a message asking them to return to the title screen to manage save data.

Opening the game should create and automatically set up a save file for the player.

  • Current save file: [save file name]
  • Change save file (button)
  • Copy save file (button)
  • Delete save file (button)