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/gui.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ sidebar_position: 98
6
6
7
7
This documentation provides a clear overview of the Graphical User Interface (GUI) for GameVault. The GUI encompasses various tabs, each offering distinct functionalities.
8
8
9
-
## Setup Wizard
9
+
## Login Window
10
10
11
-
The Setup Wizard is a sub-page that appears when the necessary settings for GameVault are not configured. It guides users through these settings with detailed explanations. Exiting the wizard is optional, as all settings can also be configured in the settings tab.
11
+
See more [here](setup.md#initial-configuration)
12
12
13
13
## Library
14
14
@@ -112,31 +112,39 @@ The Setup Wizard is a sub-page that appears when the necessary settings for Game
112
112
113
113
- View and update user details.
114
114
- Update passwords with confirmation.
115
+
- Copy API key of your own user.
115
116
116
117
## Settings
117
118
118
119
### Application
119
120
120
-
- Configure server URL and startup options.
121
+
- Launch GameVault on Computer Startup
122
+
- Minimize GameVault to System Tray on Startup
123
+
- Auto-Load Library from Server on Startup
121
124
- Change curren client theme or open the theme folder to insert your own.
125
+
- Download and Install a Theme from the Community Themes.
126
+
- Retain Sorting and Filter preferences after restart.
122
127
123
128
### Installation
124
129
125
130
- Configure the donwload bandwidth limit.
126
131
- Set if you want to auto extract downloaded games and set a default password for encrypted archives.
132
+
- Set default extraction password for encrypted archives.
133
+
- Mount ISO files automatically.
127
134
- Set if portable games should be auto installed and if the install files should be auto deleted.
128
135
129
136
### User
130
137
131
-
-Log In to GameVault Backend Server.
132
-
-Log Out from GameVault Backend Server.
133
-
-Register a new user on the GameVault Backend Server.
134
-
-Enter current User Settings
138
+
-Edit User
139
+
-Change Profile (Goes back to profile selection)
140
+
-Logout from this Device (Removes refresh token from local config)
141
+
-Logout from All Devices (Revokes refresh token server side)
135
142
136
143
### Data
137
144
138
-
- Select GameVault root path and clear image and offline caches.
Copy file name to clipboardExpand all lines: docs/client-docs/setup.md
+24-47Lines changed: 24 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,8 +44,8 @@ To run GameVault on Linux utilizing Wine, follow this community-driven method. V
44
44
45
45
#### Option 3: Self-Compiling on Windows
46
46
47
-
1. Install Visual Studio IDE
48
-
2.Include the 2017 build system
47
+
1. Install Visual Studio IDE (2022 recommended)
48
+
2.Install Workload ".Net Desktop development" and make sure DotNet 8.0 is installed.
49
49
3. Clone the gamevault-app source code
50
50
4. Open Visual Studio and choose the `.sln` file
51
51
5. Pick `Release` from the Dropdown menu.
@@ -69,6 +69,11 @@ Here you can see your current created profiles. You must first create one in ord
69
69
70
70
:::note Info
71
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.
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**
72
77
:::
73
78
74
79
### Method 1: Sign In with a existing User Account
@@ -104,15 +109,15 @@ What happens after clicking the "Save and Sign Up" button depends on how the ser
104
109
**1.** After signing up, the new user is immediately activated. Then you will be logged in.
105
110
106
111
**2.** The new user must first be activated by an administrator on the server.
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.
112
117
113
118
### Server Input validation
114
119
115
-
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 such as email can be configured as mandatory on the server. Or SSO can be enforced. All these server-side configurations are then displayed as input validation.
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.
116
121
117
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.
118
123
@@ -122,64 +127,36 @@ When logging in with SSO, instead of using a username and password, you are auth
122
127
123
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.
124
129
130
+
### Additional Request Headers
125
131
126
-
### Step 1: Select the Root Folders
132
+
In the top right corner of the Login Window you can find a gear icon to open the Login windows settings.
127
133
128
-
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.
134
+
Here you can find the controls to set the additional request headers.
2. Navigate to one or more desired locations on your computer.
134
-
3. Choose folders with sufficient storage space for your game collection.
135
-
4. Once you have selected all desired folders, click "Next" to proceed.
136
-
5. GameVault will automatically create a subfolder called `GameVault` in each selected folder and initialize it with the required data.
138
+
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.
137
139
138
-
### Step 2: Entering the Selfhosted Backend Server URL
140
+
The additional request headers are sent with every web request from the client.
139
141
140
-
To connect your GameVault application to the backend server, you need to provide the URL of the server. Depending on your setup, follow one of the two options below:
142
+
This can be useful if your server has special connection conditions. This ensures that the gamevault client can still function in such cases.
141
143
142
-
#### Option 1: Self-hosted GameVault Server
144
+
###Select the Root Directories
143
145
144
-
If you have your own self-hosted GameVault server, please enter its URL in the provided field. Follow the instructions below:
146
+
The last necessary step to be able to use the GameVault client properly is to select the root directories.
145
147
146
-
1. Enter the URL of your self-hosted GameVault server in the provided field.
147
-
2. Make sure you have the correct URL and it is accessible.
148
-
3. Click "Next" to proceed.
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.
149
149
150
-
#### Option 2: Using the Demo Server
150
+
Navigate to Settings -> Data -> File System -> Root Directories.
151
151
152
-
If you only want to try out GameVault, without setting up your own server, you can use our demo server. There open-source videogames available. Keep in mind that you will have mostly read-only non-admin rights on that server. To use the demo server, follow the instructions below:
1. Enter "demo.gamevau.lt" as the URL in the provided field.
155
-
2. This will allow you to explore the features and functionality of GameVault.
156
-
3. Click "Next" to proceed
154
+
Click the "Add" Button and select your path from the file dialog. Repeat if you want to have multiple root directories.
157
155
158
-
:::info Demo Server Credentials
159
-
Username: **demo**
160
-
Password: **demodemo**
156
+
:::note Please Note
157
+
GameVault will automatically create a subfolder called `GameVault` in each selected directory and initialize it with the required data.
161
158
:::
162
159
163
-
### Step 3: Log In or Register
164
-
165
-
In this step, you will need to log in to your GameVault account on the selected backend server. Choose one of the following options based on your situation:
166
-
167
-
#### Option 1: Login
168
-
169
-
If you already have a GameVault account on the selected server, follow these steps:
170
-
171
-
1. Select "Login" from the options.
172
-
2. Enter your login credentials (username and password) in the provided fields.
173
-
3. Ensure that the credentials are specific to the GameVault backend server you have chosen.
174
-
4. Click "Log in" to proceed.
175
-
176
-
#### Option 2: Register
177
-
178
-
If you don't have an account on the selected GameVault backend server, follow these steps:
179
-
180
-
1. Click the "Register" button.
181
-
2. Follow the instructions provided to create your GameVault account on the backend server.
182
-
3. The server administrators may have to activate your account before you can use it to log in. Contact them if necessary.
0 commit comments