You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/client-docs/setup.md
+60-62Lines changed: 60 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,156 +10,154 @@ If you want to use GameVault to download and install games on your computer, you
10
10
11
11
### Recommended Installation Option
12
12
13
-
**Requirement:** Windows 10/11 Operating System with Microsoft Store installed
13
+
**Requirement:** Windows 10/11 operating system with Microsoft Store installed
14
14
15
15
To begin, install the GameVault application from [the official Microsoft Store](https://www.microsoft.com/store/apps/9PCKDV76GL75).
16
16
17
-
Experienced users can also simply run this command in the PowerShell:
17
+
Experienced users can also simply run this command in PowerShell:
18
18
19
19
```ps
20
20
winget install gamevault
21
21
```
22
22
23
-
This process should be straightforward and will only consume a few minutes of your time. After installing, feel free to continue at[Initial Configuration](#initial-configuration).
23
+
This process should be straightforward and will only take a few minutes. After installing, proceed to[Initial Configuration](#initial-configuration).
24
24
25
25
### Alternative Installation Options
26
26
27
-
If you for some reasonprefer not to use the Microsoft Store or if you are operating on a different platform, there are multiple other methods available for installing the GameVault Client Application.
27
+
If, for some reason, you prefer not to use the Microsoft Store or are using a different platform, there are several other methods available to install the GameVault Client Application.
28
28
29
29
:::warning
30
-
Please not that any other method than installing it from the Microsoft Store is **unsupported** and **unrecommended** and should only be used as a last resort. Also be aware [that you will be responsible for managing updates manually!](updating-client.md#other-sources)
30
+
Please not that any other method than installing it from the Microsoft Store is **less supported** and **unrecommended** and should only be used as a last resort. Also be aware [that you will be responsible for managing updates manually!](updating-client.md#other-sources)
31
31
:::
32
32
33
-
#### Option 1: Obtain Pre-Built Artifacts from Github
33
+
#### Option 1: Obtain Pre-Built Artifacts from GitHub
34
34
35
-
Access the most recent Pre-Built Artifact[here.](https://github.com/Phalcode/gamevault-app/releases/latest)
35
+
Access the latest pre-built artifact[here](https://github.com/Phalcode/gamevault-app/releases/latest).
36
36
37
37
:::note Antivirus/Smartscreen Warning
38
-
Your Antivirus 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 because we lack a Code Signing Certificate due to budget constraints. You can safely disregard this warning and proceed to run the App by selecting `More Details` and then choosing `Run Anyway`.
38
+
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`.
39
39
:::
40
40
41
41
#### Option 2: Linux Installation
42
42
43
-
To run GameVault on Linux utilizing Wine, follow this community-driven method. Visit [this](../advanced-usage/linux-client.md) page for more details.
43
+
To run GameVault on Linux using Wine, [follow this community-driven method](../advanced-usage/linux-client.md).
44
44
45
45
#### Option 3: Self-Compiling on Windows
46
46
47
-
1. Install Visual Studio IDE (2022 recommended)
48
-
2. Install Workload ".Net Desktop development" and make sure DotNet 8.0 is installed.
49
-
3. Clone the gamevault-app source code
50
-
4. Open Visual Studio and choose the `.sln` file
51
-
5.Pick`Release` from the Dropdown menu.
52
-
6. Build > Build gamevault
53
-
7.Utilize the output files.
47
+
1. Install Visual Studio IDE (2022 recommended).
48
+
2. Install the ".NET Desktop Development" workload and ensure that .NET 8.0 is installed.
49
+
3. Clone the `gamevault-app` source code.
50
+
4. Open Visual Studio and choose the `.sln` file.
51
+
5.Select`Release` from the dropdown menu.
52
+
6. Build > Build gamevault.
53
+
7.Use the output files.
54
54
55
55
#### Option 4: Extracting from the .appxbundle
56
56
57
-
1. Go to [https://store.rg-adguard.net](https://store.rg-adguard.net)
58
-
2. Paste `https://www.microsoft.com/store/apps/9PCKDV76GL75`in the search box
59
-
3. Download the current .appxbundle
60
-
4. Extract the .appxbundle, followed by the `ReleasePackage_[VERSION]_x64.appx` file.
57
+
1. Go to [https://store.rg-adguard.net](https://store.rg-adguard.net).
58
+
2. Paste `https://www.microsoft.com/store/apps/9PCKDV76GL75`into the search box.
59
+
3. Download the current `.appxbundle`.
60
+
4. Extract the `.appxbundle`, followed by the `ReleasePackage_[VERSION]_x64.appx` file.
61
61
62
62
## Initial Configuration
63
63
64
-
Once you have installed and launched GameVault, the first thing you come across is the login window.
64
+
Once you have installed and launched GameVault, the first thing you will see is the login window.
Here you can see your current created profiles. You must first create one in order to proceed.
68
+
Here you can view your currently created profiles. You must create at least one to proceed.
69
69
70
70
:::note Info
71
-
If you do not yet have your own profile, the demo user will automatically be created as your profile. This will be removed as soon as you have created at least one profile of your own.
71
+
If you do not yet have your own profile, a demo user will automatically be created for you. This will be removed as soon as you create at least one profile of your own.
72
72
73
-
In case you want to add the demo user profile manually:
74
-
Server Url**demo.gamevau.lt**
75
-
Username: **demo**
76
-
Password: **demodemo**
73
+
To manually add the demo user profile:
74
+
Server URL:**demo.gamevau.lt**
75
+
Username: **demo**
76
+
Password: **demodemo**
77
77
:::
78
78
79
-
### Method 1: Sign In with a existing User Account
79
+
### Method 1: Sign In with an Existing User Account
First enter your Server Url. Then the Username and Password. If you want to sign in with SSO, then check the box "Sign in using your Identity Provider" at the bottom.
85
+
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.
86
86
87
-
See more details about [Server Input validation](setup.md#server-input-validation) (If you have grayed out input boxes and don't know why)
87
+
See more details about [Server Input Validation](setup.md#server-input-validation) (if input boxes are grayed out and you don't know why).
88
88
89
-
See more details about [SSO Login](setup.md#sso-login) if you want to login with a identity provider (or dont know why fields are grayed out after checking the "Sign in using your Identity Provider" box)
89
+
See more details about [SSO Login](setup.md#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).
90
90
91
-
If you press the "Save" button a new profile will be created and you will be send back to the profile overview.
91
+
If you press the "Save" button, a new profile will be created and you will be returned to the profile overview.
92
92
93
-
If you press the "Save and Login" button gamevault will create the profile and directly tries to launch this new profile.
93
+
If you press the "Save and Login" button, GameVault will create the profile and immediately attempt to launch it.
94
94
95
-
### Method 2: Sign Up creting a new User Account
95
+
### Method 2: Sign Up by Creating a New User Account
First enter your Server Url. Then the rest of the fields.
101
+
First enter your server URL, then fill out the remaining fields.
102
102
103
-
See more details about [Server Input validation](setup.md#server-input-validation) (If you have grayed out input boxes and don't know why)
103
+
See more details about [Server Input Validation](setup.md#server-input-validation) (if input boxes are grayed out and you don't know why).
104
104
105
-
See more details about [SSO Login](setup.md#sso-login) if you want to login with a identity provider (or dont know why fields are grayed out after checking the "Sign in using your Identity Provider" box)
105
+
See more details about [SSO Login](setup.md#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).
106
106
107
-
What happens after clicking the "Save and Sign Up" button depends on how the server is configured.
107
+
What happens after clicking "Save and Sign Up" depends on the server configuration:
108
108
109
-
**1.** After signing up, the new user is immediately activated. Then you will be logged in.
110
-
111
-
**2.** The new user must first be activated by an administrator on the server.
112
-
Then this UI will be displayed.
109
+
- A: The new user is activated immediately upon signing up, and you will be logged in.
110
+
- B: The new user must first be activated by an administrator. In that case, the following UI is shown:
Here you can either go back to the profile selection or wait until an admin activates you on the server. If that happens, you will be logged in immediately.
114
+
You can either return to the profile selection or wait until an admin activates your account. Once activated, you will be logged in automatically.
117
115
118
-
### Server Input validation
116
+
### Server Input Validation
119
117
120
-
Both Sign In and Sign Up have built-in input validation when entering the server URL. The client checks whether the server is accessible or not. In addition, certain fields can be configured as mandatory on the server. Or SSO can be enforced. All these server-side configurations are then displayed as input validation.
118
+
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.
121
119
122
-
If you have entered a valid gamevault server address, this is indicated by a green check mark. If the URL cannot be reached or there are other problems, this is indicated by a red error symbol. When you hover over it with the mouse, you can also get more information about the error.
120
+
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.
123
121
124
122
### SSO Login
125
123
126
-
When logging in with SSO, instead of using a username and password, you are authenticated via the identity provider configured on the server. This could be Google, Microsoft, or GitHub, for example. When you log in for the first time, or after your session has expired, a webview popup opens that redirects you to the authentication page of the respective identity provider.
124
+
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.
127
125
128
-
After checking the "Sign in using your Identity Provider" in the sign in or sign up dialogs, all fields except Server Url will be grayed out. Thats because gamevault will get all these information out of the identity provider authentication.
126
+
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.
129
127
130
128
### Additional Request Headers
131
129
132
-
In the top right corner of the Login Window you can find a gear icon to open the Login windows settings.
130
+
Click the gear icon in the top right corner of the login window to access the login settings.
133
131
134
-
Here you can find the controls to set the additional request headers.
132
+
There you can configure additional request headers.
Press the "Add" button to create a new additional request header Key/Value pair. Enter your data and press "Save". Remove the header by pressing the red cross button on each header entry.
139
-
140
-
The additional request headers are sent with every web request from the client.
136
+
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.
141
137
142
-
This can be useful if your server has special connection conditions. This ensures that the gamevault client can still function in such cases.
138
+
These headers are sent with every web request from the client and are useful if your server has special connection requirements.
143
139
144
140
### Select the Root Directories
145
141
146
-
The last necessary step to be able to use the GameVault client properly is to select the root directories.
142
+
The final required step to properly use the GameVault client is selecting the root directories.
147
143
148
-
In this step, you will choose one or more locations where your downloaded and installed games will be stored. These folders will serve as the base directories for your game library. We recommend reading the ["How to Use" Chapter](how-to-use.md)to better understand how root folders are managed.
144
+
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](how-to-use.md)for more details on root folder management.
149
145
150
-
Navigate to Settings -> Data -> File System -> Root Directories.
146
+
Navigate to:
147
+
**Settings → Data → File System → Root Directories**
Click the "Add" Button and select your path from the file dialog. Repeat if you want to have multiple root directories.
151
+
Click "Add" and select your desired path in the file dialog. Repeat to add multiple root directories.
155
152
156
153
:::note Please Note
157
-
GameVault will automatically create a subfolder called`GameVault` in each selected directory and initialize it with the required data.
154
+
GameVault will automatically create a subfolder named`GameVault` in each selected directory and initialize it with the required data.
158
155
:::
159
156
160
-
161
157
## Conclusion
162
158
163
-
Congratulations! You have successfully installed and completed the initial configuration of GameVault. You are now ready to explore and enjoy the features and functionality of the app. If you have any further questions or need assistance, refer to the remaining chapters of this documentation or reach out to our support team for help.
159
+
Congratulations! You have successfully installed and configured GameVault. You are now ready to explore and enjoy the features and functionality of the app.
160
+
161
+
If you have further questions or need help, refer to the remaining chapters of this documentation or contact our support team.
164
162
165
-
We specifically recommend to read the ["How to Use" Chapter](how-to-use.md) to understand how GameVault works.
163
+
We especially recommend reading the ["How to Use" chapter](how-to-use.md) to better understand how GameVault works.
0 commit comments