> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awokenlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> How the tablet opens, what it looks like, groups, the HUD and scaling.

One file, `config/config.lua`. It ships readable, so it is yours to edit. Restart the resource after changing it.

Which framework you run is not set here. [Awoken Bridge](/resources/awoken-bridge/configuration) answers that for every Awoken script at once.

## General

```lua config/config.lua theme={"dark"}
Config.Locale = 'en'
Config.Debug  = false
Config.updateNotifications = true   -- the startup banner and update check
Config.TabletItem = 'awoken_tablet' -- the ox_inventory item that opens the tablet
```

## How it opens

```lua config/config.lua theme={"dark"}
Config.Open = {
    fromItem = true,

    keybind = {
        enabled       = true,
        default       = '',
        requiresItem  = true,
    },

    command = {
        enabled      = false,
        name         = 'tablet',
        requiresItem = true,
    },
}
```

* **Item.** Using the tablet item is the main way in and is always on.
* **Keybind.** Players set their own key under **Settings**, **Key Bindings**, **FiveM**. `default` ships one for everybody. Empty means nobody has a key until they pick one.
* **Command.** `/tablet`, off by default. Handy for staff and while setting up.

`requiresItem = true` means the key or command only works while the player is carrying a tablet.

## When it cannot be opened

```lua config/config.lua theme={"dark"}
Config.DisableWhile = {
    dead       = true,
    ragdoll    = true,
    handcuffed = true,
    driving    = false,
    swimming   = true,
}
```

Checked on every open attempt.

## Theme and wallpapers

```lua config/config.lua theme={"dark"}
Config.Theme = {
    primaryColor      = '#00E5FF',
    allowPlayerAccent = true,
}
```

`primaryColor` is the accent inside the tablet: buttons, highlights and the default app tile. You can also override it without editing the file:

```cfg server.cfg theme={"dark"}
setr awoken:primaryColor "#FF6A00"
```

With `allowPlayerAccent = true` each player can pick their own accent in the tablet's **Settings** app. Set it to `false` to lock everyone to your colour. Saved choices stay in the database and come back if you turn it on again.

```lua config/config.lua theme={"dark"}
Config.Wallpapers = {
    allowCustomURL = true,
    presets = {
        { id = 'midnight',    name = 'Midnight'    },
        { id = 'awoken-cyan', name = 'Awoken Cyan' },
        -- ...
    },
}
```

The built-in wallpapers are drawn by the tablet itself, so there are no image files to manage. Remove a line to stop offering that wallpaper, or rename one. `allowCustomURL` lets a player paste a link to their own image.

<Note>
  You cannot add a new built-in wallpaper from the config. The `id` has to match one the tablet already knows how to draw.
</Note>

## Notifications

```lua config/config.lua theme={"dark"}
Config.Notifications = {
    maxPerPlayer = 100,
    position     = 'top',
    duration     = 4000,
}
```

Every notification an app sends is kept in the player's inbox, up to `maxPerPlayer`, with the oldest dropped first. `position` and `duration` are for the pop-up shown while the tablet is closed.

## Groups

```lua config/config.lua theme={"dark"}
Config.Groups = {
    maxSize           = 8,
    inviteRangeMeters = 25,
    inviteTTLSeconds  = 30,
}
```

Groups are how players team up for anything an app runs as a crew. They live in memory only:

* A server restart clears every group.
* The leader choosing **Leave** disbands the group.
* The leader crashing or dropping promotes the longest-standing member instead.
* The last member leaving disbands it.

`maxSize` includes the leader. Apps can apply a smaller limit of their own on top.

## The HUD

Apps can pin a small card to the side of the screen that stays up while the tablet is closed, for things like a live delivery route.

```lua config/config.lua theme={"dark"}
Config.Hud = {
    toggleKey = 'F7',
}
```

`toggleKey` is the default key that shows or hides it. Players can rebind it in their FiveM key bindings, and choose which side of the screen it sits on in the tablet's **Settings** app. Empty means unbound.

The HUD uses the player's own accent colour, so every app's card matches their tablet.

## Scaling

```lua config/config.lua theme={"dark"}
Config.Scaling = {
    minScale = 0.6,
    maxScale = 2.0,
}
```

The tablet scales itself so it feels the same size at any resolution. These are the limits on that. Most servers never need to touch them.

## SD cards

`Config.SdCards` has a page of its own. See [SD cards](/resources/awoken-tablet/sd-cards).

## Language

Text lives in `config/locales/en.lua`. To translate, copy it to a new file such as `fr.lua`, change `Locales.en` at the top to `Locales.fr`, translate the values, add the file to `shared_scripts` in `fxmanifest.lua` next to `en.lua`, and set `Config.Locale = 'fr'`.

Apps follow the same locale automatically.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.