> For the complete documentation index, see [llms.txt](https://grp-development.gitbook.io/solid-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://grp-development.gitbook.io/solid-scripts/resources/solid-spawn/configuration.md).

# Configuration

Every setting in config.lua, and the language file.

#### General

| Setting         | Default | What it does                            |
| --------------- | ------- | --------------------------------------- |
| `Config.Debug`  | `false` | Extra logs in F8 and the server console |
| `Config.Locale` | `'en'`  | Language file from the `locales` folder |

#### Spawn groups

The menu lists them in this order.

| Setting                    | Default           | What it does                                                                          |
| -------------------------- | ----------------- | ------------------------------------------------------------------------------------- |
| `Config.LastLocation`      | `true`            | Players can continue from where they logged out                                       |
| `Config.OwnedProperties`   | `true`            | Lists owned `qb-houses` houses and `qb-apartments` apartments, players wake up inside |
| `Config.JobSpawns`         | police, ambulance | Extra spawns for players with that job, see below                                     |
| `Config.PublicSpawns`      | `true`            | Lists the public spawns in `Config.Spawns`                                            |
| `Config.StarterApartments` | `true`            | New characters pick a free starter apartment when `qb-apartments` hands them out      |
| `Config.Fallback`          | Legion Square     | Where players appear when there is nothing to choose from                             |

{% hint style="info" %}
New characters never see Last location. When starter apartments are on offer, they only see those.
{% endhint %}

#### Public spawns

`Config.Spawns` is the list everyone can pick: Legion Square, Paleto Bay and Motels by default. `label` is the menu text, `coords` is where the player appears.

{% code title="config.lua" %}

```lua
Config.Spawns = {
    { label = 'Legion Square', coords = vector4(195.17, -933.77, 29.7, 144.5) },
    { label = 'Paleto Bay', coords = vector4(80.35, 6424.12, 31.67, 45.5) },
    { label = 'Motels', coords = vector4(327.56, -205.08, 53.08, 163.5) },
}
```

{% endcode %}

#### Job spawns

`Config.JobSpawns` uses the job name as the key. Add any job you like, or empty it to turn job spawns off.

| Job         | Spawns                                                   |
| ----------- | -------------------------------------------------------- |
| `police`    | Mission Row PD, Sandy Shores Sheriff, Paleto Bay Sheriff |
| `ambulance` | Pillbox Medical, Sandy Shores Medical                    |

{% code title="config.lua" %}

```lua
Config.JobSpawns = {
    ambulance = {
        { label = 'Pillbox Medical', coords = vector4(294.58, -574.76, 43.18, 35.79) },
        { label = 'Sandy Shores Medical', coords = vector4(1826.23, 3662.79, 33.93, 213.24) },
    },
}
```

{% endcode %}

#### Camera

| Setting                    | Default                                                                                    | What it does                                             |
| -------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| `Config.Camera.Fov`        | `52.0`                                                                                     | Camera zoom while browsing                               |
| `Config.Camera.Transition` | `1200`                                                                                     | Milliseconds the camera takes to fly between two spawns  |
| `Config.Camera.Landing`    | `1600`                                                                                     | Milliseconds of the final swoop down to the chosen spawn |
| `Config.Camera.Orbit`      | `Radius = 68.0`, `Height = 34.0`, `FocusHeight = 1.4`, `Speed = 5.5`, `StartAngle = 135.0` | The slow circle around the selected spawn                |
| `Config.Camera.Reveal`     | `Radius = 18.0`, `Height = 7.0`, `FocusHeight = 1.2`, `AngleOffset = 24.0`, `Fov = 58.0`   | The close shot right before the player appears           |

#### Map

| Setting            | Default           | What it does                                       |
| ------------------ | ----------------- | -------------------------------------------------- |
| `Config.Map.Style` | `'styleSatelite'` | `'styleSatelite'`, `'styleAtlas'` or `'styleGrid'` |

#### Beacon

| Setting                 | Default             | What it does                                                   |
| ----------------------- | ------------------- | -------------------------------------------------------------- |
| `Config.Beacon.Enabled` | `true`              | The violet marker over the selected spawn, `false` = no marker |
| `Config.Beacon.Size`    | `9.0`               | Width of the glowing ground ring in metres                     |
| `Config.Beacon.Height`  | `10.0`              | Height of the light beam in metres                             |
| `Config.Beacon.Color`   | `{ 174, 106, 251 }` | Red, green, blue                                               |

#### Language

Every text is in `locales/en.json`. To translate, copy it to a new file such as `locales/de.json`, translate the texts and set `Config.Locale = 'de'`. Anything you leave out stays in English.
