Settings screen

Settings menu

Players can change display, audio, and gameplay options from the main menu, or from the Settings button beside Exit during a run. Apply saves the options and applies the display settings immediately. Exit throws away unsaved edits. From the main menu, Exit returns to the main menu. During a run, Exit closes the menu and returns to the same run. The run pauses while that menu is open.

The page has four sections: Display, Audio, Gameplay, and Run history. Achievements, online play, and the win screen are not part of this menu.

Saved options are written to DECO2800Game/settings.json under the home directory. Run times are written to DECO2800Game/game-save.json.

How to use it

From the main menu

1. On the main menu, press Settings.
2. Change the options you want.
3. Press Apply to save them, or Exit to leave them unchanged and return to the main menu.

During a run

1. Press Settings, to the left of Exit.
2. The run pauses. Enemies and the run timer stop.
3. The game HUD is hidden while this menu is open. Change the options. UI scale is in the Display section and does not resize this menu. Press Apply and the HUD panels grow or shrink from the edge each one sits on. The smallest scale is 0.5×.
4. Press Apply to keep the changes, or Exit to drop them and continue the same run.

What each control does

Control	What it does
FPS cap	Limits how many frames the game draws per second.
Fullscreen	Turns fullscreen on or off. The resolution list is used only while fullscreen is on.
VSync	Matches the frame rate to the monitor.
Resolution	Fullscreen size and refresh rate. If nothing is selected, Apply keeps the current display mode.
Window size	Size of the window when fullscreen is off. Choices are 960×540, 1280×720, 1280×800, 1600×900, and 1920×1080.
UI scale	In the Display section, from 0.5× to 2×. The settings page stays the same size. The HUD changes after Apply.
Music	Background music volume.
Effects	Sound effect volume.
Mute in background	Silences music and effects while the window is not focused.
Show run timer	Shows or hides the run timer on the HUD.
Show FPS	Shows or hides the FPS counter in the bottom-right corner. Turn it on, press Apply, then start or return to a run.
Last run / Best run	Times stored on this computer.
Reset times	Clears last run and best run. It does not clear achievements.

Class diagram

classDiagram
  class MainMenuActions {
    +onSettings()
  }
  class SettingsScreen {
    +render()
  }
  class MainGameExitDisplay {
    +showExitDialog()
  }
  class MainGameScreen {
    +render()
    +resize()
  }
  class SettingsMenuDisplay {
    +open()
    +applyChanges()
    +exitMenu()
  }
  class UserSettings {
    +get() Settings
    +set(Settings, boolean)
    +applySettings(Settings)
  }
  class Settings {
    +int fps
    +boolean fullscreen
    +boolean vsync
    +float uiScale
    +boolean showTimer
    +boolean showFps
    +float musicVolume
    +float soundVolume
    +int windowWidth
    +int windowHeight
    +boolean muteUnfocused
    +DisplaySettings displayMode
  }
  class WindowSize {
    +matching(int, int) Preset
    +width(int) int
    +height(int) int
  }
  class UiScale {
    +clamp(float) float
    +apply(Group, float)
    +applyToStage(Stage, float)
  }
  class AudioLevels {
    +music() float
    +effects() float
    +audible() boolean
  }
  class GameProgress {
    +get() SaveData
    +recordRun(long)
    +clearSave()
    +formatTime(long) String
  }
  class TimerDisplay {
    +create()
  }
  class FpsOverlay {
    +create()
  }

  MainMenuActions --> SettingsScreen : open from the main menu
  SettingsScreen --> SettingsMenuDisplay : creates the page
  MainGameExitDisplay --> SettingsMenuDisplay : open during a run
  MainGameScreen --> SettingsMenuDisplay : pauses while the menu is open
  SettingsMenuDisplay --> UserSettings : read and save
  SettingsMenuDisplay --> WindowSize : window size list
  SettingsMenuDisplay --> UiScale : scale the page and the HUD
  SettingsMenuDisplay --> GameProgress : last run, best run, reset
  UserSettings --> Settings : settings.json
  UserSettings --> WindowSize : windowed size
  MainGameScreen --> UiScale : scale the HUD
  MainGameScreen --> TimerDisplay : run timer
  MainGameScreen --> FpsOverlay : FPS counter
  TimerDisplay --> UserSettings : showTimer
  FpsOverlay --> UserSettings : showFps
  AudioLevels --> UserSettings : music, effects, mute

Loading

Sequence diagram

Open from the main menu and save:

sequenceDiagram
  participant Player
  participant Main as MainMenuActions
  participant Page as SettingsMenuDisplay
  participant Settings as UserSettings

  Player->>Main: Settings
  Main->>Page: show the settings screen
  Player->>Page: change options
  Player->>Page: Apply
  Page->>Settings: set(settings, true)
  Settings->>Settings: write settings.json
  Settings->>Settings: apply FPS, VSync, and fullscreen or window size
  Player->>Page: Exit
  Page->>Main: return to the main menu

Loading

Open during a run. Exit keeps the run:

sequenceDiagram
  participant Player
  participant Exit as MainGameExitDisplay
  participant Run as MainGameScreen
  participant Page as SettingsMenuDisplay
  participant Scale as UiScale
  participant Settings as UserSettings

  Player->>Exit: Settings
  Exit->>Run: pause physics, rooms, and the run timer
  Exit->>Page: open
  Player->>Page: drag UI scale
  Player->>Page: Apply
  Page->>Scale: resize each HUD panel from its own edge
  Player->>Page: Exit
  Page->>Settings: read the saved scale
  Page->>Scale: restore it
  Page->>Run: close the menu and resume the run

Loading

Reset the stored times:

sequenceDiagram
  participant Player
  participant Page as SettingsMenuDisplay
  participant Save as GameProgress

  Player->>Page: Reset times
  Page->>Save: clearSave
  Save->>Save: set last run and best run to zero
  Page->>Player: show 0:00

Loading

Tests

From source/:

./gradlew test --tests com.csse3200.game.components.settingsmenu.InGameSettingsTest --tests com.csse3200.game.components.settingsmenu.SettingsMenuDisplayTest --tests com.csse3200.game.ui.UiScaleTest --tests com.csse3200.game.files.UserSettingsTest --tests com.csse3200.game.files.WindowSizeTest --tests com.csse3200.game.files.AudioLevelsTest --tests com.csse3200.game.files.GameProgressTest --tests com.csse3200.game.components.gamearea.TimerDisplayTest

InGameSettingsTest checks that the in-game Settings button opens the menu, the world stops updating while it is open, UI scale changes the menu, and Apply and Exit stay at normal size.