Skip to main content

Setting up a GameVault Client

Follow this guide to install GameVault on your computer and connect it to a server.

Installation​

GameVault is available as two desktop clients:

  • GameVault (legacy Windows app): the original Windows client, distributed through the Microsoft Store. It is still supported.
  • GameVault Desktop (cross-platform) (early access): the modern client, available for Windows, Linux, and macOS soon.

The Web UI itself can also be used directly in your browser; see Web UI.

GameVault Desktop (Cross-Platform)​

Early Access

The cross-platform client is still in early access. It is available for Windows, Linux, and macOS, but you may run into bugs and missing features. If you need the most reliable experience, use the legacy Windows app for now.

Platform support

We mainly test the cross-platform client on Linux and Windows. macOS builds are provided, but less thoroughly tested, so you may run into more issues on the Mac.

Download the installer for your platform from the GitHub releases page:

  • Windows: the *-setup.exe (NSIS) installer
  • Linux: the .deb package or the .AppImage
  • macOS: the .dmg

The cross-platform client keeps itself up to date through a built-in updater; see Updating the Client.

Web UI​

If you don't want to install anything, open the Web UI directly in your browser at your server's address (e.g. http://192.168.0.15:8080). The Web UI is served by the server itself and offers the same interface as the cross-platform client. Keep in mind that a browser-only session cannot launch or install games on your computer: the full download manager is only available in the desktop clients.

Legacy Windows App​

Requirement: Windows 10/11 operating system with Microsoft Store installed

To begin, install the GameVault application from the official Microsoft Store.

Experienced users can also simply run this command in PowerShell:

winget install gamevault

After installation, continue with Initial Configuration.

Alternative Installation Options​

If you do not want to use the Microsoft Store, or you are on another platform, use one of the alternatives below.

warning

Please note that every option outside the Microsoft Store is less supported and should be treated as a fallback. You will also need to manage updates manually.

Option 1: Obtain Pre-Built Artifacts from GitHub​

Access the latest pre-built artifact here.

Antivirus/Smartscreen Warning

Your antivirus software or Windows Smartscreen may attempt to prevent you from running our pre-built application because it is a suspicious-looking binary compiled by an unfamiliar source. This is due to the lack of a code signing certificate for budget reasons. You can safely disregard this warning and proceed to run the app by selecting More Details and then choosing Run Anyway.

Option 2: Linux Installation​

To run GameVault on Linux using Wine, follow this community-driven method.

Native Linux client

If you are on Linux, you no longer need Wine: the cross-platform client ships native .deb and .AppImage packages.

Option 3: Self-Compiling on Windows​
  1. Install Visual Studio IDE (2022 recommended).
  2. Install the ".NET Desktop Development" workload and ensure that .NET 8.0 is installed.
  3. Clone the gamevault-app source code.
  4. Open Visual Studio and choose the .sln file.
  5. Select Release from the dropdown menu.
  6. Build > Build gamevault.
  7. Use the output files.
Option 4: Extracting from the .appxbundle​
  1. Go to https://store.rg-adguard.net.
  2. Paste https://www.microsoft.com/store/apps/9PCKDV76GL75 into the search box.
  3. Download the current .appxbundle.
  4. Extract the .appxbundle, followed by the ReleasePackage_[VERSION]_x64.appx file.

Initial Configuration​

The configuration below applies to both the cross-platform client and the legacy Windows app.

Once you have installed and launched GameVault, the first thing you will see is the login window.

profiles

Here you can view your currently created profiles. You must create at least one to proceed.

Multiple Profiles

GameVault supports the use of multiple profiles on the same client. This allows you to log in with different user accounts on different servers using a single device. However, this feature is only available with a GameVault+ subscription.

Demo User

If you do not have any profiles or a running GameVault Server, a demo profile will appear in the list. You can use this profile to test the client. This profile will be removed as soon as you create at least one profile of your own.

To manually add the demo user profile:

Server URL: demo.gamevau.lt
Username: demo
Password: demodemo

Method 1: Sign In with an Existing User Account​

Click on "New Profile" -> "Sign In".

signin

First enter your server URL, then your username and password. If you want to sign in using SSO, check the box "Sign in using your Identity Provider" at the bottom.

See more details about Server Input Validation (if input boxes are grayed out and you don't know why).

See more details about SSO Login if you want to log in using an identity provider (or don't know why fields are grayed out after checking the box).

If you press the "Save" button, a new profile will be created and you will be returned to the profile overview.

If you press the "Save and Login" button, GameVault will create the profile and immediately attempt to launch it.

Method 2: Sign Up by Creating a New User Account​

Click on "New Profile" -> "Sign Up".

signup

First enter your server URL, then fill out the remaining fields.

See more details about Server Input Validation (if input boxes are grayed out and you don't know why).

See more details about SSO Login if you want to log in using an identity provider (or don't know why fields are grayed out after checking the box).

What happens after clicking "Save and Sign Up" depends on the server configuration:

  • A: The new user is activated immediately upon signing up, and you will be logged in.
  • B: The new user must first be activated by an administrator. In that case, the following UI is shown:

pendingactivation

You can return to the profile selection or wait for an admin to activate your account. Once that happens, the client logs you in automatically.

Server Input Validation​

Both Sign In and Sign Up include built-in input validation for the server URL. The client checks whether the server is accessible. In addition, some fields may be required by the server configuration, or SSO may be enforced. These requirements will be reflected in the input validation.

A valid GameVault server address will be marked with a green check mark. If the URL cannot be reached or other problems occur, a red error symbol appears. Hover over it for more detailed error information.

SSO Login​

When using SSO, you authenticate via the identity provider configured on the server, such as Google, Microsoft, or GitHub, instead of using a username and password. On your first login or after session expiration, a webview popup opens to redirect you to the provider’s authentication page.

After checking "Sign in using your Identity Provider" in the Sign In or Sign Up dialogs, all fields except the server URL will be grayed out. This is because GameVault retrieves all necessary information from the identity provider.

Additional Request Headers​

Click the gear icon in the top right corner of the login window to access the login settings.

There you can configure additional request headers.

pendingactivation

Click the "Add" button to create a new request header (key/value pair). Enter your data and press "Save". Remove a header by clicking the red cross icon next to it.

These headers are sent with every web request from the client and are useful if your server has special connection requirements.

Select the Root Directories​

The final required step to properly use the GameVault client is selecting the root directories.

These are the locations where your downloaded and installed games will be stored. They act as base folders for your game library. We recommend reading the "How to Use" chapter for more details on root folder management.

Navigate to: Settings → Data → File System → Root Directories

rootpath

Click "Add" and select your desired path in the file dialog. Repeat to add multiple root directories.

Please Note

GameVault will automatically create a subfolder named GameVault in each selected directory and initialize it with the required data.

Next Step​

Your client is now ready to use.

For day-to-day usage, read the "How to Use" chapter.