Skip to content

Commit 6fa74c7

Browse files
Alfagun74Alfagun74
committed
Merge remote-tracking branch 'origin/develop'
2 parents fa77c79 + 6f85b4e commit 6fa74c7

4 files changed

Lines changed: 32 additions & 25 deletions

File tree

‎docs/advanced-usage/rest-api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_position: 4
66

77
The GameVault Backend Server offers a fully documented REST API for use to everyone. With the API, you can build your own GameVault clients or 3rd party integrations and manage your libraries automatically.
88

9-
## Register a Bot User
9+
## Registering a Bot User
1010

11-
To use the GameVault API, it is recommended to register a separate user with the username prefix `gvbot_` (e.g. `gvbot_image_downloader`). The bot user will not appear in the public user list. This user will be used to authenticate your API requests. You can do this by using the Register Form in the settings tab of the GameVault App.
11+
To use the GameVault API in automations, it is recommended to register a separate user with the username prefix `gvbot_` (e.g. `gvbot_image_downloader`). The bot user will not appear in the public user list. This user will be used to authenticate your API requests. You can do this by using the Register Form in the settings tab of the GameVault App.
1212

1313
## OpenAPI Specification
1414

‎docs/server-docs/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ This page describes the various configuration properties used in the application
123123

124124
| Property | Description | Default | Possible Values |
125125
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------- |
126-
| `AUTH_SEED` ` | Random seed for generating tokens. Generated automatically if not set. | Hash of any credential in the config. | Any random string, it doesn't matter what it says, or how long it is. |
126+
| `AUTH_SEED` | Random seed for generating tokens. Generated automatically if not set. | Hash of any credential in the config. | Any random string, it doesn't matter what it says, or how long it is. |
127127
| `AUTH_ACCESS_TOKEN_EXPIRES_IN` | Specifies how long an access token is valid. | `5m` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
128128
| `AUTH_REFRESH_TOKEN_EXPIRES_IN` | Specifies how long a refresh token is valid. | `30d` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
129129
| `AUTH_BASIC_AUTH_ENABLED` | Enables or disables Basic Auth. Disabling this will disable registering and logging in using username and password. | `true` | `true`, `false` |

‎docs/server-docs/metadata-enrichment/provider-igdb.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,28 @@
3333

3434
### Fields
3535

36-
| GameVault Field | IGDB API Field(s) | Notes |
37-
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------- |
38-
| `provider_slug` | `igdb` | hardcoded. |
39-
| `age_rating` | `age_ratings` | See [here](#age-rating) for details. |
40-
| `provider_data_id` | `id` | |
41-
| `provider_data_url` | `url` | |
42-
| `title` | `name` | |
43-
| `release_date` | `first_release_date` | |
44-
| `description` | `game.summary` and/or `game.storyline` | If both are available, both get used, else any available will be mapped |
45-
| `rating` | `total_rating` | |
46-
| `early_access` | `status` | True if the Game is either in status `alpha`, `beta` or `early_access` |
47-
| `developers` | `involved_companies` | Filtered by `involved_company.developer === true` |
48-
| `publishers` | `involved_companies` | Filtered by `involved_company.publisher === true` |
49-
| `genres` | `genres` | |
50-
| `tags` | `keywords` and `themes` | |
51-
| `cover` | `cover` | Using the highest possible cover resolution via `t_cover_big_2x` |
52-
| `background` | `artworks[0]` or `screenshots[0]` | Only first artwork/screenshot is mapped. Using the highest possible 16:9 resolution via `t_1080p_2x` |
53-
| `url_websites` | `websites.url` | |
54-
| `url_screenshots` | `screenshots` and `artworks` | Using the highest possible 16:9 resolution via `t_1080p_2x` |
55-
| `url_trailers` | `videos` | Only when video title includes the words "trailer", "teaser" or "intro" |
56-
| `url_gameplays` | `videos` | Only when video title includes the words "gameplay" |
36+
| GameVault Field | IGDB API Field(s) or Hardcoded Value (\*) | Notes |
37+
| ---------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
38+
| `provider_slug` | `igdb` \* | Hardcoded. |
39+
| `installer_parameters` | `/D="%INSTALLDIR%" /S /DIR="%INSTALLDIR%" /SILENT` \* | Hardcoded for convenience. Makes Inno Setup and NSIS installers run silently and with a predefined directory. |
40+
| `age_rating` | `age_ratings` | [See here](#age-rating) for details. |
41+
| `provider_data_id` | `id` | |
42+
| `provider_data_url` | `url` | |
43+
| `title` | `name` | |
44+
| `release_date` | `first_release_date` | |
45+
| `description` | `game.summary` and/or `game.storyline` | If both are available, both get used, else any available will be mapped |
46+
| `rating` | `total_rating` | |
47+
| `early_access` | `status` | True if the Game is either in status `alpha`, `beta` or `early_access` |
48+
| `developers` | `involved_companies` | Filtered by `involved_company.developer === true` |
49+
| `publishers` | `involved_companies` | Filtered by `involved_company.publisher === true` |
50+
| `genres` | `genres` | |
51+
| `tags` | `keywords` and `themes` | |
52+
| `cover` | `cover` | Using the highest possible cover resolution via `t_cover_big_2x` |
53+
| `background` | `artworks[0]` or `screenshots[0]` | Only first artwork/screenshot is mapped. Using the highest possible 16:9 resolution via `t_1080p_2x` |
54+
| `url_websites` | `websites.url` | |
55+
| `url_screenshots` | `screenshots` and `artworks` | Using the highest possible 16:9 resolution via `t_1080p_2x` |
56+
| `url_trailers` | `videos` | Only when video title includes the words "trailer", "teaser" or "intro" |
57+
| `url_gameplays` | `videos` | Only when video title includes the words "gameplay" |
5758

5859
### Age Rating
5960

‎docs/server-docs/setup/native.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@ Although we strongly discourage it, if none of the alternative installation meth
1111

1212
- [Node.js](https://nodejs.org/) must be installed on your system (check the required version [here](https://github.com/Phalcode/gamevault-backend/blob/master/Dockerfile#L1)).
1313
- [PostgreSQL](https://www.postgresql.org/) database (or configure SQLITE later on).
14-
- Install necessary packages: [`p7zip-full`](https://packages.debian.org/en/sid/p7zip-full) and [`p7zip-rar`](https://packages.debian.org/en/sid/p7zip-rar) (non-free-repository) (or their equivalents in your distribution).
1514
- Install the [parallel node package manager](https://pnpm.io/): `npm i -g pnpm`.
15+
- Install the necessary packages according to your operating system:
16+
- On **Debian** and derivatives (e.g. Ubuntu, Linux Mint), install [`p7zip-full`](https://packages.debian.org/en/sid/p7zip-full) and [`p7zip-rar`](https://packages.debian.org/en/sid/p7zip-rar) (from the non-free repository).
17+
- On **Arch Linux** and derivatives (e.g. Manjaro), install `p7zip`.
18+
- On **Fedora**, **RHEL**, and **CentOS**, install `p7zip` and `p7zip-plugins`.
19+
- On **openSUSE**, install `p7zip-full`.
20+
- On **macOS**, install `p7zip` via [Homebrew](https://brew.sh/).
21+
- On **Windows**, install [7-Zip](https://www.7-zip.org/) and make sure the `7z` binary is added to your system’s `PATH` environment variable.
1622

1723
### Step 1: Clone the Source Code
1824

0 commit comments

Comments
 (0)