# Overworld

## Table of contents

<!-- TOC -->
* [Configuration](#configuration)
  * [Frontend](#frontend)
  * [Backend](#backend)
<!-- TOC -->

## Configuration

Currently, the following things can be configured.

### Frontend

In the [frontend](https://github.com/Gamify-IT/overworld) the following properties can be configured:

| Variable | Description | Default value |
|----------|-------------|---------------|
| `overworldBackendPath` | URL of the overworld backend service | `/overworld/api/v1` |
| `maxWorld` | The number of worlds existing | `4` |
| `maxMinigames` | The number of minigames of each area | `12` |
| `maxNPCs` | The number of NPCs of each area | `10` |
| `maxBooks` | The number of books of each area | `5` |
| `maxDungeons` | The number of dungeons of each world | `4` |

You can change these settings in the [frontend](https://github.com/Gamify-IT/overworld) in the `GameSettings` script located at `Assets/Scripts/GameManager`.

### Backend

The [backend](https://github.com/Gamify-IT/overworld-backend) can be configured via environment variables.
Alternatively you can edit the file `src/main/resources/application.properties`.

| Spring Property               | Environment variable          | Description                                                      | Default value                                      |
|-------------------------------|-------------------------------|------------------------------------------------------------------|----------------------------------------------------|
| `spring.sql.init.platform`    | `SPRING_SQL_INIT_PLATFORM`    | The kind of database you are using                               | `postgres`                                         |
| `spring.datasource.url`       | `SPRING_DATASOURCE_URL`       | The URL to the database                                          | `jdbc:postgresql://localhost:5432/postgres`        |
| `spring.datasource.username`  | `SPRING_DATASOURCE_USERNAME`  | The username to connect to the database                          | `postgres`                                         |
| `spring.datasource.password`  | `SPRING_DATASOURCE_PASSWORD`  | The password to connect to the database                          | `postgres`                                         |
| `server.servlet.context-path` | `SERVER_SERVLET_CONTEXT_PATH` | Base path for the API                                            | `/api/v1`                                          |
| `chickenshock.url`            | `CHICKENSHOCK_URL`            | URL of the chickenshock backend service                          | `http://localhost/minigames/chickenshock/api/v1`   |
| `finitequiz.url`              | `FINITEQUIZ_URL`              | URL of the finitequiz backend service                            | `http://localhost/minigames/finitequiz/api/v1`     |
| `crosswordpuzzle.url`         | `CROSSWORDPUZZLE_URL`         | URL of the crosswordpuzzle backend service                       | `http://localhost/minigames/crosswordpuzzle/api/v1`|
| `bugfinder.url`               | `BUGFINDER_URL`               | URL of the bugfinder backend service                             | `http://localhost/minigames/bugfinder/api/v1`      |
| `keycloak.issuer`             | `KEYCLOAK_ISSUER`             | Name of the issuer used in the authentication tokens             | `http://localhost/keycloak/realms/Gamify-IT`       |
| `keycloak.url`                | `KEYCLOAK_URL`                | URL to connect to keycloak in order to fetch the validation keys | `http://localhost/keycloak/realms/Gamify-IT`       |
| `springdoc.swagger-ui.path`   | `SPRINGDOC_SWAGGER_UI_PATH`   | Path to serve the API documentation                              | `/swagger-ui`                                      |

A complete list of options can be seen in the [backend](https://github.com/Gamify-IT/overworld-backend) in `src/main/resources/application.properties`.