> 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-shellcreator/configuration.md).

# Configuration

Every setting in config.lua and config/server.lua.

Shells, templates and teleporters are made in game. These files only hold the general rules.

#### General

| Setting            | Default              | What it does                                                                                  |
| ------------------ | -------------------- | --------------------------------------------------------------------------------------------- |
| `Locale`           | `'en'`               | Language file from the `locales` folder                                                       |
| `Debug`            | `false`              | Prints every shell decision to the console                                                    |
| `Commands.Creator` | `'shellcreator'`     | Opens the manager (admins)                                                                    |
| `Commands.Leave`   | `'leaveshell'`       | Takes a stuck player out of a shell                                                           |
| `AdminAce`         | `'solidshell.admin'` | Ace that counts as admin, next to the staff groups in solid-bridge                            |
| `Interaction`      | `'auto'`             | Teleporters: `auto` (target script when one runs, otherwise a key prompt), `target` or `text` |
| `InteractKey`      | `38`                 | Key for the prompt, 38 = E                                                                    |
| `AllowAnyProp`     | `false`              | `true` = admins can place any GTA model by name, `false` = only the furniture catalog         |

#### Shell zone and buckets

| Setting                         | Default                   | What it does                                                         |
| ------------------------------- | ------------------------- | -------------------------------------------------------------------- |
| `ShellZone`                     | `x -6200, y -6200, z 700` | Where shells are built and spawned, far out at sea and high up       |
| `ShellZone.spacing` / `columns` | `120.0` / `24`            | Metres between two shells, shells per row                            |
| `Buckets.Edit`                  | `74000`                   | First routing bucket while admins build, one per shell               |
| `Buckets.Instance` / `Count`    | `75000` / `4000`          | First routing bucket for shell instances, how many can exist at once |

#### Limits

| Setting                             | Default              | What it does                                       |
| ----------------------------------- | -------------------- | -------------------------------------------------- |
| `Limits.Size`                       | `40`                 | Furthest a shell reaches from its centre in metres |
| `Limits.Levels`                     | `4`                  | Most floors                                        |
| `Limits.Walls` / `Rects` / `Stairs` | `800` / `300` / `24` | Walls, floor and ceiling areas, stairs per shell   |
| `Limits.Props` / `Lights`           | `600` / `48`         | Furniture and lights per shell                     |

#### Editor

| Setting                              | Default       | What it does                                        |
| ------------------------------------ | ------------- | --------------------------------------------------- |
| `Editor.CameraSpeed` / `CameraBoost` | `8.0` / `3.0` | Camera metres per second, multiplier with Shift     |
| `Editor.TopHeight`                   | `24.0`        | Start height of the top view                        |
| `Editor.HistoryLimit`                | `100`         | Undo steps per admin                                |
| `Editor.AutosaveSeconds`             | `45`          | Drafts save this often while someone builds         |
| `Editor.GridRadius`                  | `24`          | Grid drawn around the cursor in metres              |
| `Editor.ShowOthers`                  | `true`        | Shows the cursors of other admins on the same shell |

#### Inside a shell

| Setting                               | Default                             | What it does                                                            |
| ------------------------------------- | ----------------------------------- | ----------------------------------------------------------------------- |
| `Runtime.SpawnPerFrame`               | `40`                                | Pieces created per frame when a shell loads                             |
| `Runtime.LightDistance` / `MaxLights` | `35.0` / `24`                       | Lights closer than this are drawn, most at once                         |
| `Runtime.DoorDistance`                | `1.8`                               | How close a player must be to open a door                               |
| `Runtime.Fade`                        | `600`                               | Screen fade in milliseconds                                             |
| `Inside.Weather` / `Hour`             | `'CLEAR'` / `23`                    | Weather and hour inside when the shell has none of its own              |
| `Inside.WeatherSyncEvents`            | qb-weathersync, cd\_easytime, vSync | Events that pause and resume your weather sync while a player is inside |

#### Teleporters

| Setting                    | Default              | What it does                             |
| -------------------------- | -------------------- | ---------------------------------------- |
| `Teleporters.DrawDistance` | `12.0`               | Markers show from this distance          |
| `Teleporters.UseDistance`  | `1.6`                | How close a player must be to use a door |
| `Teleporters.Marker`       | type 1, violet       | Default ground marker                    |
| `Teleporters.Blip`         | sprite 40, colour 27 | Default blip when a door shows one       |

#### config/server.lua

| Setting                  | Default    | What it does                                                                                              |
| ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------- |
| `Webhook`                | `''`       | Discord webhook for shell logs, empty = console only                                                      |
| `WebhookActions`         | all `true` | Which actions are logged: create, delete, publish, restore, import, teleporter, bake, template, community |
| `KeepVersions`           | `25`       | Saved versions kept per shell                                                                             |
| `AutosaveVersionMinutes` | `10`       | An autosave is also kept as a version this often                                                          |
| `RateLimit`              | `120`      | Milliseconds between two editor requests of the same kind from one admin                                  |