Skip to content

Commit 16c5fd7

Browse files
committed
Unfinished changes for client 1.17.0.0
1 parent 244821b commit 16c5fd7

7 files changed

Lines changed: 75 additions & 9 deletions

File tree

docs/client-docs/setup.md

Lines changed: 69 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,19 +61,79 @@ To run GameVault on Linux utilizing Wine, follow this community-driven method. V
6161

6262
## Initial Configuration
6363

64-
Once you have installed and launched GameVault, you need to do some initial configuration to get it up and running properly.
64+
Once you have installed and launched GameVault, the first thing you come across is the login window.
6565

66-
### Step 1: Select the Root Folder
66+
![profiles](/img/docs/setup-client/login-window-profiles.png)
6767

68-
In this step, you will choose the location where all your downloaded and installed games will be stored. This folder will act as the central location for your game library. We recommend you to have a read on the ["How to Use" Chapter](how-to-use.md) to understand how the root folder works.
68+
Here you can see your current created profiles. You must first create one in order to proceed.
6969

70-
To select the root folder, follow the instructions below:
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.
72+
:::
73+
74+
### Method 1: Sign In with a existing User Account
75+
76+
Click on "New Profile" -> "Sign In".
77+
78+
![signin](/img/docs/setup-client/login-window-signin.png)
79+
80+
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.
81+
82+
See more details about [Server Input validation](setup.md#server-input-validation) (If you have grayed out input boxes and don't know why)
83+
84+
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)
85+
86+
If you press the "Save" button a new profile will be created and you will be send back to the profile overview.
87+
88+
If you press the "Save and Login" button gamevault will create the profile and directly tries to launch this new profile.
89+
90+
### Method 2: Sign Up creting a new User Account
91+
92+
Click on "New Profile" -> "Sign Up".
93+
94+
![signup](/img/docs/setup-client/login-window-signup.png)
95+
96+
First enter your Server Url. Then the rest of the fields.
97+
98+
See more details about [Server Input validation](setup.md#server-input-validation) (If you have grayed out input boxes and don't know why)
99+
100+
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)
101+
102+
What happens after clicking the "Save and Sign Up" button depends on how the server is configured.
103+
104+
**1.** After signing up, the new user is immediately activated. Then you will be logged in.
105+
106+
**2.** The new user must first be activated by an administrator on the server.
107+
Then this ui will be displayed.
108+
109+
![pendingactivation](/img/docs/setup-client/login-window-pending-activation.png)
110+
111+
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+
113+
### Server Input validation
114+
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.
116+
117+
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+
119+
### SSO Login
120+
121+
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.
122+
123+
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+
125+
126+
### Step 1: Select the Root Folders
127+
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.
129+
130+
To select your root folders, follow these steps:
71131

72-
1. Click the "Select Root Path" button.
73-
2. Navigate to the desired location on your computer.
74-
3. Choose a folder with sufficient storage space to store your game collection.
75-
4. Once you have selected the folder, click "Next" to proceed.
76-
5. GameVault will automatically generate a Subfolder called `GameVault` in your selected Folder with some initial data.
132+
1. Click the "Select Root Paths" button.
133+
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.
77137

78138
### Step 2: Entering the Selfhosted Backend Server URL
79139

docs/server-docs/updating-games.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Let's say you have a very outdated version of the game `Minecraft (EA) (v1.8b) (
2222

2323
If you want to keep multiple versions of the same game, refer to the documentation on [adding the same game multiple times](adding-games.md#adding-the-same-game-multiple-times).
2424

25+
### Visual indicator in the client
26+
27+
Since version 1.17.0.0, the client can show the user if another version of the installed game is available.
28+
29+
![update available indicator](/img/docs/updating-games/update-available-indicator.png)
30+
2531
## Changing or Moving a Game
2632

2733
Changing or moving a game is also a breeze. As long as the **path** or **the combination of title and release year** of the moved or renamed file matches the old file, GameVault's indexer will recognize it as an update. The same game entity will be updated with the new file's information, while preserving any progress associated with the game.
22.9 KB
Loading
40.2 KB
Loading
17.2 KB
Loading
20.9 KB
Loading
508 KB
Loading

0 commit comments

Comments
 (0)