Skip to main content

GUI Overview

This documentation provides a clear overview of the Graphical User Interface (GUI) for GameVault. The GUI encompasses various tabs, each offering distinct functionalities.

Login Window​

See more here

Library​

"Library Tab"

  • Browse available and installed games.
  • Expand or collapse sections with expanders.
  • Launch installed games by clicking the play button on box art.
  • Download available games by clicking the download button on box art.
  • Access game settings directly with the Settings icon.
  • The paged Library loads a maximum of 80 games at once for bandwidth efficiency.
  • Use the dice icon to open a random game on the server.
  • Employ the Filter icon for server game filtering.
  • Utilize the search bar to find specific games.

Game​

"Game Page"

  • View game details, including a media player for trailers, gameplay videos, and screenshots
  • Descriptions and Notes can also be displayed as Markdown.
  • Set progress states (e.g., completed or aborted).
  • Review personal progress and that of other users
  • Add games to the download queue or launch installed games.
  • Bookmark the game or create a share link
  • Navigate back to the Library Tab using the back-arrow button or ESC key.

Game Settings​

Your Computer​

  • Settings affecting local game installations.

Installation​

  • View installation directory.
  • Uninstall games.
  • Check disk usage for the game.

Launch Options​

  • Set default executable and launch parameters.
  • Create desktop shortcuts.

Server​

  • Settings affecting all users on the server (visible to editors or higher).

Edit Game Images​

  • Set a different thumbnail/background image using URLs or uploads. Has also a button to simplify the search for box/background images

Metadata​

"Metadata"

  • View available metadata providers.
  • Change metadata providers priority.
  • Unmap metadata providers. If unmaped the header text will be grayed out a bit and the action buttons are disabled.
  • Recache selected metadata provider.
  • Switch metadata from selectd metadata providers in the "Remap Game" section.

Custom Metadata​

"Custom Metadata"

  • Have full control of all the specific game details such as description, genres, tags etc including a preview of the current set data.
  • Click the relead icon beside a game detail to load the current values into the textbox.
  • Clear all user overwritten details by clicking the related button on the top right.
    Format

    Multiple entries such as genres, tags etc. must be separated by a comma.

Downloads​

"Downloads Tab"

  • Monitor running and completed downloads.
  • View download statistics and progress.
  • Abort downloads.
  • Extract game archives and view extraction progress.
  • Perform installations based on game types.
  • Open download folders and delete downloaded files.

Community​

"Community Tab"

  • View all users on the GameVault Server.
  • Select users for detailed game progress information.
  • Sort and delete progresses.
  • Edit user details and reload progresses.

User Settings​

Edit User Images​

  • Set avatar/background images using URLs or uploads.

Edit Details​

  • View and update user details.
  • Update passwords with confirmation.
  • Copy API key of your own user.

Settings​

Settings are organized into categories and opened from the sidebar (gear icon).

Downloads​

Everything about storing and downloading your games:

  • Configure the download bandwidth limit.
  • Select the download and installation root folders.
  • Set if you want to auto-extract downloaded games and set a default password for encrypted archives.
  • Set if portable games should be auto-installed and if the install files should be auto-deleted.

Library​

  • Settings that shape your game library (e.g. retain sorting and filter preferences after restart).

Privacy & Analytics​

  • Decide what information GameVault shares with the outside (analytics and error reporting).

Appearance​

  • Change the client theme (dark/light).
  • Adjust the UI zoom level.

Sound​

  • Control volume and sound effects in GameVault.

Startup (Desktop Only)​

  • Launch GameVault on computer startup.
  • Minimize GameVault to the system tray when closing the window. The app keeps running in the background so playtime tracking continues.

Ignore List​

  • View and edit the list of executables GameVault should skip (used by the playtime tracker).

Developer Tools​

  • Hidden utilities for development and testing. Unlock them by tapping the version number 5 times.

About​

  • Show the application version, the update channel, and the automatic update status (desktop clients).
  • Browse the third-party open-source licenses.
Legacy Windows App

The legacy Windows app organizes its settings into the tabs Application, Installation, User, and Data (root directories, image/offline cache, ignored executables, ISO mounting, and theme installation).

Administration​

"Admin Tab"

  • Visible to admins only.
  • View, activate/deactivate, and edit user roles.
  • Delete or restore users.
  • Open Community Tab profile by clicking on users' avatars.
  • Re-index games on the server.

News​

"News"

  • At the bottom left of the screen is a button with which you can display the latest news from gamevault or the server's own news.
  • When new news are available the button will be marked with a red badged.
  • News can also be displayed as Markdown.
  • Administrators can edit the server's news with the built-in News Editor (Markdown supported). Changes are saved to the server's news.md file.

Gamepad​

Starting with v17.0.0, the client supports gamepad navigation. Connect a gamepad and use the D-pad or left stick to move the focus between UI elements: the A button confirms/activates the focused element and the B button goes back. A visible focus ring shows the currently selected element while navigating with a gamepad.